pt-BR|en

  • 01

    Primeiros passos

  • 02

    Introdução

  • 03

    Seguro viagem

    • Contratar

    • Consultar

  • 04

    Seguro Proteção de Compra

    • Contratar

    • Consultar

  • 05

    Seguro Garantia Estendida

    • Contratar

    • Consultar

  • 06

    Solicitar 2ª Via

  • 07

    Referências

    • Queries

    • Mutations

    • Tipos de Entrada

    • Tipos

    • Enumerações

Seguros

A API de Seguros possibilita a utilização dos benefícios de Seguro Viagem, Seguro Garantia Estendida e Seguro Proteção de Compra por portadores de cartão Elo.

Feito para:  Estabelecimentos ComerciaisAdquirentes

Como funciona

Primeiros passos

  1. Leia Introdução ao GraphQL, com exemplos reais da nossa API.

  2. Crie um usuário no portal do desenvolvedor.

  3. Cadastre sua primeira aplicação.

  4. Utilize o dashboard para acessar suas configurações de acesso.

  5. Para explorar rapidamente as APIs aqui na página de documentação, use o console de GraphQL, na seção de referências. Nele, você pode ver as consultas de exemplo, executá-las e alterá-las.

Primeiros passos na plataforma de Desenvolvedores Elo

Jaydson GomesDesenvolvedor Evangelista

Introdução

O intuito dessa API é oferecer ao portador a melhor experiência no momento da utilização de seus benefícios em Seguros através de parceiros, aplicativos e outros sistemas integrados com as APIs da Elo.

Para saber mais sobre as condições de utilização dos benefícios de seguro consulte o portal Cartão Elo.

Além da contratação e consulta dos seguros descritos nas seções a seguir, ela permite ao portador solicitar a 2ª via dos seguros vigentes.

Na criação de um seguro para um portador de cartão, é necessário que o portador seja do tipo CardHolder e tenha direito ao benefício. Para obter mais informações sobre benefícios e serviços de um cartão acesse a Tabela de BINs.

Seguro viagem

Ao comprar uma passagem aérea, marítima ou terrestre com o cartão Elo, o portador tem o benefício de emitir o bilhete de seguro para garantir a cobertura sobre cancelamento da viagem, atraso e perda de bagagem, despesas médicas, hospitalares e odontológicas, entre outras durante o período de 12 meses.

Contratar

A criação de um seguro viagem como benefício de um cartão é baseado no número de viajantes enviados na mutation createTravelInsurance. Para cada passageiro serão criados dois bilhetes de seguro que serão enviados para o e-mail do portador do cartão (CardHolder).

Nota: Para obter bilhetes de seguro para mais de 1 viajante, o portador do cartão precisa necessariamente ser enviado como um dos passageiros na mutation createTravelInsurance.

mutation{
    createTravelInsurance(input:{
        clientMutationId: "123",
        bin: "655000",
        merchant: {
            legalId: "03466677000108",
            name: "Company Travel Insurance",
            legalName: "Company Travel Insurance S/A"
        },
        journey: {
            companyTravel: "TAM",
            journeyLocator: "YTG123",
            trips: [
                {
                    tripNumber: 123,
                    tripLocator: "YTG321",
                    type: AIR,
                    departure: {
                        IataCode: "GRU",
                        IcaoCode: "SBKP",
                        city: "Campinas",
                        country: "BRA",
                        dateTime: "2019-01-01T13:12:59Z"
                    },
                    arrival: {
                        IataCode: "LGA",
                        IcaoCode: "KLGA",
                        city: "New York",
                        country: "USA",
                        dateTime: "2019-01-31T14:13:49Z"
                    },
                    travelers: [
                        {
                            legalIds: {
                                cpf: "83567050290",
                                rg: {
                                    number: "346727019",
                                    issuerOrganization: "SSP",
                                    issuerState: "SP",
                                    issueDate: "1998-08-01"
                                }
                            },
                            name: "Insurance 1",
                            birthday: "1990-01-01",
                            gender: MALE,
                            maritalStatus: MARRIED,
                            occupationId: "2525-40",
                            income: {
                                personal: 5000,
                                family: 10000,
                                currency: "BRL"
                            },
                            address: {
                                context: "Trabalho",
                                country: "BRA",
                                city: "Campinas",
                                state: "São Paulo",
                                zip: "13086902",
                                kind: "Rua",
                                number: 0,
                                place: "Dr. Ricardo Benetton Martins",
                                complement: "Prédio 3",
                                reference: "Parque II do Polo de Alta Tecnologia",
                                instructions: "Rodovia Campinas/Mogi",
                                district: "Jardim Miriam",
                                lon: -22.816214,
                                lat: -47.045596
                            },
                            contacts: [
                                {
                                    type: EMAIL,
                                    context: "Correio Eletrônico",
                                    value: "comunicacao@sensedia.com"
                                },
                                {
                                    type: PHONE,
                                    context: "Contato",
                                    value: "01937055775"
                                }
                            ],
                            politicalExposure: true
                        }
                    ]
                }
            ]
            purpose: {
                leisure: false,
                business: true,
                adventure: false
            }
        }
    }){
        clientMutationId,
        travelInsurance{
            id, 
            startDate, 
            endDate
        }
    }
}

Consultar

Após a criação, é possível consultar os seguros emitidos por status, data e local de de origem e destino.

query{
    user(id: "825b09b8-e422-4743-8952-2046b173ecce") {
        cardHolders{
            travelInsurances {
                totalCount,
                pageInfo{
                    hasPreviousPage
                    hasNextPage
                    startCursor
                    endCursor
                },
                edges{
                    node{
                        id,
                        cardHolder{
                            id,
                            name
                        }
                        merchant {
                            legalId,
                            legalName,
                            name
                        },
                        companyInsurance, 
                        bin{
                            number,
                            product {
                                name
                            }
                        },
                        journey{
                            companyTravel,
                            journeyLocator,
                            trips{
                                tripNumber,
                                tripLocator,
                                type,
                                departure{
                                    IataCode,
                                    IcaoCode,
                                    city,
                                    country,
                                    dateTime
                                },
                                arrival{
                                    IataCode,
                                    IcaoCode,
                                    city,
                                    country,
                                    dateTime
                                },
                                travelers{
                                    insurances {
                                        insuranceId,
                                        description,
                                        status
                                    }
                                    legalIds {
                                        cpf { number },
                                        rg {
                                            number, 
                                            issuerOrganization,
                                            issuerState,
                                            issueDate
                                        }
                                    },
                                    name,
                                    birthday,
                                    gender,
                                    income{
                                        personal,
                                        family,
                                        currency
                                    },
                                    occupation{
                                        id, 
                                        display
                                    },
                                    address{
                                        context,
                                        country,
                                        city,
                                        state,
                                        zip,
                                        district,
                                        kind,
                                        number,
                                        place,
                                        complement,
                                        reference,
                                        instructions,
                                        lon,
                                        lat
                                    }
                                }
                            }
                        }
                        startDate, 
                        endDate
                    }
                }
            }
        }
    }
}

Seguro Proteção de Compra

O seguro proteção de compra contempla equipamentos eletroportáteis adquiridos no Brasil com o cartão Elo que podem ser segurados após a emissão de um bilhete junto a Elo. Esse seguro oferece cobertura contra roubo, furto qualificado ou danos decorrentes de acidente. O Seguro Proteção de Compra dará o suporte necessário quando o portador precisar, durante a vigência indicada no bilhete (45 dias), reembolsando o valor do bem ou o encaminhando para o conserto ou assistência especializada.

Contratar

Para a criação de um Seguro Proteção de Compra é preciso ter conhecimento das categorias de produtos que fazem parte da cobertura do seguro. Para isso, é possível utilizar a consulta insuranceProductCategory como mostra o exemplo abaixo:

query{
    insuranceProductCategory{
        id,
        display,
        products {
            id,
            display
        }
    }
}

Após realizada a consulta, utilize a mutation createPurchaseProtectionInsurance para criar a cobertura do seguro para o produto escolhido (informando-o no campo productId). Para criar um seguro de proteção de compra o portador precisa ser um CardHolder e possuir esse benefício ativo. Após a criação, uma confirmação será enviada para o e-mail do portador do cartão.

mutation{
  createPurchaseProtectionInsurance(
    input:{
      clientMutationId:"123",
      bin:"655000",
      merchant:{
        legalId:"25396173000100",
        legalName:"LEGAL NAME 123",
        name:"LEGAL AB"
      },
      invoiceNumber:"32",
      invoiceDate:"2018-08-16" ,
      serialNumber:"11242",
      brand:"SENSEDIA",
      model:"API MANAGER",
      value:35.6,
      description:"Seguro de premium contra defeitos de fabrica",
      coverageDays:16,
            productId: "1a6e1266-d57f-434b-9ccd-7e17fd60671e"
    }
  )
  {
        clientMutationId,
        PurchaseProtectionInsurance{
            id,
            insuranceId,
            cardHolder{
                id,
                name
            },
            merchant{
                legalId, 
                legalName, 
                name
            },
            bin{
                number,
                product{ name }
            }
            status,
            startDate,
            endDate,
            companyInsurance,
            invoiceNumber,
            invoiceDate,
            serialNumber,
            category{
                id, 
                display
            },
            brand,
            model,
            description,
            value,
            coverageDays
        }
    }
}

Consultar

Para consultar um seguro proteção de compra já criado, basta utilizar a consulta abaixo conforme mostra o quadro abaixo, observe que é possível filtrar os seguros contratados dentro de um período (startDate, endDate) e status.

query {
  user(id: "012") {
    cardHolders {
      purchaseProtectionInsurances(
        filter:{
          status: HIRED,
          startDate: "2018-08-17",
          endDate: "2019-12-31"
        }) {
        totalCount,
        pageInfo{
          hasPreviousPage
          hasNextPage
          startCursor
          endCursor
        },
        edges {
          node {
            id, 
            insuranceId,
            cardHolder{
              id,
              name
            },
            merchant{
              legalId,  
              legalName,
              name
            },
            bin{
              number,
              product { name }
            }
            status,
            startDate,
            endDate,
            companyInsurance,
            invoiceNumber,
            invoiceDate,
            serialNumber,
            category{
              id,
              display,
              products { display }
            },
            brand,
            model,
            description,
            value,
            coverageDays
          }
        }
      }
    }
  }
}

Seguro Garantia Estendida

O seguro Garantia Estendida cobre, por até 48 meses, os custos de consertos ou a troca dos produtos adquiridos no Brasil e pagos integralmente com o cartão Elo, que apresentarem defeito após o término da garantia original do fabricante. Para solicitar basta emitir o bilhete do seguro em até 30 dias após a data da compra do produto.

Contratar

Através da mutation createExtendedWarrantyInsurance é possível que parceiros realizem a criação de um Seguro Garantia Estendida para o produto associado. Os campos que definem o produto a ser coberto por esse benefício como modelo, marca, descrição, número de série e valor devem ser informados pela origem e serão avaliados posteriormente caso o portador utilize o benefício do seguro. Essa validação não é feita no momento da criação.

NOTA: Novamente utilize a query insuranceProductCategory (demonstrada na seção anterior ao criar um Seguro Proteção de Compra) para consultar o produto em que você deseja contratar o seguro e informe-o no campo productId.

Para criar um seguro utilize a mutation conforme exemplo abaixo:

mutation{
  createExtendedWarrantyInsurance(input:{
    clientMutationId: "123",
    bin: "655012",
    merchant: {
      legalId: "333333444",
      name: "Merchant",
      legalName: "Merchant S/A"
    },
    invoiceNumber: "2",
    invoiceDate: "2018-12-31",
    serialNumber: "3",
    brand: "brand",
    model: "model",
    description: "description",
    value: 10.6,
    extendedWarrantyMonths: 12,
    manufacturerWarrantyMonths: 12,
    productId: "10376bd0-6dec-4f2a-9937-07f1feee152e"
  })
  {
    clientMutationId
    extendedWarrantyInsurance{
      id,
      insuranceId,
      cardHolder{
        id
        name
        firstName
        lastName
        displayName
        companyName
        companyLegalName
        legalIds{
          cpf{ number }
        }
        birthday
      }
      bin{
        number
        panSizeRange{
          min
          max
        }
        funding
        product{
          id
          code
          name
        }
        country
      }
      status
      merchant{
        legalId
        name
        legalName
      }
      startDate
      endDate
      companyInsurance
      invoiceNumber
      category{
        id
        display
      }
      brand
      model
      description
      value
      extendedWarrantyMonths
      manufacturerWarrantyMonths
    }
  }
}

Consultar

Após ter criado o seguro de garantia estendia é possível consulta-lo atravez da query extendedWarrantyInsurances dentro das buscas user -> cardHolders:

query {
  user(id: "012") {
    cardHolders {
            extendedWarrantyInsurances {
                edges {
                    node {
                        id
                        insuranceId
                        bin { number }
                        status 
                        merchant {
                            name
                        }
                        startDate
                        endDate
                        companyInsurance 
                        invoiceNumber 
                        invoiceDate
                        serialNumber
                        category {
                            id
                            display
                        }
                        brand 
                        model
                        description
                        value
                        extendedWarrantyMonths
                        manufacturerWarrantyMonths                        
                    }
                }
            }
        }
    }
}

Solicitar 2ª Via

É possível também solicitar a 2ª via dos seguros já criados para um portador. Para isto é necessário o campo insuranceId do seguro retornado no momento de sua criação ou nas buscas demonstradas acima para cada tipo de seguro.

Abaixo temos um exemplo da mutation requestSecondWayOfInsurancePolicy:

mutation {
    requestSecondWayOfInsurancePolicy(input: {
        insuranceId: "18001000169180000398",
        type: TRAVEL
    })
  {
        maskedEmail
    }
}

Após a solicitação o portador do cartão que contratou o seguro recerá a 2ª via em seu e-mail cadastrado (o mesmo informado no retorno da mutation como maskedEmail).

Referências


Queries



insuranceProductCategory

Consulta todas as categorias de produtos.

O outro campo retornado na lista é o texto a ser exibido (display) para o usuário na seleção da categoria.

Esta lista é raramente modificada e pode (deve) ser armazenada do lado do integrador por até um dia.

Argumentos:

productCategoryId: ID

Identificador opaco da categoria de produto

displayContains: String

Se null ou vazio, não realiza filtragem. Caso contrário, define texto que deve estar contido display da categoria de produto.



user

Query (consulta) de usuário por vários meios de entrada.

Esta consulta deve ser feita com apenas um parâmetro não-null para designar o método de procura. Utilizar mais de um pode resultar em resultados distintos em cada chamada.

Argumentos:

id: String

Procura o usuário pelo identificador global único

username: String

Procura o usuário pelo seu username

legalId: LegalIdsInput

Procura o usuário pelo seu documento

socialNetwork: SocialNetworkInput

Procura o usuário pelo seu username na rede social especificada.

cardHolderId: String

Procura pelo usuário associado ao portador de cartões com o identificador global único especificado.

merchantId: String

Procura pelo usuário associado ao comerciante com o identificador global único especificado.

Caso o comerciante tenha mais de um usuário responsável, retorna o mais antigo.




Mutations



requestSecondWayOfInsurancePolicy

Inicia o processo de solicitar a segunda via do seguro.

Argumentos:



createExtendedWarrantyInsurance

Cria (emite) um Seguro de Garantia Estendida.

Antes de criar um seguro de extensão de garantia original, o usuário da API deverá requisitar permissão para emitir seguros de garantia estendida ao portador utilizando o processo de OAuth. O processo de OAuth e renovação de tokens de acesso poderão pedir ao usuário que entre novamente com a senha e confirme os dados do perfil antes de retornar o novo accessToken.

Uma vez apresentados os detalhes do seguro, prossiga então para coleta dos dados dos produtos (formulários) e então realize uma chamada a createExtendedWarrantyInsurance() para cada produto.

Comerciantes que venderam produtos deverão informar automaticamente os campos invoiceNumber, invoiceDate, serialNumber, brand, model, description e value, não sendo necessário que o usuário final digite esta informação novamente.

Seguros podem ser cancelados com cancelCardHolderInsurance() passando-se o identificador global único retornado em CreateExtendedWarrantyInsurancePayload { extendedWarrantyInsurance { id } }

NOTA: Lembre-se que em GraphQL pode-se enviar várias mutações de uma única vez, logo não é necessário executar várias requisições HTTP ao servidor, faça apenas uma e diferencie cada pedido com clientMutationId.

Argumentos:



createPurchaseProtectionInsurance

Cria (emite) um Seguro de Proteção de Compra de Produtos.

Antes de criar um seguro de proteção de compra de produtos, o usuário da API deverá requisitar permissão para emitir seguros de proteção de compra ao portador utilizando o processo de OAuth. O processo de OAuth e renovação de tokens de acesso poderão pedir ao usuário que entre novamente com a senha e confirme os dados do perfil antes de retornar o novo accessToken.

Uma vez apresentados os detalhes do seguro, prossiga então para coleta dos dados dos produtos (formulários) e então realize uma chamada a createPurchaseProtectionInsurance() para cada produto.

Comerciantes que venderam produtos deverão informar automaticamente os campos invoiceNumber, invoiceDate, serialNumber, brand, model, description e value, não sendo necessário que o usuário final digite esta informação novamente.

Seguros podem ser cancelados com cancelCardHolderInsurance() passando-se o identificador global único retornado em CreatePurchaseProtectionInsurancePayload { PurchaseProtectionInsurance { id } }

NOTA: Lembre-se que em GraphQL pode-se enviar várias mutações de uma única vez, logo não é necessário executar várias requisições HTTP ao servidor, faça apenas uma e diferencie cada pedido com clientMutationId.

Argumentos:



createTravelInsurance

Cria (emite) um Seguro Viagem.

Antes de criar um seguro viagem, o usuário da API deverá requisitar permissão para emitir seguros viagem ao portador utilizando o processo de OAuth. O processo de OAuth e renovação de tokens de acesso poderão pedir ao usuário que entre novamente com a senha e confirme os dados do perfil antes de retornar o novo accessToken.

Uma vez apresentados os detalhes do seguro, prossiga então para coleta dos dados dos viajantes (formulários) e então realize uma chamada a createTravelInsurance() para cada viajante.

A emissão de seguro ao portador e sem listagem de beneficiários explícitos deverá ser tratada pela interface de forma "rápida", apenas o propósito da viagem deve ser perguntado ao usuário.

Comerciantes que emitiram as passagens deverão informar automaticamente os campos startDatee endDate, não sendo necessário que o usuário final digite esta informação novamente. Caso o seguro permita outros viajantes (allowsOtherTravelers), os dados destes também deverão ser automaticamente populados caso sejam conhecidos.

Seguros podem ser cancelados com cancelCardHolderInsurance() passando-se o identificador global único retornado em CreateTravelInsurancePayload { travelInsurance { id } }

NOTA: Lembre-se que em GraphQL pode-se enviar várias mutações de uma única vez, logo não é necessário executar várias requisições HTTP ao servidor, faça apenas uma e diferencie cada pedido com clientMutationId.

Argumentos:

input: CreateTravelInsuranceInput obrigatório




Tipos de Entrada



RGInput

Entrada para RG

Campos:

number

:

String obrigatório

número do RG (dígitos) sem hífen ou pontos.


issuerOrganization

:

String

organização emissora do documento (exemplo: SSP)


issuerState

:

String

estado de emissão do documento (exemplo: SP)


issueDate

:

Date

data de emissão do documento



LegalIdsInput

Entrada para LegalIds

Campos:

cpf

:

String

Número CPF sem hífen ou pontos


cnpj

:

String

Número CNPJ sem hífen ou pontos


rg

:

RGInput

documento de Registro Geral (RG)



SocialNetworkInput

Entrada com dados básicos para redes sociais.

Campos:

provider

:

String obrigatório

Nome do provedor da rede social, ex: Facebook, Twitter...


username

:

String obrigatório

Nome do usuário na rede social



RequestSecondWayOfInsurancePolicyInput

Entrada para mutação requestSecondWayOfInsurancePolicy().

Compatível com Relay.

Campos:

clientMutationId

:

String

Identificador de cliente opaco, normalmente em formato UUIDv4.

Deve ser usado por clientes para rastrear mutações e respostas, podendo ser usado pelo servidor para perder requisições duplicadas devido a falhas de rede e retransmissões.

Compatível com Relay.


insuranceId

:

ID obrigatório

Identificador Global Único do Seguro viagem a ser cancelado.


type

:

InsuranceType obrigatório

Identifica o Tipo do seguro.



MerchantInsuranceInput

Campos:

legalId

:

String obrigatório

Documento Legal (CNPJ ou CPF) que identifica o comerciante.

Apenas dígitos, sem hífen ou pontos.


name

:

String obrigatório

Nome Fantasia do Comerciante


legalName

:

String obrigatório

Razão Social do Comerciante



CreateExtendedWarrantyInsuranceInput

Entrada para mutação createExtendedWarrantyInsurance().

Compatível com Relay.

Campos:

clientMutationId

:

String

Identificador de cliente opaco, normalmente em formato UUIDv4.

Deve ser usado por clientes para rastrear mutações e respostas, podendo ser usado pelo servidor para perder requisições duplicadas devido a falhas de rede e retransmissões.

Compatível com Relay.


bin

:

String obrigatório

BIN (Bank Identification Number) do cartão.

O BIN é um prefixo de tamanho variável (em geral entre 6 e 9 dígitos) do cartão que oferece o seguro. Para detalhes sobre BINs, confira binTable(), a qual lista a faixa de tamanhos de BIN, bem como os serviços (benefícios) oferecidos ao portador.


merchant

:

MerchantInsuranceInput

Informações do comerciante.


invoiceNumber

:

String

Número da Nota Fiscal


invoiceDate

:

Date

Data da Nota Fiscal


serialNumber

:

String

Número de Série do Produto


brand

:

String

Marca do Produto


model

:

String

Modelo do Produto


description

:

String

Descrição do Produto


value

:

Float obrigatório

Valor do Produto


extendedWarrantyMonths

:

Int

Número de meses a estender a garantia original do fabricante.


manufacturerWarrantyMonths

:

Int

Número de meses cobertos pela garantia do fabricante.


productId

:

ID

Identificador Global Único do ProductCategory.



CreatePurchaseProtectionInsuranceInput

Entrada para mutação createPurchaseProtectionInsurance().

Compatível com Relay.

Campos:

clientMutationId

:

String

Identificador de cliente opaco, normalmente em formato UUIDv4.

Deve ser usado por clientes para rastrear mutações e respostas, podendo ser usado pelo servidor para perder requisições duplicadas devido a falhas de rede e retransmissões.

Compatível com Relay.


bin

:

String obrigatório

BIN (Bank Identification Number) do cartão.

O BIN é um prefixo de tamanho variável (em geral entre 6 e 9 dígitos) do cartão que oferece o seguro. Para detalhes sobre BINs, confira binTable(), a qual lista a faixa de tamanhos de BIN, bem como os serviços (benefícios) oferecidos ao portador.


merchant

:

MerchantInsuranceInput

Informações do comerciante.


invoiceNumber

:

String obrigatório

Número da Nota Fiscal


invoiceDate

:

Date obrigatório

Data da Nota Fiscal


serialNumber

:

String

Número de Série do Produto


brand

:

String obrigatório

Marca do Produto


model

:

String obrigatório

Modelo do Produto


description

:

String obrigatório

Descrição do Produto


value

:

Float obrigatório

Valor do Produto


coverageDays

:

Int

Número de dias para proteger o produto comprado.

NOTA: O número de dias pode resultar em custo adicional que será automaticamente adicionado ao valor final pelo sistema. Sempre informe o usuário do custo final total.


productId

:

ID obrigatório

Identificador Global Único do ProductCategory.



JourneyInput

Entrada para os dados da viagem.

Campos:

companyTravel

:

String

Companhia responsável pela viagem.


journeyLocator

:

String

Localizador da passagem.


trips

:

lista obrigatória de TripInput obrigatório

Trechos da vigem (Possíveis escalas).


purpose

:

TravelPurposeInput

Propósito da viagem (lazer, negócios...)



CreateTravelInsuranceInput

Entrada para mutação createTravelInsurance().

Compatível com Relay.

Campos:

clientMutationId

:

String

Identificador de cliente opaco, normalmente em formato UUIDv4.

Deve ser usado por clientes para rastrear mutações e respostas, podendo ser usado pelo servidor para perder requisições duplicadas devido a falhas de rede e retransmissões.

Compatível com Relay.


bin

:

String obrigatório

BIN (Bank Identification Number) do cartão.

O BIN é um prefixo de tamanho variável (em geral entre 6 e 9 dígitos) do cartão que oferece o seguro. Para detalhes sobre BINs, confira binTable(), a qual lista a faixa de tamanhos de BIN, bem como os serviços (benefícios) oferecidos ao portador.


merchant

:

MerchantInsuranceInput

Informações do comerciante.


journey

:

JourneyInput obrigatório

Dados da Viagem.




Tipos



ProductCategory

Produto coberto pelo seguro

Campos:

id

:

ID obrigatório

Identificador Global Único para este objeto.


display

:

String obrigatório

Texto a ser exibido ao usuário em formulários e consultas.



InsuranceProductCategory

Categoria de Produto coberto pelo seguro

Campos:

id

:

ID obrigatório

Identificador Global Único para este objeto.


display

:

String obrigatório

Texto a ser exibido ao usuário em formulários e consultas.


products

:

lista obrigatória de ProductCategory obrigatório

Lista de Produtos segurados.



LegalIds

Toda a possível identificação legal de uma pessoa ou empresa

Campos:

cnpj

:

CNPJ

cpf

:

CPF

rg

:

RG


PersonYearlyIncome

Renda anual de uma pessoa física (individual e familiar).

Campos:

personal

:

Float

Renda anual pessoal (individual) da pessoa física.


family

:

Float

Renda anual total da família da pessoa física.


currency

:

String

Moeda associada aos valores informados.

Código da moeda com 3 letras ISO4217 Exemplo: EUR, USD, BRL...



PersonOccupation

Profissão (ocupação) de uma pessoa física.

Campos:

id

:

ID obrigatório

Identificador opaco da Profissão

Deve ser informado como entrada em mutações que precisam de profissão.


display

:

String obrigatório

Texto a ser exibido ao usuário em formulários e consultas.

Este texto é localizado (traduzido) para a linguagem informada na consulta.



ImageUrl

URL de imagem com tamanho e mimeType.

Campos:

url

:

String obrigatório

URL para acessar a imagem


width

:

Int obrigatório

largura em pixels


height

:

Int obrigatório

altura em pixels


mimeType

:

String obrigatório

Tipo do arquivo na convenção (MIME - Multipurpose Internet Mail Extensions), como image/png, image/jpeg



PersonContact

Ítem de contato com pessoa física, como email ou telefone...

Com o intuito de manter a privacidade, o campo value pode ser mascarado.

Campos:

type

:

PersonContactType obrigatório

Tipo designa como interpretar o valor, podendo ser telefone, email, ou aplicativo de mensagens instantâneas.


context

:

String

Contexto do contato, que varia com o tipo:

  • Se o tipo for PHONE ou EMAIL, este poderia ser: vendas, suporte ...

  • Se o tipo for IM, pode ser: skype, whatsapp, facebook messenger...

  • Se for OTHER, pode ser qualquer texto


value

:

String obrigatório

Valor do contato. Exemplos: +12345678 para telefone, `user@server.com` para email, etc.

Este campo pode ser transformado dependendo de regras de acesso e permissões. Um comerciante pode receber valores mascarados com o intuito de manter a privacidade da pessoa física. Um exemplo seria receber apenas os últimos 4 dígitos do telefone, ou apenas as primeiras letras do email seguida do domínio.


verified

:

VerifiedStatus

O processo de verificação é feito por nosso sistema enviando uma mensagem ao contato e então pedindo que a chave enviada seja reenviada ao sistema.

NOTA: apenas os tipos de contatos PHONE e EMAIL são verificáveis. Os demais retornarão sempre NOT_APPLICABLE.



Address

Endereço Físico Mundial, que pode ser usado para envios ou contas

Campos:

context

:

String

Contexto do endereço, por exemplo: Casa, Trabalho, Matriz, Filial

Análogo a campo de mesmo nome em PersonContact e CompanyContact.


country

:

String obrigatório

Código do país com 3 letras (ISO3166-alpha3). Exemplos: USA, BRA...


city

:

String obrigatório

Nome da cidade em UTF-8


state

(


abbrev:

Boolean

)

:

String

Nome do estado por completo ou abreviado (opcional).

Abreviações de estados podem não estar disponíveis para alguns países, casos em que o nome por completo é retornado.


zip

:

String

Código postal (opcional)


district

:

String

Distrito opcional


kind

:

String

O tipo deve ser Av. (Avenida), R. (Rua), Rd. (Rodovia)...


number

:

Int

Número da construção


place

:

String obrigatório

Nome da via, para ser usado em conjunto com kind e number, compondo a primeira linha de endereço.


complement

:

String

Complemento opcional, como número de apartamento.


reference

:

String

Ponto de referência (exemplo: próximo ao posto)


instructions

:

String

Instruções (exemplo: autorização do receptor)


lon

:

Float

Longitude, opcional: em graus.

Contém a longitude caso seja manualmente provido ou automaticamente descoberto à partir do endereço. Caso não seja possível prover, será null.


lat

:

Float

Latitude, opcional: em graus.

Contém a latitude caso seja manualmente provido ou automaticamente descoberto à partir do endereço. Caso não seja possível prover, será null.



CardHolder

Portador de cartão

Usualmente uma pessoa

Campos:

id

:

ID obrigatório

Identificador Global Único para este objeto


name

:

String

Nome completo do portador como nos documentos oficiais (RG, CPF)


firstName

:

String

Primeiro nome do portador


lastName

:

String

Último nome do portador


displayName

:

String

Nome de usuário a ser exibido (exemplo: encurtado, alias...)


companyName

:

String

Nome da empresa.

Para cartões corporativos (pessoa jurídica), este campo informa o nome fantasia da empresa. Para a razão social, veja companyLegalName.

Para cartões de pessoa física será sempre null.


companyLegalName

:

String

Nome legal da empresa, como escrito em documentos.

Para cartões corporativos (pessoa jurídica), este campo informa a razão social da empresa. Para nome fantasia, veja companyName

Para cartões de pessoa física será sempre null.


legalIds

:

LegalIds

Todos os documentos legais de identificação de empresas ou pessoas.


birthday

:

Date

Data de nascimento


age

:

Int

Idade em anos


gender

:

Gender

Masculino ou Feminino, conforme documentos oficiais


maritalStatus

:

MaritalStatus

Estado civil


income

:

PersonYearlyIncome

Renda anual do portador (individual e familiar).

Este campo é informacional e pode ser utilizado no preenchimento de formulários de outros serviços, por exemplo para emissão de seguros.


occupation

(


language:

String

Língua a ser utilizada no retorno da consulta.

Por padrão adota-se a língua de quem faz a requisição, porém uma diferente pode ser requisitada e está será utilizada, ou a mais próxima disponível. O formato é: en_US (Inglês dos EUA), en (Inglês genérico), pt_BR (Português do Brasil), pt (Português genérico). O formato é o mesmo de IETF language tag.

)

:

PersonOccupation

Profissão do portador.

Este campo é informacional e pode ser utilizado no preenchimento de formulários de outros serviços, por exemplo para emissão de seguros.

Por padrão adota-se a língua de quem faz a requisição, porém uma diferente pode ser requisitada e está será utilizada, ou a mais próxima disponível. O formato é: en_US (Inglês dos EUA), en (Inglês genérico), pt_BR (Português do Brasil), pt (Português genérico). O formato é o mesmo de IETF language tag.


image

(


width:

Int

Caso fornecido, largura da imagem, em pixels.

height:

Int

Caso fornecido, altura da imagem, em pixels.

mimeType:

String

Caso fornecido, o tipo de arquivo desejado (mime-type).

)

:

ImageUrl

URL para foto de perfil. Caso sejam providos sugestões de altura e largura (opcionais) para o tamanho a ser mostrado, o servidor irá retornar a URL para a imagem com o tamanho mais próximo ao requisitado. Caso seja provido o mimeType, a este será dada preferência, o que é muito útil em dispositivos que lidam com um único formato de imagens. Tanto o tamanho quanto o mimeType da imagem apontada pela URL são retornados.


contacts

:

list de PersonContact obrigatório

Contatos do portador de cartão


addresses

:

list de Address obrigatório

Endereço postal


wallets

:

list de Wallet obrigatório

Carteiras em posse deste portador de cartão.


cards

(


first:

Int

Limita a lista às primeiras entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para frente.

after:

String

Inicia após o cursor opaco, se provido. Utilizado em navegação para frente.

last:

Int

Limita a lista às últimas entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para trás.

before:

String

Inicia antes do cursor opaco, se provido. Utilizado em navegação para trás.

filter:

CardFilterInput

Aplica filtro, se provido.

)

:

CardsConnection

Cartões em posse.

Lista todos os cartões de um portador utilizando paginação e um filtro opcional.

Note que nem todos os campos de um cartão serão retornados pois estes têm privacidade restrita ao portador, emissor ou demais entidades autorizadas pela plataforma.

Opcionalmente pode-se utilizar o filter para selecionar apenas cartões de um certo emissor, produto, que oferece algum serviço ou que tenha alguma restrição de uso.


cardTokens

(


first:

Int

Limita a lista às primeiras entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para frente.

after:

String

Inicia após o cursor opaco, se provido. Utilizado em navegação para frente.

last:

Int

Limita a lista às últimas entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para trás.

before:

String

Inicia antes do cursor opaco, se provido. Utilizado em navegação para trás.

filter:

CardTokenFilterInput

Aplica filtro, se provido.

)

:

CardTokensConnection

Query (consulta) tokens CardToken


travelInsurances

(


first:

Int

Limita a lista às primeiras entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para frente.

after:

String

Inicia após o cursor opaco, se provido. Utilizado em navegação para frente.

last:

Int

Limita a lista às últimas entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para trás.

before:

String

Inicia antes do cursor opaco, se provido. Utilizado em navegação para trás.

filter:

TravelInsuranceFilter

Aplica filtro, se provido.

)

:

TravelInsurancesConnection

Seguros Viagem relacionados ao portador.

Lista todos os seguros viagem relacionados ao portador utilizando paginação e um filtro opcional.

A ordem da listagem é do mais recente para o mais antigo.

Opcionalmente pode-se utilizar o filter para selecionar apenas seguros ativos, expirados, cancelados e limitar a um certo intervalo de datas.


extendedWarrantyInsurances

(


first:

Int

Limita a lista às primeiras entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para frente.

after:

String

Inicia após o cursor opaco, se provido. Utilizado em navegação para frente.

last:

Int

Limita a lista às últimas entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para trás.

before:

String

Inicia antes do cursor opaco, se provido. Utilizado em navegação para trás.

filter:

ExtendedWarrantyInsuranceFilter

Aplica filtro, se provido.

)

:

ExtendedWarrantyInsurancesConnection

Seguros de Garantia Estendida relacionados ao portador.

Lista todos os seguros de extensão de garantia de produtos relacionados ao portador utilizando paginação e um filtro opcional.

A ordem da listagem é do mais recente para o mais antigo.

Opcionalmente pode-se utilizar o filter para selecionar apenas seguros ativos, expirados, cancelados e limitar a um certo intervalo de datas.


purchaseProtectionInsurances

(


first:

Int

Limita a lista às primeiras entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para frente.

after:

String

Inicia após o cursor opaco, se provido. Utilizado em navegação para frente.

last:

Int

Limita a lista às últimas entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para trás.

before:

String

Inicia antes do cursor opaco, se provido. Utilizado em navegação para trás.

filter:

PurchaseProtectionInsuranceFilter

Aplica filtro, se provido.

)

:

PurchaseProtectionInsurancesConnection

Seguros de Proteção de Compra relacionados ao portador.

Lista todos os seguros de proteção de compra de produtos relacionados ao portador utilizando paginação e um filtro opcional.

A ordem da listagem é do mais recente para o mais antigo.

Opcionalmente pode-se utilizar o filter para selecionar apenas seguros ativos, expirados, cancelados e limitar a um certo intervalo de datas.


homeAssistences

(


first:

Int

Limita a lista às primeiras entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para frente.

after:

String

Inicia após o cursor opaco, se provido. Utilizado em navegação para frente.

last:

Int

Limita a lista às últimas entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para trás.

before:

String

Inicia antes do cursor opaco, se provido. Utilizado em navegação para trás.

filter:

HomeAssistenceFilter

Aplica filtro, se provido.

)

:

HomeAssistencesConnection

Assistência residencial solicitadas pelo portador.

Lista todas as Assistências residencias relacionadas ao portador utilizando paginação e um filtro opcional.

A ordem da listagem é do mais recente para o mais antigo.

Opcionalmente pode-se utilizar o filter para selecionar assistências pelo seu status, tipo ou ID.


documents

(


first:

Int

Limita a lista às primeiras entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para frente.

after:

String

, se provido. Utilizado em navegação para frente.

last:

Int

Limita a lista às últimas entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para trás.

before:

String

Inicia antes do cursor opaco, se provido. Utilizado em navegação para trás.

filter:

DocumentsFilterInput

Aplica filtro, se provido.

)

:

DocumentConnection

Query (consulta) documentos enviados para verificação



Merchant

Um estabelecimento comercial que realiza transações com cartões Elo.

Campos:

id

:

ID obrigatório

name

:

String obrigatório

legalName

:

String obrigatório

description

:

String

image

(


width:

Int

height:

Int

mimeType:

String

)

:

ImageUrl

legalIds

:

CompanyLegalIds obrigatório

contacts

:

lista obrigatória de CompanyContact obrigatório

addresses

:

lista obrigatória de Address obrigatório

url

:

String

categories

:

lista obrigatória de MerchantCategory obrigatório

Categorias de comerciantes (Código ISO, nome)


transactionFees

:

list de MerchantTransactionFees obrigatório

Preços de Transações efetivos para o Comerciante

As taxas e custos são associados a um uso (i.e: Crédito à vista, Crédito parcelado pela loja...), quantidade de parcelas e tem uma validade, ou seja, são dinâmicos. Devem ser consultados e posteriormente refrescados para este comerciante.

Alguns comerciantes têm valores negociados individualmente para seu CNPJ, estes são retornados preferencialmente. No entanto a maioria dos comerciantes não tem negociação individual, para estes vale os valores da categoria (MerchantCategory), o qual é retornado na ausência dos valores negociados individualmente.

Note que se o comerciante não estiver na base de dados ou não for possível determinar sua categoria será retornado null. Para estes casos deve-se, então, utilizar os preços estabelecidos para a sua categoria procurando diretamente por merchantCategory(iso: X) { transactionFees }.

Os custos são dinâmicos: foram alterados em MerchantTransactionFees { lastModified } e são vigentes até MerchantTransactionFees { expiry }. O usuário deve usar expiry para invalidar o cache local, refrescando as informações após tal data e horário.


cardTransactions

(


first:

Int

Limita a lista às primeiras entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para frente.

after:

String

Inicia após o cursor opaco, se provido. Utilizado em navegação para frente.

last:

Int

Limita a lista às últimas entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para trás.

before:

String

Inicia antes do cursor opaco, se provido. Utilizado em navegação para trás.

filter:

CardTransactionFilterInput

Aplica filtro, se provido.

)

:

CardTransactionsConnection

Consulta transações deste comerciante.

A consulta paginada permite obter transações feitas por este comerciante com um filtro opcional.

Ao ser chamado por um CardHolder (portador), apenas suas transações com este comerciante serão exibidas (filtro implícito).

Para transações de um cartão específico, utilize CardInterface { transactions }, primeiramente obtendo o Card ou CardToken por outras consultas, por exemplo cardInterfaceByHash(hash)

Pode ser null em caso de falta de permissão, por exemplo outro comerciante.



CardIssuer

Entidade do Emissor de Cartão

Campos:

id

:

ID obrigatório

name

:

String obrigatório

legalName

:

String obrigatório

description

:

String

image

(


width:

Int

height:

Int

mimeType:

String

)

:

ImageUrl

legalIds

:

CompanyLegalIds obrigatório

contacts

:

lista obrigatória de CompanyContact obrigatório

addresses

:

lista obrigatória de Address obrigatório

url

:

String

cards

(


first:

Int

Limita a lista às primeiras entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para frente.

after:

String

Inicia após o cursor opaco, se provido. Utilizado em navegação para frente.

last:

Int

Limita a lista às últimas entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para trás.

before:

String

Inicia antes do cursor opaco, se provido. Utilizado em navegação para trás.

filter:

CardFilterInput

Aplica filtro, se provido.

)

:

CardsConnection

Consulta todos os objetos de cartão (Card) disponíveis no contexto.

Se executado por um portador de cartão, serão retornados todos os cartões que este possui e foram emitidos por este emissor.

Se executado por um emissor de cartão, serão retornados todos os cartões emitidos por este.

Em outros casos, como ao ser executado por um comerciante, um erro será produzido.



SocialNetwork

Redes Social

Campos:

provider

:

String obrigatório

Nome do provedor da rede social, ex: Facebook, Twitter...


username

:

String obrigatório

Nome de usuário na rede social



UserAgreement

Termo de uso aceito pelo usuário

Campos:

agreementTerm

:

AgreementTerm obrigatório

O termo que foi aceito


timestamp

:

DateTime obrigatório

Quando o termo foi aceito



AccessTokenInfo

Chave de acesso (accessToken) e informações sobre sua origem.

Campos:

accessToken

:

String obrigatório

A chave de acesso (accessToken) ativa para este usuário


timestamp

:

DateTime obrigatório

Quando a chave de acesso (accessToken) foi criada


ip

(


ipv6Mapped:

Boolean

)

:

String

Endereços de rede IPv4 ou IPv6 de onde partiu a solicitação de criação.

Se for IPv6, deve estar entre colchetes. Exemplo: [::1] Se for IPv4, deve seguir a notação com pontos: 127.0.0.1

O opcional ipv6Mapped estabelece que os endereços IPv4 sempre serão codificados como IPv6 usando regras de mapeamento: [::ffff:127.0.0.1]

Pode ser null se o endereço IP era desconhecido no momento de criação da chave de acesso.


geolocation

:

Geolocation

Localização geográfica de onde partiu a solicitação de criação da chave de acesso (accessToken). Pode ser aproximada à partir do IP.

Pode ser null.


device

:

Device

Dispositivo utilizado para a criação da chave de acesso (accessToken). Pode ser aproximado, por exemplo, usando o Agente de Usuário (User-Agent) para identificar sistema operacional, marca e modelo...



PublicKey

Campos:

id

:

String obrigatório

Identificador da chave para este usuário.

Em operações que retornem dados cifrados este será o identificador da chave a ser especificado, como na consulta CardInterface { sensitive(keyId: "X") }

Este identificador é gerado no momento que a chave é adicionada, vide addPublicKeyToUser()

NOTA: tem escopo do usuário, não é global do sistema.


key

:

String obrigatório

A chave serializada no formato requerido.

Se nenhum formato for especificado, será retornada como JSON Web Key - JWK



Acquirer

Entidade do Credenciador

Campos:

id

:

ID obrigatório

name

:

String obrigatório

legalName

:

String obrigatório

description

:

String

code

:

String obrigatório

Identificador Global Único do Credenciador junto a Elo.

Este campo identifica unicamente os números designados pela Elo para Estabelecimentos/Credenciador.


countryCode

:

String obrigatório

Identificador Global Único do país onde está localizado o Credenciador. Transações nacionais utiliza-se o código 076 (Brasil). ISO 3166-1 numeric


image

(


width:

Int

height:

Int

mimeType:

String

)

:

ImageUrl

legalIds

:

CompanyLegalIds obrigatório

contacts

:

lista obrigatória de CompanyContact obrigatório

addresses

:

lista obrigatória de Address obrigatório

url

:

String

fraudTransactions

(


first:

Int

Limita a lista às primeiras entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para frente.

after:

String

Inicia após o cursor opaco, se provido. Utilizado em navegação para frente.

last:

Int

Limita a lista às últimas entradas, caso provido. Se for null, a listagem é ilimitada. Utilizado em navegação para trás.

before:

String

Inicia antes do cursor opaco, se provido. Utilizado em navegação para trás.

filter:

CardFraudTransactionFilterInput

Aplica filtro, se provido. Consulta as transações fraudulentas que já foram processadas. Apenas CardIssuer pode realizar essas consulta.

)

:

CardFraudTransactionsConnection

Lista de transações fraudulentas



User

Usuário do Sistema

O usuário pode ser associado a um comerciante, emissor de cartões ou pode ser um portador de cartões.

Também são listadas as redes sociais que o usuário relacionou e autorizou, por exemplo via OAuth.

API Privada

Campos:

id

:

ID obrigatório

Identificador Global Único para este objeto


verified

:

VerifiedStatus

O usuário foi verificado por meio de uma rede social, email, SMS ou outro meio.

É o mesmo que conferir todos os contatos do usuário e constatar que ao menos um deles foi verificado (contacts { verified }).


username

:

String

Nome do usuário para acesso ao sistema


name

:

String

Nome completo do portador como nos documentos oficiais (RG, CPF)


firstName

:

String

Primeiro nome do usuário


lastName

:

String

Último nome do usuário


displayName

:

String

Nome de usuário a ser exibido (exemplo: encurtado, alias...)


legalIds

:

LegalIds

Todos os documentos legais de identificação do usuário.


birthday

:

Date

Data de nascimento


age

:

Int

Idade em anos


gender

:

Gender

Masculino ou Feminino, conforme documentos oficiais


maritalStatus

:

MaritalStatus

Estado civil


income

:

PersonYearlyIncome

Renda anual do usuário (individual e familiar).


occupation

(


language:

String

Língua a ser utilizada no retorno da consulta.

Por padrão adota-se a língua de quem faz a requisição, porém uma diferente pode ser requisitada e está será utilizada, ou a mais próxima disponível. O formato é: en_US (Inglês dos EUA), en (Inglês genérico), pt_BR (Português do Brasil), pt (Português genérico). O formato é o mesmo de IETF language tag.

)

:

PersonOccupation

Profissão do usuário.

Por padrão adota-se a língua de quem faz a requisição, porém uma diferente pode ser requisitada e está será utilizada, ou a mais próxima disponível. O formato é: en_US (Inglês dos EUA), en (Inglês genérico), pt_BR (Português do Brasil), pt (Português genérico). O formato é o mesmo de IETF language tag.


image

(


width:

Int

Caso fornecido, largura da imagem, em pixels.

height:

Int

Caso fornecido, altura da imagem, em pixels.

mimeType:

String

Caso fornecido, o tipo de arquivo desejado (mime-type).

)

:

ImageUrl

URL para foto de perfil. Caso sejam providos sugestões de altura e largura (opcionais) para o tamanho a ser mostrado, o servidor irá retornar a URL para a imagem com o tamanho mais próximo ao requisitado. Caso seja provido o mimeType, a este será dada preferência, o que é muito útil em dispositivos que lidam com um único formato de imagens. Tanto o tamanho quanto o mimeType da imagem apontada pela URL são retornados.


contacts

:

list de PersonContact obrigatório

Contatos do usuário


addresses

:

list de Address obrigatório

Endereços postais


cardHolders

:

list de CardHolder obrigatório

Portadores de cartões associados ao usuário

Um usuário pode ter mais de um portador associado no caso de pessoas jurídicas diferentes, bem como um portador para sua pessoa física.

Relação: 1:n


merchants

:

list de Merchant obrigatório

Comerciantes associados ao usuário

Um usuário pode ser responsável por vários comerciantes. Um comerciante pode ter vários usuários responsáveis.

Relação: n:n


cardIssuers

:

list de CardIssuer obrigatório

Emissores de cartões associados ao usuário

Um emissor pode ter vários usuários responsáveis. Em geral um usuário vai ser responsável por apenas um emissor. No entanto está modelado como sendo possível que o usuário seja responsável por vários emissores (evita que a API mude caso este caso se torne realidade).

Relação: n:n


socialNetworks

:

list de SocialNetwork obrigatório

Redes sociais relacionadas ao usuário


agreements

:

list de UserAgreement obrigatório

Termos de uso aceitos pelo usuário


accessTokens

:

list de AccessTokenInfo obrigatório

Lista de chaves de acesso ativas para este usuário


publicKeys

:

list de PublicKey obrigatório

Lista de Chaves Públicas conhecidas para este usuário


origin

:

String

Identifica a origem(campanha) do cadastro do usuário.


analyticsId

:

ID obrigatório

Identificador Global Único para este objeto


acquirer

:

Acquirer


RequestSecondWayOfInsurancePolicyPayload

Retorno da mutação requestSecondWayOfInsurancePolicy().

Compatível com Relay.

Campos:

clientMutationId

:

String

maskedEmail

:

String obrigatório

Retorna versão mascarada do email que receberá a segunda via do seguro.

O mascaramento de emails permitirá identificar qual foi enviado:

Pode ser nulo caso o código tenha sido enviado para um telefone, neste caso verifique maskedPhone



ExtendedWarrantyInsurance

Seguro de Garantia Estendida para portadores de cartão.

Campos:

id

:

ID obrigatório

insuranceId

:

ID obrigatório

Identificador Global Único de Seguro contratado, retornado pela seguradora.


cardHolder

:

CardHolder obrigatório

bin

:

BIN obrigatório

status

:

CardHolderInsuranceStatus obrigatório

merchant

:

MerchantInsurance

Informações do comerciante.


startDate

:

Date obrigatório

A data inicial da cobertura.

A data inicial é computada automaticamente como a data de emissão do seguro.


endDate

:

Date obrigatório

A data final da cobertura.

A data final é computada automaticamente à partir da data da nota fiscal (invoiceDate) acrescida dos meses de garantia do fabricante (manufacturerWarrantyMonths) e então dos meses estendidos com este seguro (extendedWarrantyMonths).


companyInsurance

:

String

Seguradora responsável pelo seguro.


invoiceNumber

:

String

Número da Nota Fiscal


invoiceDate

:

Date

Data da Nota Fiscal


serialNumber

:

String

Número de Série do Produto


category

(


language:

String

Língua a ser utilizada no retorno da consulta.

Por padrão adota-se a língua de quem faz a requisição, porém uma diferente pode ser requisitada e está será utilizada, ou a mais próxima disponível. O formato é: en_US (Inglês dos EUA), en (Inglês genérico), pt_BR (Português do Brasil), pt (Português genérico). O formato é o mesmo de IETF language tag.

)

:

ExtendedWarrantyProductCategory

Categoria do Produto

Por padrão adota-se a língua de quem faz a requisição, porém uma diferente pode ser requisitada e está será utilizada, ou a mais próxima disponível. O formato é: en_US (Inglês dos EUA), en (Inglês genérico), pt_BR (Português do Brasil), pt (Português genérico). O formato é o mesmo de IETF language tag.


brand

:

String

Marca do Produto


model

:

String

Modelo do Produto


description

:

String

Descrição do Produto


value

:

Float

Valor do Produto


extendedWarrantyMonths

:

Int

Número de meses estendidos por este seguro.


manufacturerWarrantyMonths

:

Int

Número de meses cobertos pela garantia do fabricante.



CreateExtendedWarrantyInsurancePayload

Retorno da mutação createExtendedWarrantyInsurance().

Compatível com Relay.

Campos:

clientMutationId

:

String

extendedWarrantyInsurance

:

ExtendedWarrantyInsurance

A instância do Seguro de Garantia Estendida criado.

Caso a mutação falhe retornará null.



PurchaseProtectionInsurance

Seguro de Proteção de Compra de Produtos para portadores de cartão.

Campos:

id

:

ID obrigatório

insuranceId

:

ID obrigatório

Identificador Global Único de Seguro contratado, retornado pela seguradora.


cardHolder

:

CardHolder obrigatório

merchant

:

MerchantInsurance

Informações do comerciante.


bin

:

BIN obrigatório

status

:

CardHolderInsuranceStatus obrigatório

startDate

:

Date obrigatório

A data inicial da cobertura.

A data inicial é computada automaticamente como a data de emissão do seguro.


endDate

:

Date obrigatório

A data final da cobertura.

A data final é computada automaticamente à partir da data da nota fiscal (invoiceDate) acrescida dos dias da proteção escolhidos (securityDays).


companyInsurance

:

String obrigatório

Seguradora responsável pelo seguro.


invoiceNumber

:

String obrigatório

Número da Nota Fiscal


invoiceDate

:

Date obrigatório

Data da Nota Fiscal


serialNumber

:

String

Número de Série do Produto


category

(


language:

String

Língua a ser utilizada no retorno da consulta.

Por padrão adota-se a língua de quem faz a requisição, porém uma diferente pode ser requisitada e está será utilizada, ou a mais próxima disponível. O formato é: en_US (Inglês dos EUA), en (Inglês genérico), pt_BR (Português do Brasil), pt (Português genérico). O formato é o mesmo de IETF language tag.

)

:

PurchaseProtectionProductCategory

Categoria do Produto

Por padrão adota-se a língua de quem faz a requisição, porém uma diferente pode ser requisitada e está será utilizada, ou a mais próxima disponível. O formato é: en_US (Inglês dos EUA), en (Inglês genérico), pt_BR (Português do Brasil), pt (Português genérico). O formato é o mesmo de IETF language tag.


brand

:

String obrigatório

Marca do Produto


model

:

String obrigatório

Modelo do Produto


description

:

String obrigatório

Descrição do Produto


value

:

Float obrigatório

Valor do Produto


coverageDays

:

Int

Número de dias o qual o produto será protegido (segurado).



CreatePurchaseProtectionInsurancePayload

Retorno da mutação createPurchaseProtectionInsurance().

Compatível com Relay.

Campos:

clientMutationId

:

String

PurchaseProtectionInsurance

:

PurchaseProtectionInsurance

A instância do Seguro de Proteção de Compra de Produtos criado.

Caso a mutação falhe retornará null.



TravelInsurance

Seguro de Viagem para portadores de cartão ou dependentes.

Cada instância de seguro viagem é correspondente a uma chamada de createTravelInsurance(), atrelada a um portador de cartões e o BIN que oferece tal serviço (benefício), além de ter um viajante associado (o segurado) e uma lista de beneficiários.

Para viagens com múltiplos viajantes, um seguro de viagem deve ser emitido para cada viajante, ou seja, uma chama de createTravelInsurance() para cada viajante, resultando em um TravelInsurance para cada um.

Campos:

id

:

ID obrigatório

cardHolder

:

CardHolder obrigatório

O Portador, segurado primário da viagem.

O serviço (benefício) de seguro de viagem é oferecido para determinados produtos (i.e: Cartões Elo Nanquim) ao portador do cartão e extensível a demais segurados que viajarão em conjunto.

Em caso de viagem com múltiplos viajantes, o cardHolder será o mesmo, porém os dados do viajante (traveler) listados neste seguro serão referentes ao viajante segurado.


bin

:

BIN obrigatório

merchant

:

MerchantInsurance

Informações do comerciante.


journey

:

Journey obrigatório

Dados da Viagem.


startDate

:

Date obrigatório

A data inicial da cobertura.

A data inicial é computada automaticamente como a data de emissão do seguro.


endDate

:

Date obrigatório

A data final da cobertura.

A data final é computada automaticamente à partir da data da nota fiscal (invoiceDate) acrescida dos dias da proteção escolhidos (securityDays).


companyInsurance

:

String obrigatório

Seguradora responsável pelo seguro.



CreateTravelInsurancePayload

Retorno da mutação createTravelInsurance().

Compatível com Relay.

Campos:

clientMutationId

:

String

travelInsurance

:

TravelInsurance

A instância do Seguro Viagem criado.

Caso a mutação falhe retornará null.




Enumerações


VerifiedStatus

Estados de verificação.

Utilizado, por exemplo, para verificação de contatos de um portador.


Valores possíveis:


UNVERIFIED

O ítem ainda não foi verificado.


PENDING

Iniciou-se o processo de verificação, porém ele ainda não foi concluído. Após a conclusão mudará para VERIFIED ou FAILED.


VERIFIED

O ítem foi verificado com sucesso.


FAILED

O ítem falhou verificação.


NOT_APPLICABLE

O processo de verificação não se aplica a este ítem.




Gender

Opções de gênero


Valores possíveis:


FEMALE


MALE




MaritalStatus

Opções de estado civil


Valores possíveis:


DIVORCED

Divorciado


MARRIED

Casado


SINGLE

Solteiro


WIDOWED

Viúvo


COMMON_LAW_MARRIED

União estável




InsuranceType

Tipo do seguro.

Os tipo de seguro são:

  • TRAVEL

  • PURCHASEPROTECTION

  • EXTENDEDWARRANTY


Valores possíveis:


TRAVEL

Seguro Viagem.


PURCHASEPROTECTION

Seguro Proteção de Compra.


EXTENDEDWARRANTY

Seguro Garantia Estendida.