Cadastro do Portador

A interface de programação referente ao Cadastro do Portador é primariamente composta por consultas que retornam o tipo `CardHolder` e destes consultam-se os campos como nome, documentos, endereços, contatos e demais informações.

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

O portador é um usuário do sistema (User) o qual possuí cartões. Este usuário é denomidado CardHolder e gerencia cartões (Card) e carteiras (Wallet). Um portador (CardHolder) pode cadastrar, consultar, editar e deletar seus cartões, como também pode associar seus cartões ás suas carteiras. Este pode ser uma pessoa física, que possua cartões, ou pessoa jurídica que possua cartões corporativos.

query {
    user {
        id
        username
        cardHolders {
            companyName, 
            companyLegalName, 
            cards { 
                edges { 
                    node { 
                        transactions(filter: { 
                            startTimestamp: "2017-11-21T00:00:00Z", 
                            endTimestamp: "2017-12-30T00:00:00Z",
                            includeMerchantCategories: [{ min: 1,max: 3 }, { min: 4, max: 10 }], 
                            excludeMerchantCategories: [{ min: 10, max: 10 }], 
                            status: APPROVED
                        }) 
                        {
                            pageInfo { hasPreviousPage },
                            edges { 
                                cursor, 
                                node { 
                                    id, 
                                    bin { 
                                        number, 
                                        isInternational, 
                                        product { 
                                            id, 
                                            name
                                        }, 
                                        country
                                    }, 
                                    status, 
                                    capture { id, name }, 
                                    currency, 
                                    value, 
                                    installments
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Essa seção tem como objetivo detalhar alguns processos e trazer o passo-a-passo para integração com itens da API de Cadastro de Portador ELO.

A plataforma ELO de API foi construída pensando em expor as mais diversas informações para os mais diversos clientes de API possíveis, sejam eles bancos, estabelecimentos comerciais, pessoas físicas ou qualquer outro consumidor.

Dado esse cenário, houve a necessidade de se utilizar um protocolo que pudesse ser flexível e ao mesmo tempo seguro para autenticar e autorizar acessos ao recursos e dados contidos e expostos via API.

O OAuth 2.0 é um protocolo de autorização que habilita aplicações terceiras a obter acesso limitado a um serviço web / HTTP.

O OAuth, sendo uma especificação, descreve de forma detalhada uma maneira de tratar cenários simples e complexos de segurança de API. Ele estabelece definições como:

  • Resource Owner: a entidade que é capaz de controlar o acesso a um recurso protegido. É o "dono do recurso", mas nem sempre é uma pessoa. Quando ele é uma pessoa ele é o usuário final.
  • Resource Server: o servidor que possui os recursos protegidos e recebe as requisições para acessar esses recursos.
  • Authorization Server: é um servidor que gera tokens de acesso para permitir que o consumidor acesse os recursos que o resource owner permitiu com o nível de acesso que o resource owner especificou.
  • Client: é a aplicação que acessa os recursos no resource server em nome do usuário. O client pode ser qualquer tipo de aplicação que faça isso. É o consumidor da API.
Oauth

Com essas definições, o OAuth estabelece que quando uma aplicação precisa acessar um recurso protegido ela deve obter primeiro um token de acesso (Access Token). Este é um token contendo as informações que caracterizam o acesso que o dono do recurso permitiu aos dados protegidos.

Todas as requisições realizadas junto à API da ELO deverão utilizar o protocolo HTTPS, e deverão ter em seus cabeçalhos os dados necessários para o acesso ao serviço. São eles:

  • client_id: Identificador gerado quando o desenvolvedor cria uma aplicação no portal e que pode ser encontrado nas configurações da dashboard da aplicação.
  • Authorization ou access_token: Aqui é um ponto importante que deve ter bastante atenção do desenvolvedor. Enquanto o usuário não realizou o login na API é obrigatório o envio do Authorization. Após o login o desenvolvedor deve enviar apenas o access_token obtido.

Authorization

O Authorization pode ser obtido concatenando o texto "Basic " ao resultado da codificação em Base 64 dos campos client_id e client_secret concatenados com :.

Abaixo um exemplo de pseudo-código para gerar o authorization:

var authorization = "Basic " + base64(client_id + ":" + client_secret);

e a seguir temos um exemplo de Authorization já definido no header da requisição:

Authorization : Basic ZjkyMTIxNzMtZTcwNS0zNzNiLWE2OTgtNjE5MjNlMzc4MzU5OjAyYWI1Mjg4LTkyZGItM2FiMy05OWZkLWZhYzRhZjg1N2Q4MQ==

Para que seja possível iniciar a jornada dentro da plataforma de APIs da Elo, é necessário que um usuário seja criado. Para esse processo o desenvolvedor deverá usar a função createUser disponibilizada pela API. Esta função pode ser utilizada de duas maneiras:

  • O usuário utilizará o nome de usuário e senha como meio de autenticação.
  • O usuário utilizará uma rede social suportada pela plataforma da ELO como meio de autenticação.

A seguir é demonstrado uma visão geral desse processo.

Fluxo de criação de um usuário

fluxoCreateUser

Um exemplo da utilização da função createUser usando o nome de usuário e senha como autenticação é demonstrado a seguir.

Exemplo do corpo da requisição:

mutation{
  createUser(input:{
    clientMutationId: "123",
    username: "username",
    bcryptPassword: "$2a$12$oumE.pnRbsdi.c4KYsyNWOJoVyfi2jMKDe102Er5uGCdzd49SvE1Y",
    name: "name",
    firstName: "firstName",
    lastName: "lastName",
        contacts: [{
            type: PHONE
            context: "CASA"
            value: "19 123456789"
        }]
    displayName: "displayName",
    legalIds:{
      cpf: "1234567890",
      rg:{
        number: "234567890",
        issuerOrganization: "SSP",
        issuerState: "SP",
        issueDate: "2020-12-03"
      }
    }
  })
  {
    clientMutationId,
    id,
    name
  }
}

Exemplo da resposta da API:

{
   "data": {
        "createUser": {
            "id": "89bd51d6-8eaf-31a5-bd2c-1fve81d17db4",
            "name": "name"
        }
   }
}

No exemplo acima o campo id é o access_token que deve ser utilizado caso o usuário faça alguma requisição a algum recurso da API. Nesse cenário não é necessário que o usuário faça login após a criação pois o mesmo já foi feito implicitamente pela função createUser e o token de acesso pode ser utilizado até sua expiração.

Um exemplo da utilização da função createUser usando uma rede social é demonstrado a seguir.

Exemplo do corpo da requisição:

mutation{
  createUser(input:{
    clientMutationId: "123",
    username: "username",
    socialNetwork:{
      provider: "FACEBOOK",
      username: "usernameFacebook@gmail.com"
    },
    oauth:{
      accessToken: "EAACEdEose0cBAPZAVQLY5qPqEfqPPPviCy5NYbYBX7zLndQWDiUZBOBMC5Ry...",
      refreshToken: "",
      scopes: "email",
      expiryTimestamp: "2018-03-01T00:00:00Z"
    },
    name: "name",
    firstName: "firstName",
    lastName: "lastName",
    displayName: "displayName",
    legalIds:{
      cpf: "1234567890",
      rg:{
        number: "234567890",
        issuerOrganization: "SSP",
        issuerState: "SP",
        issueDate: "2020-12-03"
      }
    }
  })
  {
    clientMutationId,
    id,
    name
  }
}

A resposta da criação do usuário usando uma rede social é a mesma do exemplo anterior.

Tipos de Usuário

Após a criação, um determinado usuário pode assumir 3 tipos distintos na plataforma da Elo, sendo eles:

  • Card Holder: Um usuário portador de um ou mais cartões Elo;
  • Card Issuer: Um usuário que emite cartões Elo;
  • Merchant: Um estabelecimento comercial que realiza transações com cartões Elo;

Cada tipo possui sua forma de ser associado, com informações pertinentes a cada um. Um usuário só pode ter um tipo associado ao mesmo tempo, logo, se um usuário está associado a um CardHolder e tenta se associar a um Merchant um erro será retornado. Neste caso, é necessário remover a associação do CardHolder do usuário e, somente depois, realizar a associação ao novo tipo.

Para associar um CardHolder ao usuário basta utilizar a função createCardHolderForUser, a mutation abaixo é um exemplo de sua utilização. Por questão de segurança o campo userId não se refere ao real id do usuário, e sim ao access_token do mesmo.

Exemplo do corpo da requisição:

mutation{
    createCardHolderForUser(input:{
        clientMutationId: "123",
        userId: "33744898-9844-4864-a0ca-046d50fdaf15",
        companyName: "companyName",
        companyLegalName: "companyLegalName",
        companylegalIds: {
            cnpj: "1234567890"
        }
    })
    {
        clientMutationId,
        user{
            id,
            verified,
            name,
            displayName
        },
        cardHolder{
            id,
            name,
            companyName,
            companyLegalName
        }
    }
}

Neste exemplo estamos criando o CardHolder e associando o mesmo ao usuário identificado pelo access_token, que é refletido no campo userId. Os dados retornados após a criação e associação do CardHolder ao usuário, serão os que foram definidos na parte inferior da mutation.

Para associar um CardIssuer ao usuário basta utilizar a função addCardIssuerToUser, a seguir temos a chamada para esta mutation como exemplo de utilização. Por questão de segurança o campo userId não se refere ao real id do usuário, e sim ao access_token do mesmo.

Exemplo do corpo da requisição:

mutation{
    addCardIssuerToUser(input:{
        clientMutationId: "123",
        userId: "97c7fb10-174c-4e23-8feb-926d1d23a035",
        cardIssuerId: "1b253372-8215-4567-a54d-4fa78dadf0f6"
    })
    {
        clientMutationId,
        user{
            id,
            verified,
            name,
            displayName
        },
        cardIssuer{
            id,
            name,
            legalName
        }
    }
}

Neste exemplo estamos associando um CardIssuer ao usuário identificado pelo access_token, que é refletido no campo userId. Os dados retornados após à associação do CardIssuer ao usuário, serão os que foram definidos na parte inferior da mutation.

Para associar um Mechant ao usuário basta utilizar a função addMerchantToUser, a seguir temos um exemplo de sua utilização. Por questão de segurança o campo userId não se refere ao real id do usuário, e sim ao access_token do mesmo.

Exemplo do corpo da requisição:

mutation{
    addMerchantToUser(input:{
        clientMutationId: "123",
        userId: "14991673-f5b9-43b8-8cb3-8da353b9b70c",
        merchantId: "b86eb0ef-0c21-4ea5-b407-9f113a229190"
    })
    {
        clientMutationId,
        user{
            id,
            verified,
            name,
            displayName
        },
        merchant{
            id,
            name,
            legalName
        }
    }
}

Neste exemplo estamos associando um Merchant ao usuário identificado pelo access_token, que é refletido no campo userId. Os dados retornados após à associação do Merchant ao usuário, serão os que foram definidos na parte inferior da mutation.

Outras interações

Para consultar um usuário basta utilizar uma Query de usuário, como no exemplo abaixo.

query {
   user(id: "70fa9e70-1b41-3f68-8df9-b207d76929f6") {
        id,
        username
        cardHolders{
            id
            name
            companyName
        }
    }
}

Para atualizar um usuário basta utilizar a função updateUser, a seguir temos um exemplo de sua utilização. Por questão de segurança o campo id não se refere ao real id do usuário, e sim ao access_token do mesmo.

mutation {  
    updateUser(input:{
        id: "0c9cd95a-365e-40d3-89c2-63c35340a0fa",
        firstName: "firstName changed"
    }) {
        user{
            id
            firstName
        }
    }
}

Neste exemplo estamos atualizando o firstName (primeiro nome) do usuário, porém outros atributos também podem ser atualizados.

Para deletar um usuário basta utilizar a função deleteUser, a seguir temos um exemplo de sua utilização. Por questão de segurança o campo userId não se refere ao real id do usuário, e sim ao access_token do mesmo.

mutation {  
    deleteUser(input:{
        userId: "e29e5d4b-c5f6-45c9-90e0-26b21fed43f9"
    }) {
        userId
        username
        displayName
    }
}

Neste exemplo estamos deletando o usuário com identificação informada no campo userId.

O campo bcryptPassword presente no cadastro de usuário refere-se aos dados sensíveis de acesso do usuário à API. Estes dados são o nome de usuário e senha criptografados usando o algoritmo conhecido como bcrypt. Os passos para utilização desse algoritmo com os parâmetros requisitados pela API da ELO são descritos abaixo:

1º Passo: Gerar um salt a partir do nome de usuário:

  • Aplicar o algoritmo SHA256 no nome do usuário e reservar os 16 primeiros caracteres.
  • Aplicar a codificação Base64 sobre o resultado do item anterior utilizando o alfabeto customizado do algoritmo bcrypt. O alfabeto utilizado pelo bcrypt utiliza "." ao invés de "+" e começa com "./". Segue abaixo:

    ./ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789

  • Concatenar o resultado do item anterior com o texto "$2a$12". Exemplo de resultado:

    $2a$12$N9qo8uLOickgx2ZMRZoMye

2º Passo: Aplicar o algoritmo bcrypt utilizando a senha do usuário e o salt gerado no primeiro passo:

  • Aplicar o algoritmo SHA256 na senha do usuário.
  • Aplicar a codificação Base64 sobre o resultado do item anterior.
  • Aplicar o algoritmo bcrypt utilizando o resultado do item anterior e o salt gerado no primeiro passo.

NOTA: O custo utilizado pelo algoritmo do bcrypt deve ser igual a 12.

Para ter acesso às APIs da Elo o usuário deve possuir um access_token válido e para isso ele deve efetuar login na plataforma. O processo de login pode ser realizado de duas formas: utilizando um nome de usuário e senha via createLoginSalt e ou utilizando uma rede social via socialNetworkOAuthLogin.

Veja na figura abaixo os dois exemplos:

login

Caso o usuário queira utilizar o nome de usuário e senha ele primeiro deve fazer uso da chamada createLoginSalt. Essa função retorna um salt que deve ser utilizado para gerar o challenge que será enviado no processo de login (Mais detalhes de como obter o challenge será descrito posteriormente). Um exemplo dessa chamada pode ser vista abaixo.

Exemplo do corpo da requisição:

mutation {
    createLoginSalt(input:{
        username: "UserNameToLogin"
    }) 
    {
        username, 
        salt
    }
}

Exemplo da resposta da API:

{
  "data": {
    "createLoginSalt": {
      "username": "UserNameToLogin",
      "salt": "$2a$05$J/dgZmXIN23mEZtvkxDYeO"
    }
  }
}

Na sequência é necessário fazer uso da chamada login. Esta requisição é necessária para dar acesso ao usuário às demais chamadas da API. Desta forma, no retorno dessa chamada é disponibilizado o access_token que identifica o usuário de forma única.

Exemplo do corpo da requisição:

mutation {
    login(input:{
        clientMutationId: "0123456789",
        username: "UserNameToLogin",
        challenge:"$2a$05$J/dgZmXIN23mEZtvkxDYeOtRsNEY4xMU9HHkcBVMpiUlFSFBuhtxy"
    }) 
    {
        clientMutationId,
        accessToken
    }
}

Exemplo da resposta da API:

{
   "data": {
       "login": {
           "clientMutationId": "0123456789",
           "accessToken": "b64a0e34-24c5-39eb-b457-0c7331d176f0"
       }
   }
}

Caso o usuário queira utilizar uma rede social para se autenticar na API da Elo ele deverá fazer uso da chamada socialNetworkOAuthLogin. Assim como no fluxo descrito anteriormente, no retorno da função também é disponibilizado o access_token que identifica o usuário de forma única.

Exemplo do corpo da requisição:

mutation {
    socialNetworkOAuthLogin(input:{ 
        clientMutationId: "0123456789", 
        provider: "FACEBOOK", 
        username: "user.name@gmail.com",  
        accessToken:"AAECEdEose0cBANynsVcZChZBxB3ysAuxDeZC3ZB4eIzkUKJnvoaTO1Vf4gyj8sl9bFFNPlnGU0Qsnh2fys7gcymWE7lKL64ygGLCJAtgyJtNq4YSGBkdDZBcgnAGZBKaGiI6emZCap8WJYO8ex06ZAZB75IdWnDtPoGCF8yPQnW4JZALHgeL1A1o6ZC5nz5uLD2lnVoUpkxAr1CNQABCD"
    }) 
    {
        clientMutationId,
        accessToken
    }
}

Exemplo da resposta da API:

{
    "data": {
        "login": {
            "clientMutationId": "0123456789",
            "accessToken": "120faef6-5f31-3e74-afb2-864151c52880"
        }
    }
}

O campo challenge presente no login de usuário refere-se ao resultado do desafio (challenge) de login. É um Hash utilizando o algoritmo bcrypt com salt (fornecido por createLoginSalt) e conteúdo sendo o bcryptPassword (especificado em User).

Os passos são os mesmos da geração do bcryptPassword, porém com dois passos a mais.

Após gerar o bcryptPassword:

  • Gerar um salt a partir da função createLoginSalt.
  • Aplicar o algoritmo bcrypt utilizando o bcryptPassword e o salt gerado no item anterior.

NOTA: O resultado final deve estar no formato padrão, com prefixo, custo, salt e por fim o valor computado em Base64, totalizando 60 caracteres.

Exemplo de challenge: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy.

Para criar um cartão é necessário utilizar a função createCard. Esta requisição é responsável por criar um novo cartão associado ao usuário que o criou. Para poder fazer uso dessa função o usuário deve ser um portador (CardHolder). Abaixo é demonstrado uma visão geral do processo de criação de um cartão.

createCard fluxo1

Um exemplo da utilização do createCard pode ser visto abaixo.

mutation {
    createCard(input: {
        clientMutationId: "123",             
        sensitive:"eyJhbGciOiJFQ0RILUVTIiwiZW5jIjoiQTEyOENCQy1IUzI1NiIsImVway...",
        holderId: "9e5d64e4-409f-4900-b3b6-28319950fe5b",
        billingAddress: {
            context: "Casa",
            number: 123,
            country: "BRA",
            city: "Campinas",
            state: "São Paulo",
            zip: "1234",
            place: "via"
        }
    })
    {
        clientMutationId,
        card {
            id,
            last4,
            billingAddress{
            context,
            country,
            city
            }
        }
    }
}

Apoś a criação do cartão serão retornados os dados solicitados pelo usuário na parte inferior da mutation.

O campo sensitive é o conteúdo sensível (Número do cartão, Nome do portador, Vencimento, etc) gerado a partir de um processo de assinatura e criptografia, cujo payload foi assinado a partir do uso de uma a chave privada do usuário e na sequência criptografado fazendo uso de uma chave pública do servidor. Mais detalhes desse campo na seção Sensitive.

O campo holderId é o id do CardHolder que foi associado ao usuário. Logo não é o id (access_token) do usuário, e sim do CardHolder associado a ele.

Outras interações

Para consultar cartões utilizando filtros utiliza-se a Query cards, abaixo segue um exemplo de utilização.

query {  
    cards(filter:{
        status:ACTIVE
    }) {
        edges{
            node{
                id
                last4
                expiry{
                    month
                    year
                }
            }
        }
    }
}

Neste exemplo estamos buscandos todos os cartões ativos. Outros filtros podem ser aplicados para esta consulta, como também pode ser solicitado outros retornos.

Para consultar cartão por identificador global único é utilizado a consulta node. Abaixo segue um exemplo de utilização.

query {  
    node(id: "b63dcf70-08ae-423f-9459-db580b3d6e95") {
        ... on Card {
            id
            last4
            status {
                status
            }
            bin {
                number
            }
        }
    }
}

Neste exemplo estamos solicitando uma consulta de nó (node) onde o identificador global único refere-se a um cartão. Outras informações de retorno podem ser solicitadas nesta requisição.

Também é possível listar os cartões pela consulta de usuário, como no exemplo abaixo.

query {  
    user {
        cardHolders{
            cards{
                edges{
                    node{
                        id
                        last4
                        expiry{
                            month
                            year
                        }
                    }
                }
            }
        }
    }
}

Nesta requisição estamos listando os cartões de um portador utilizando a Query de usuário. Outras informações podem ser solicitadas no retorno desta consulta.

Para atualizar um cartão é utilizado a função updateCard. Abaixo segue um exemplo de utilização.

mutation {
    updateCard(input:{
        holderId: "d6f9605c-8da9-484a-bdb4-3e483db232ee",
        billingAddress:{
            country: "coutnry changed",
            city: "city changed",
            state: "SP changed",
            number: 32,
            place: "place changed"
        }
        status:SUSPENDED
    }) {
        card {
            id
            last4
            expiry{
                month
                year
            }
        }
    }
}

Neste exemplo estamos atualizando algumas informações do endereço de cobrança do cartão e o seu status. O cartão é identificado pelo campo holderId. Outras informações podem ser atualizadas além do endereço e status.

Para deletar um cartão é utilizado a função deleteCard. Abaixo segue um exemplo de utilização.

mutation {
    deleteCard(input:{
        cardId: "c049ac20-084b-46f1-ac03-817e855b5811"
    }) {
        cardId
        last4
        bin {
            number
        }
    }
}

Neste exemplo estamos deletando o cartão identificado pelo campo cardId, e solictando algumas informações do mesmo.

O campo sensitive presente no cadastro de cartão refere-se aos dados sensíveis de um cartão (número do cartão, código de verificação, validade e etc). Estes dados estarão assinados e criptografados por um processo de criptografia para garantir sua segurança.

O primeiro passo na geração deste campo é ter os dados no formato JSON como descrito abaixo:

  • pan: O número da conta primária (Primary Account Number), também conhecido como "número do cartão" físico. Exemplo: "1234567890123456".
  • expiry: Data de validade do cartão, ou seja, quando ele expira. É um objeto composto pelas chaves month e year descritas a seguir. Exemplo: {"month": 2, "year": 2020}.

    month: Mês da validade do cartão. Número inteiro entre 1 (Janeiro) e 12 (Dezembro).
    year: Ano da validade do cartão. Número inteiro com 4 dígitos (2017, não 17).

  • name: Nome do portador do cartão. Exemplo: "João da Silva".
  • csc: Código de segurança do cartão (Card Security Code), usualmente impresso na parte de trás do cartão físico.
  • cscEntryTime: Data e horário quando o CSC (Código de Segurança do Cartão) foi digitado. É necessário quando o CSC é gerado por um chaveiro/token baseado em tempo. Deve estar no formato ISO 8601. Exemplo: "2017-06-01T12:00:00-03:00".
  • authCode: Código de autorização. Este código não é o CSC (Código de Segurança do Cartão) pois não está impresso no cartão. Exemplo: "AB123Z1Y".
  • authCodeEntryTime: Data e horário quando o código de autorização (authCode) foi digitado. Deve estar no formato ISO 8601. Exemplo: "2017-06-01T12:00:00-03:00".

NOTA: a autorização é feita com os campos csc ou authCode e seus respectivos horários de entrada. Apenas um deles deve ser especificado.

O segundo passo é assinar os dados utilizando JSON Web Signature (JWS) em formato compacto, e utilizando Elliptic Curve (EC) como algorítimo de assinatura.

O terceiro passo é criptografar os dados do passo anterior utilizando a chave pública do servidor, que pode ser obtida a partir da query:

query {
    serverPublicKey {
        key
    }
}

Tal criptografia será realizada utilizando JSON Web Encryption (JWE) em formato compacto, e EC como algoritimo de criptografia.

A estrutura de assinatura e criptografia segue a seguinte ideia:

JWE.Encrypt(recipient=ServerKey, format=compact,
     JWS.Sign(issuer=UserKey, format=compact,
         JSON.Stringify(CardSensitiveInput)
     )
)

O quarto passo é cadastrar a chave pública do cliente a qual foi utilizada para assinar os dados sensíveis. Desta forma o servidor poderá validar a assinatura do cliente no processo de descriptografia do campo sensitive. Abaixo segue um exemplo da mutation de cadastro de chave pública.

pública

mutation {
    addPublicKeyToUser(input:{
        clientMutationId:"012", 
        userId:"bdc89491-f1f4-32f7-bad2-f44ae3b88aa6", 
        key:"{\"kty\":\"EC\", \"kid\":\"my-public-key-id-1\", \"x\":\"g_Sr4WwVDt5Qy3KonZyXqFwWykTR9KVMCt8Sx-dXSB8\",\"y\":\"ydSE-mUMtuhBTI_txDpd2ivb7e6FNzxq4e_18iHFZ2U\",\"crv\":\"P-256\"}",
        format:JWK
}) {
        clientMutationId, 
        user{
            id,
            firstName
            ,lastName
        }, 
        publicKey{
            key
        }
    }
}

NOTA: o quarto passo só é necessário caso a chave pública que assinou os dados sensíveis não tenha sido cadastrada anteriormente.

A carteira é uma forma do usuário organizar seus cartões. Para criar uma carteira utilizando a API da ELO basta que o usuário seja um portador (CardHolder) e faça uso da função CreateWallet. Um exemplo de utilização dessa função pode ser vista abaixo:

mutation { 
    createWallet(
        input: { 
            clientMutationId: "123", 
            cardHolderId: "fdf9f98e-a6ac-4878-ad45-cc133e4ca168", 
            name: "Carteira"
        }
    ) {
        clientMutationId, 
        wallet{ 
            id, 
            name, 
            holder{
                name, 
                firstName, 
                displayName
            }
        }
    }
}

Após a criação da carteira serão retornados seus dados e a partir deles é possível fazer seu gerenciamento adicionando ou removendo cartões. Abaixo temos um exemplo de cada operação possível com a carteira criada.

Adicionar um cartão à carteira:

mutation {
    addCardToWallet(
        input:{
            clientMutationId:"123", 
            walletId: "770d83de-f022-4c4e-b12d-e62f3d2d1d51", 
            cardId: "2fde85bf-6935-4e9b-8262-94d82e08e4bd"
        }
    ) { 
        clientMutationId, 
        wallet{ 
            id,
            name 
        }, 
        card{
            id
        }
    }
}

Remover cartão de uma carteira:

mutation{
    removeCardFromWallet(
        input:{
            clientMutationId: "012", 
            walletId: "770d83de-f022-4c4e-b12d-e62f3d2d1d51", 
            cardId: "2fde85bf-6935-4e9b-8262-94d82e08e4bd"}
    ) {
        clientMutationId, 
        wallet{
            name
        }, 
        card{
            id
        }
    }
}

Atualizar a carteira:

mutation{
  updateWallet(
      input: {
          clientMutationId: "123",
          walletId: "770d83de-f022-4c4e-b12d-e62f3d2d1d51",
          name: "Carteira Principal"
        }
    ) {
        wallet {
            id,
            name
        }
    }
}

NOTA: Só é possível atualizar o nome da carteira.

Remover a carteira:

mutation{
    deleteWallet(
        input:{
            clientMutationId: "012", 
            walletId: "770d83de-f022-4c4e-b12d-e62f3d2d1d51"
        }
    ) { 
        clientMutationId, 
        walletId, 
        name
    }
}

Consulta

Consultar dados de portador utilizando a consulta de usuário:

query {
   user(id: "70fa9e70-1b41-3f68-8df9-b207d76929f6") {
        id,
        username
        cardHolders{
            id
            name
            companyName
        }
    }
}

NOTA: o parâmetro id se refere ao access_token do usuário.

Dados de um portador via ID

Consultar o nome, CPF, RG e data de nascimento de um portador dado o identificador global único:

query {
   node(id: "B8B1582B-1C2C-406B-9FC3-ACA842049207") {
      ... on CardHolder {
         firstName
         lastName
         legalIds {
            cpf {
               number
            }
            rg {
               number
               issuerOrganization
               issuerState
               issueDate
            }
         }
         birthday
      }
   }
}

NOTA: o parâmetro id se refere ao identificador global único do portador (CardHolder).

  • Access_token:: Código de acesso disponibilizado pela API após a realização do login e que deve ser utilizado pelo desenvolvedor ao realizar as chamadas aos recursos disponibilizados. Ele é utilizado para validação do acesso e identificação do usuário que está realizando as operações na API.
  • Bcrypt: Algoritmo de criptografia do tipo hash utilizado para segurança de senhas (Wikipedia). No contexto desta API é o resultado do algoritmo bcrypt sobre o nome de usuário e senha.
  • BIN: Número de Identificação do Banco (Bank Identification Number). O BIN é relativo aos números iniciais de um cartão e identifica o emissor e produtos associados ao mesmo.
  • CardIssuer: Um usuário do tipo pessoa jurídica que emite cartões. Também conhecido como Emissor.
  • CardHolder: Um usuário do tipo pessoa física ou jurídica que possui cartões. Também conhecido como Portador.
  • Challenge: Resultado do algoritmo bcrypt aplicado sobre o bcrypt do nome do usuário e senha, e do salt.
  • Client_id: Identificador utilizado pela API para verificar e validar qual a aplicação está fazendo uso dos recursos disponibilizados. Sua geração é feita no momento que o desenvolvedor cria uma nova aplicação no portal de desenvolvedores.
  • Merchant: Um usuário do tipo pessoa jurídica que é um estabelecimento comercial e realiza transações com cartões.
  • PAN: Número da conta primária (Primary Account Number), também conhecido como "número do cartão".
  • Salt: Dado gerado de forma aleatório que é usado no algoritmo de criptografia junto da senha como uma forma de proteção evitando que o hash de dois dados iguais gerem o mesmo resultado.
  • Sensitive: Conteúdo sensível (Número do cartão, Nome do portador, Vencimento, etc) gerado a partir de um processo de assinatura e criptografia, cujo payload foi assinado a partir do uso de uma a chave privada do usuário e na sequência criptografado fazendo uso de uma chave pública do servidor.
  • Wallet: Carteira virtual utilizada para organizar cartões criados pelo portador dentro da API da ELO.

Query (consulta) compatível com a identificação de objetos do Relay

IDs são protegidos por permissões de contexto. Um node apenas pode ser buscado por seu identificador caso seja autorizado pelas permissões do usuário.

O retorno especifica a interface Node que contém apenas o campo id, o qual já é designado como parâmetro. Portanto para utilizar essa chamada utilize fragment para especificar quais campos retornar para cada tipo que implementa esta interface.

Fragmentos inline:

 node(id: "identificador-global-123") {
   __typename
   ... on Card {
     last4
   }
 }

Fragmentos reusáveis:

 fragment CardLast4Fragment on Card {
   last4
 }

 node(id: "identificador-global-123") {
   __typename
   ...CardLast4Fragment
 }

Especificação de identificador global de objetos (Relay Global Object Identification Specification).

Parâmetros de entrada

id (ID!) Identificador global único do nó (objeto) a ser consultado.

Parâmetros de saída

id (ID!) Identificador Global Único para este objeto

Query (consulta) portadores de cartões CardHolder

Parâmetros de entrada

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

after (String) Inicia após o cursor opaco, se definido. Utilizado em navegação para frente.

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

before (String) Inicia antes do cursor opaco, se definido. Utilizado em navegação para trás.

filter (SearchFilterInput) Aplica filtro, se definido.

Parâmetros de saída

pageInfo (PageInfo!) Cursor opaco para ser usado com queries (consultas) after ou before.

edges ([CardHoldersEdge]) Lista de arestas que compõem esta conexão.

totalCount (Int) Contagem total de objetos nesta conexão.

Arestas são limitadas a cursores before e after, assim como primeiras e últimas contagens. Assim o tamanho de arestas é possivelmente menor que a conexão como um todo.

totalCount, se não for null, indica o número total de itens na conexão considerando-se o filtro.

Conexão de CardHolder em conformidade com o Relay.

Parâmetros de entrada

pageInfo (PageInfo!) Cursor opaco para ser usado com queries (consultas) after ou before.

edges ([CardHoldersEdge]) Lista de arestas que compõem esta conexão.

totalCount (Int) Contagem total de objetos nesta conexão.

Arestas são limitadas a cursores before e after, assim como primeiras e últimas contagens. Assim o tamanho de arestas é possivelmente menor que a conexão como um todo.

totalCount, se não for null, indica o número total de itens na conexão considerando-se o filtro.

PageInfo compatível com Relay.

Parâmetros de entrada

hasPreviousPage (Boolean!)

hasNextPage (Boolean!)

startCursor (String)

endCursor (String)

Aresta de conexão contendo um CardHolder em conformidade com o Relay.

Parâmetros de entrada

cursor (String!) Cursor opaco para ser usado com queries (consultas) after ou before.

node (CardHolder) O objeto CardHolder que compõe esta aresta de conexão.

Portador de cartão

Usualmente uma pessoa

Parâmetros de entrada

id (ID!) 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 (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 (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 ([PersonContact]) Contatos do portador de cartão

addresses ([Address]) Endereço postal

wallets ([Wallet]) Carteiras em posse deste portador de cartão.

cards (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.

travelInsurances (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 (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 (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.

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

Parâmetros de entrada

cnpj (CNPJ)

cpf (CPF)

rg (RG)

CNPJ: Cadastro Nacional Pessoas Jurídicas

Parâmetros de entrada

number (String!) número do CNPJ (dígitos) sem hífen ou pontos.

CPF: Cadastro Pessoa Física

Parâmetros de entrada

number (String!) número do CPF (dígitos) sem hífen ou pontos.

RG: documento de Registro Geral

Parâmetros de entrada

number (String!) 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

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

Parâmetros de entrada

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...

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

Parâmetros de entrada

id (ID!) Identificador opaco da Profissão

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

display (String!) Texto a ser exibido ao usuário em formulários e consultas.

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

URL de imagem com tamanho e mimeType.

Parâmetros de entrada

url (String!) URL para acessar a imagem

width (Int!) largura em pixels

height (Int!) altura em pixels

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

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

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

Parâmetros de entrada

type (PersonContactType!) 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!) 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.

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

Parâmetros de entrada

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!) Código do país com 3 letras (ISO3166-alpha3). Exemplos: USA, BRA...

city (String!) Nome da cidade em UTF-8

state (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!) 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.

Carteira digital (Digital Wallet)

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto

name (String!) Nome da carteira

holder (CardHolder!) Nome e contato do portador

cards (CardsConnection) Consulta todos os cartões disponíveis no contexto.

Se executado por um portador de cartão, então retorna todos os cartões contidos na carteira.

Caso contrário, se requisitado por emissores ou comerciantes, produz um erro.

Conexão de Card em conformidade com o Relay.

Parâmetros de entrada

pageInfo (PageInfo!) Conexão de Card em conformidade com o Relay.

edges ([CardsEdge]) Lista de arestas que compõem esta conexão.

totalCount (Int) Contagem total de objetos nesta conexão.

Arestas são limitadas a cursores before e after, assim como primeiras e últimas contagens. Assim o tamanho de arestas é possivelmente menor que a conexão como um todo.

totalCount, se não for null, indica o número total de itens na conexão considerando-se o filtro.

Aresta de conexão contendo um Card em conformidade com o Relay.

Parâmetros de entrada

cursor (String!) Cursor opaco para ser usado com queries (consultas) after ou before.

node (Card) O objeto Card que compõe essa aresta conexão.

Um cartão de crédito ou débito.

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto.

sensitive (String) Conteúdo sensível o qual foi assinado e então cifrado conforme a estrutura:

 JWE.Encrypt(recipient=ServerKey, format=compact,
     JWS.Sign(issuer=UserKey, format=compact,
         JSON.Stringify(CardInterfaceSensitive)
     )
 )

Para obter os dados sensíveis, faça o processo reverso:

 JSON.Parse(payload of
     JWS.Verify(payload of
         JWE.Decrypt(sensitive)
     )
 )

Ou seja, os dados conforme o esquema JSON CardInterfaceSensitive devem ser decifrados utilizando JSON Web Encrypt (JWE) e então ter sua assinatura verificada por JSON Web Signature (JWS) e então interpretados como uma string JSON.

O esquema define as seguintes chaves para o objeto resultante da decodificação (CardInterfaceSensitive):

  • pan: O número da conta primária (Primary Account Number), também conhecido como \"número do cartão\" (físico ou virtual). Exemplo: "1234567890123456"
  • expiry: Data de validade do cartão, ou seja, quando ele expira. É um objeto composto pelas chaves month e year descritas a seguir. Exemplo: {"month": 2, "year": 2020}
    • month: Mês da validade do cartão. Número inteiro entre 1 (Janeiro) e 12 (Dezembro).
    • year: Ano da validade do cartão. Número inteiro com 4 dígitos (2017, não 17).
  • name: Nome do portador do cartão. Exemplo: "João da Silva".
  • csc: Código de segurança do cartão (Card Security Code), usualmente impresso na parte de trás do cartão físico. É opcional, alguns sistemas não retornam o código de segurança por meio eletrônico e este deve ser consultado no cartão físico; para tokens de cartões virtuais (Virtual Card Number - VCN) pode ser retornado apenas na mutação createCardToken. Exemplo: "123".

    JSON Schema: CardInterfaceSensitive.json

    Nota: pode ser nulo por falta de permissões.

last4 (String) Últimos 4 dígitos do cartão, para ser mostrado ao usuário

Pode ser nulo dependendo de permissões e acesso.

expiry (CardExpiry) Data de validade do cartão

Pode ser nulo dependendo de permissões e acesso.

holder (CardHolder) Nome e contato do portador do cartão

Pode ser nulo dependendo de permissões e acesso.

billingAddress (Address) Endereço para conta

Pode ser nulo dependendo de permissões e acesso.

status (CardStatusInterface!) Se o cartão é inativo, ativo ou suspenso.

Pode ser CardStatusInactive, CardStatusActive ou CardStatusSuspended. Use fragmentos para pegar campos extras.

usageConstraints (CardUsageConstraints) Como o cartão pode ser usado

availableServices ([CardHolderService]) Serviços (benefícios) disponíveis ao portador deste cartão.

Para listagem dos serviços em uso, veja usedServices.

Pode ser null em caso de falta de permissão.

usedServices ([CardHolderService]) Serviços (benefícios) em uso pelo portador deste cartão.

Para listagem de todos os serviços disponíveis, veja availableServices.

Pode ser null em caso de falta de permissão.

bin (BIN) Informações do BIN do cartão.

BIN (Bank Identification Number ou Número de Identificação do Banco) elucida várias propriedades do cartão, muitas delas replicadas na própria interface do cartão para facilidade de acesso.

Pode ser null em caso de falta de permissão.

funding (CardFunding) Qual o financiamento do cartão: Crédito, Débito ou Múltiplo (ambos)

Pode ser null em caso de falta de permissão.

product (CardProduct) Produto associado ao Cartão.

Cada cartão é associado a um tipo de produto. Por exemplo os cartões Elo utilizam os produtos:

  • Básico
  • Clássico
  • Corporativo
  • Grafite
  • Nanquim
  • Viagem
  • Pré-pago

    Pode ser null em caso de falta de permissão.

isInternational (Boolean) Diz se o cartão é de uso internacional.

Se true, então o cartão é de uso internacional e doméstico. Se false, então o cartão só permite uso doméstico.

Pode ser null em caso de falta de permissão.

isCompany (Boolean) Diz se o cartão é corporativo (pessoa jurídica) ou pessoa física.

Se true, então o cartão é corporativo, ou seja, pessoa jurídica. Se false, então o cartão é para pessoas físicas.

Pode ser null em caso de falta de permissão.

isToken (Boolean) Diz se o cartão é virtual (token, vide CardToken).

Tokens são muitas vezes compreendidos como "cartões virtuais" (VCN - Virtual Card Numbers), eles são associados a um cartão real e podem ter maior controle, como restrição de moeda, número de compras, valor das compras, categoria de comerciante e outros.

O maior uso de tokens é para reduzir problemas com segurança, seja de um comerciante ou portador.

Se true, então este BIN é utilizado para tokens ao invés de cartões físicos (plástico). Se false então este BIN é utilizado para cartões tradicionais, físicos (plástico).

Pode ser null em caso de falta de permissão.

brand (CardBrand) Bandeira do Cartão

A bandeira responsável pelo Cartão. Para cartões da Elo, sempre será Elo.

Pode ser null em caso de falta de permissão.

allowedCaptures ([CardCapture]) Modos de captura permitidos para o cartão.

Esta lista diz quais os modos de captura são permitidos para o cartão, por exemplo se POS então pode ser utilizado num ponto de venda (Point Of Sale), caso contrário ao tentar utilizá-lo com tal irá resultar em transação rejeitada.

Pode ser null em caso de falta de permissão.

usages ([CardUsage]) Usos permitidos permitidos para o cartão.

Esta lista diz se o cartão pode ser utilizado para débito, para crédito à vista, crédito parcelado pela loja, dentre outros.

Pode ser null em caso de falta de permissão.

network (CardNetwork) Rede para uso do Cartão.

Cada cartão deve ser utilizado em uma rede, a qual é listada neste campo. Por exemplo os cartões Elo utilizam as redes:

  • Elo: uso doméstico (isInternational = false);
  • Elo-Discovery: uso internacional.

    Pode ser null em caso de falta de permissão.

issuer (CardIssuer) Emissor do cartão.

Todo BIN está associado a um e apenas um emissor, o qual pode ser consultado com este campo para obtenção do identificador global único, razão social, nome fantasia, CNPJ, endereço, contatos e afins.

Pode ser null em caso de falta de permissão.

metadata (CardMetadata) Metadados para apresentação do cartão ao usuário.

Metadados tais como:

  • imagem
  • cores Estes deverão ser utilizados para apresentação de um cartão ao usuário de modo a esclarecer a informação e evitar erros.

    Pode ser null em caso de falta de permissão.

transactions (CardTransactionsConnection) Consulta transações deste cartão.

A consulta paginada permite obter transações deste cartão com um filtro opcional.

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

Pode ser null em caso de falta de permissão.

transactionsSummary ([CardTransactionCategorySummary]) Retorna lista de sumários de transações por categorias de comerciante.

Ao invés de retornar todas as transações e seus campos conforme disponível em transactions(), esta consulta segmenta por MCC e retorna uma entrada por cada categoria, com o número de transações e o valor final em BRL (R$).

Note que apenas transações aprovadas são listadas.

fraudTransactions (CardFraudTransactionsConnection)

queueFraudTransactions (CardFraudTransactionsConnection)

Validade do cartão: Mês e Ano

Parâmetros de entrada

month (Int!) Mês - Janeiro é 1, Dezembro é 12

year (Int!) Ano - 4 dígitos, exemplo: 2017, não 17.

Informações sobre como o cartão ou token podem ser usados.

Observe que as restrições do cartão ou token podem ser especificadas no momento de criação usando CardUsageConstraintsInput. Emissores, cartões e produtos podem impor restrições extras.

Parâmetros de entrada

maxUsage (Int) Número de vezes que o cartão pode ser usado.

-1 significa ilimitado null significa uso não definido.

expiry (DateTime) Uso é permitido até a data e horário de validade

allowedTxAmounts ([CardCurrencyRange]) Quantias permitidas por transações permitidas (TX) como limites por moedas.

Cada moeda será listada no máximo uma vez.

Nenhuma conversão de moedas é executada. Se uma moeda não é listada, é porque não é autorizada.

Se null, é ilimitada.

allowedMerchants ([Merchant]) Lista de comerciantes autorizados.

Se null, é ilimitada.

allowedMerchantCategories ([MerchantCategory]) Categorias de comerciantes autorizadas.

Se null, é ilimitada.

Se não-nula, então é a lista completa de categorias permitidas após aplicar filtros definidos por solicitantes, emissor e restrições de produto.

deniedMerchantCategories ([MerchantCategory]) Categorias de comerciantes proibidas.

Se null, é ilimitada.

Se não-nula, então é a lista completa de categorias proibidas após aplicar filtros definidos por solicitantes, emissor e restrições de produto.

Declara limites operacionais para uma moeda.

Parâmetros de entrada

currency (String!) Código da moeda com 3 letras (ISO4217) Exemplo: EUR, USD, BRL...

min (Float) Valor mínimo ou null para ilimitado.

max (Float) Valor máximo ou null para ilimitado.

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

Parâmetros de entrada

id (ID!) Identificador Global Único para o objeto.

name (String!) Nome visível publicamente. Normalmente nome bem conhecido, marca, etc.

legalName (String!) Nome legal, como escrito em documentos.

description (String) Descrição da empresa para ser apresentado a usuários.

image (ImageUrl) URL da imagem. 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.

legalIds (CompanyLegalIds!) Todos os documentos legais de identificação da empresa.

contacts (CompanyContact!) Contatos da empresa.

addresses (Address!) Endereço físico da empresa.

url (String) Endereço Virtual (Uniform Resource Locator).

categories (MerchantCategory!) Categorias de comerciantes (Código ISO, nome)

transactionFees ([MerchantTransactionFees]) 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 (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.

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

Parâmetros de entrada

cnpj (CNPJ)

Ítem de contato com a empresa, como email ou telefone...

Parâmetros de entrada

type (CompanyContactType!) 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!) Valor do contato. Exemplos: +12345678 para telefone, `user@server.com` para email, etc.

Categoria de comerciantes

A Categoria de Comerciante é associada a um código ISO18245 de 4 dígitos disponível no membro iso.

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto.

iso (Int!) Código ISO18245.

Também conhecido como MCC (Merchant Category Code), tem 4 dígitos.

name (String!) Nome da categoria de comerciante.

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 (ImageUrl) URL da imagem. 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.

transactionFees ([MerchantTransactionFees]) Preços de Transações para a Categoria de Comerciante.

As taxas e custos são associados a um uso (i.e: Crédito à vista, Crédito parcelado pela loja...) e tem uma validade, ou seja, são dinâmicos e podem ser consultados para esta categoria.

Note que alguns comerciantes possuem custos de transação específicos, negociados individualmente. Para estes deve-se consultar o comerciante e então seus preços diretamente via API com merchant(legalIds: {cnpj: X}) { transactionFees }, utilizando os valores da categoria aqui retornados apenas para comerciantes sem preços específicos.

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.

merchants (MerchantsConnection) Consulta comerciantes (Merchant) nesta categoria.

Custos de Transação ao Comerciante.

Baseado no tipo de uso (i.e: Crédito à vista, Crédito parcelado pela loja...) e número de parcelas o comerciante terá que pagar uma taxa à bandeira e ao credenciador. Recomenda-se que o usuário sempre considere cardUsage, installmentsRange e expiry em todas as consultas.

Exemplo de listagem:

  • cardUsage: 70, installmentsRange: null.
  • cardUsage: 71, installmentsRange: null.
  • cardUsage: 72, installmentsRange { min: 1, max: 6 }.
  • cardUsage: 72, installmentsRange { min: 7, max: 12 }.

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

O cálculo do valor final a ser pago é feito e esclarecido na consulta calc.

Parâmetros de entrada

cardUsage (CardUsage!) Os custos de transação se referem a este uso.

Por exemplo:

  • Crédito à vista = 70
  • Débito = 71
  • Crédito parcelado pela loja = 72

Note que para produtos parcelados, como 72, serão retornadas diversas entradas com o mesmo cardUsage, porém com faixas de parcelamento diferentes em installmentsRange. Por exemplo se as tarifas para parcelamento de 1 à 6 são diferentes que parcelamentos de 7 à 12, então teríamos duas entradas com o mesmo cardUsage, sendo que cada uma terá installmentsRange diferente:

  • cardUsage: 72, installmentsRange { min: 1, max: 6 }.
  • cardUsage: 72, installmentsRange { min: 7, max: 12 }.

installmentsRange (IntRange) A faixa de parcelas a qual estes custos de transação se referem.

Para cardUsage que permite parcelamento, será retornado a faixa de parcelas a qual estes custos se aplicam. Por exemplo se as tarifas para parcelamento de 1 à 6 são diferentes que parcelamentos de 7 à 12, então teríamos duas entradas com o mesmo cardUsage, sendo que cada uma terá installmentsRange diferente:

  • cardUsage: 72, installmentsRange { min: 1, max: 6 }.
  • cardUsage: 72, installmentsRange { min: 7, max: 12 }.

Para cardUsage que não permite parcelamento, será retornado null.

lastModified (DateTime!) Data e horário da última modificação.

expiry (DateTime) Data e horário que limitam a vigência do valor, ou seja.

marketingFee (Float!) Percentual a ser pago para a tarifa de desenvolvimento da bandeira e marketing.

Caso marketingFeeCeilValue seja não-nulo, então especifica um teto em BRL (R$) pra limitar o valor final a ser pago.

marketingFeeCeilValue (Float) Teto do custo da tarifa de desenvolvimento da bandeira e marketing, em BRL (R$).

Caso seja não-nulo, após aplicar marketingFee ao valor da compra deve-se limitar o valor final em BRL (R$) ao montante especificado.

acquiringServiceFee (Float!) Percentual a ser pago para desenvolvimento e suporte de produtos ao credenciador.

Caso acquiringServiceFeeCeilValue seja não-nulo, então especifica um teto em BRL (R$) pra limitar o valor final a ser pago.

acquiringServiceFeeCeilValue (Float) Teto do custo da tarifa de desenvolvimento e suporte de produtos ao credenciador da transação, em BRL (R$).

Caso seja não-nulo, após aplicar acquiringServiceFee ao valor da compra deve-se limitar o valor final em BRL (R$) ao montante especificado.

processingCost (Float!) Tarifa de processamento na mensageria de autorizações, em BRL (R$).

Este valor é fixo para este uso (cardUsage), independente do valor ou número de parcelas.

additionalInstallmentCost (Float) Tarifa adicional para cada parcela, em BRL (R$).

Para uso parcelado, por exemplo cardUsage 72 (crédito parcelado pela loja), cada parcela deve pagar este custo adicional.

Ou seja, para uma compra em 3 parcelas, paga-se 2 * additionalInstallmentCost.

Para cardUsage que não permite parcelamento, será retornado null.

calc (MerchantTransactionFeesCalc!) Calcula o custo final em BRL (R$) a ser pago para uma transação de transactionValue realizada em installments parcelas com o uso retornado no campo cardUsage.

Esta consulta é um utilitário que calcula:

let marketingCost = transactionValue * marketingFee;
if (marketingFeeCeilValue && marketingCost > marketingFeeCeilValue) {
   marketingCost = marketingFeeCeilValue;
}

let acquiringServiceCost = transactionValue * acquiringServiceFee;
if (acquiringServiceFeeCeilValue && acquiringServiceCost > acquiringServiceFeeCeilValue) {
   acquiringServiceCost = acquiringServiceFeeCeilValue;
}

let installmentsCost = 0.0;
if (installments && installments > 1) {
   installmentsCost = (installments - 1) * additionalInstallmentCost;
}

let totalCost = processingCost + installmentsCost + marketingCost + acquiringServiceCost;

Uso de um Cartão.

Define como as compras poderão ser realizadas, por exemplo:

  • Crédito à Vista
  • Débito
  • Parcelado pela loja

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto

name (String!) Nome do Uso

code (Int!) Código Bancário do Uso

Nos sistemas tradicionais pode ser necessário transitar o código do uso, que é fornecido por este número.

Por exemplo:

  • Crédito à Vista = 70
  • Débito = 71
  • Parcelado Loja = 72

Define uma faixa de números inteiros.

Tanto min quanto max são inclusos na faixa. Ou seja:

  • min: 10, max: 12 define os números: 10, 11 e 12;
  • min: 100, max: 100 define apenas o número 100.

Parâmetros de entrada

min (Int!) Número mínimo (inicial), incluso na faixa.

max (Int!) Número máximo (final), incluso na faixa.

Retorno do cálculo de custo final em BRL (R$) a ser pago para uma transação.

Veja a consulta MerchantTransactionFees { calc } para detalhes do cálculo.

Parâmetros de entrada

cardUsage (CardUsage!) Os custos de transação se referem a este uso.

Por exemplo:

  • Crédito à vista = 70
  • Débito = 71
  • Crédito parcelado pela loja = 72

É o mesmo que MerchantTransactionFees { cardUsage }, retornado aqui apenas para facilitar o uso.

expiry (DateTime) Data e horário que limitam a vigência do valor, ou seja.

É o mesmo que MerchantTransactionFees { expiry }, retornado aqui apenas para facilitar o uso.

installments (Int!) Número de parcelas considerado.

Caso o uso (cardUsage) se não permita parcelamento, será retornado 1.

Caso o uso (cardUsage) permita parcelamento, porém o parâmetro de cálculo seja fora da faixa, será retornado o número de parcelas que melhor se aproxima. Por exemplo:

  • calc(installments: 10) e installmentsRange {min: 1, max: 5} irá retornar installments: 5.
  • calc(installments: 3) e installmentsRange {min: 6, max: 12} irá retornar installments: 6.

Caso o número de parcelas especificadas para o cálculo esteja dentro da faixa, então será retornado o valor especificado, inalterado.

totalCost (Float!) Valor final a ser pago em tarifas para a transação, em BRL (R$).

É equivalente à soma dos demais custos..

processingCost (Float!) Tarifa de processamento na mensageria de autorizações, em BRL (R$).

Este valor é fixo para este uso (cardUsage), independente do valor ou número de parcelas.

É o mesmo que MerchantTransactionFees { processingCost }, retornado aqui apenas para facilitar o uso.

installmentsCost (Float!) Tarifa adicional por parcelamento, em BRL (R$).

Este valor resulta do additionalInstallmentCost aplicado a cada parcela adicional.

Para cardUsage que não permite parcelamento, será retornado zero (0.0).

marketingCost (Float!) Valor a ser pago para a tarifa de desenvolvimento da bandeira e marketing, em BRL (R$).

Valor final já calculado à partir do transactionValue e marketingFee, considerando marketingFeeCeilValue.

acquiringServiceCost (Float!) Valor a ser pago para desenvolvimento e suporte de produtos ao credenciador, em BRL (R$).

Valor final já calculado à partir do transactionValue e acquiringServiceFee, considerando acquiringServiceFeeCeilValue.

Conexão de comerciante (Merchant) em conformidade com o Relay.

Parâmetros de entrada

pageInfo (PageInfo!) Cursor opaco para ser usado com queries (consultas) after ou before.

edges ([MerchantsEdge]) Lista de arestas que compõem esta conexão.

totalCount (Int) Contagem total de objetos nesta conexão.

Arestas são limitadas a cursores before e after, assim como primeiras e últimas contagens. Assim o tamanho de arestas é possivelmente menor que a conexão como um todo.

totalCount, se não for null, indica o número total de itens na conexão considerando-se o filtro.

Aresta de conexão contendo um comerciante (Merchant) em conformidade com o Relay.

Parâmetros de entrada

cursor (String!) Cursor opaco para ser usado com queries (consultas) after ou before.

node (Merchant) O objeto Merchant que compõe essa aresta de conexão.

Conexão de CardTransaction em conformidade com o Relay.

Parâmetros de entrada

pageInfo (PageInfo!) Cursor opaco para ser usado com queries (consultas) after ou before.

edges ([CardTransactionsEdge]) Lista de arestas que compõem esta conexão.

totalCount (Int) Contagem total de objetos nesta conexão.

Arestas são limitadas a cursores before e after, assim como primeiras e últimas contagens. Assim o tamanho de arestas é possivelmente menor que a conexão como um todo.

totalCount, se não for null, indica o número total de itens na conexão considerando-se o filtro.

Aresta de conexão contendo um CardTransaction em conformidade com o Relay.

Parâmetros de entrada

cursor (String!)

Cursor opaco para ser usado com queries (consultas) after ou

before.

node (CardTransaction) O objeto CardTransaction que compõe essa aresta conexão.

Representa uma transação de cartão.

As transações são retornadas em consultas derivadas (enraizadas) em outros tipos mais específicos, tais como:

  • CardInterface { transactions }: transações de um cartão específico.
  • Merchant { cardTransactions }: transações de um dado comerciante.

Todas as consultas são sujeitas às permissões de acesso:

  • Um comerciante (Merchant) não tem permissão para transações de outros comerciantes.
  • Um portador (CardHolder) não tem permissão para transações de outros portadores.

As consultas também são filtradas implicitamente pelas permissões de acesso, ou seja:

  • Um comerciante ao consultar as transações de um dado cartão, só receberá em retorno suas próprias transações e não de outros comerciantes.
  • Um portador ao consultar as transações de um dado comerciante, só receberá em retorno suas próprias transações e não de outros portadores.

O acesso direto via node(id) também é sujeito às mesmas permissões, só entidades relacionadas (comerciante ou portador) podem ter acesso à transação.

Ao Implementador: internamente guarde o hash do cartão (Card) ou token (CardToken) (não os retorne em consulta direta). Ao fazer a busca por CardInterface { transactions }, caia sempre para o mesmo código, à partir do hash (utilizando o valor armazenado internamente).

Para Merchant, sempre faça a o filtro conter a lista merchants com apenas o seu próprio id.

Se utilizar Cassandra ou NoSQL, precisa desnormalizar a tabela em:

  • Por hash;
  • Por MerchantId (comerciante);
  • Por MCC (código da categoria). Como comerciantes têm no mínimo 1 MCC, pode-se fazer como compound key de MCC, MerchantId. Ao listar o comerciante liste todos os seus MCC... em geral vai ser apenas 1. Neste caso não precisa desnormalizar por Merchant, apenas MCC, MerchantId

Para encadear consultas, como no caso de CardHolder descrito acima, cuidado com paginação. Se fizer numa consulta só, a paginação deve vir de "graça".

Campos informativos são altamente repetidos e não precisam estar nas tabelas desnormalizadas. Apenas referencie o id e então mantenha um cache local. Por exemplo CardCapture, CardUsage e BIN.

Caso replique os campos informativos, não os atualize com atualizações no campo original, seria até mais correto manter o snapshot do momento em que a transação foi registrada. Por exemplo o BIN poderia ser associado a um produto naquele momento e o BIN foi reciclado, utilizando outro produto.

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto.

capture (CardCapture!) Como o cartão foi capturado na transação (i.e: POS, TEF, Internet...)

usage (CardUsage!) Como o cartão foi utilizado (i.e: Crédito à vista, Débito...)

bin (BIN) Informações do BIN do cartão.

BIN (Bank Identification Number ou Número de Identificação do Banco) elucida várias propriedades do cartão, como se é corporativo, internacional, se é um token, qual o emissor (CardIssuer), dentre outros.

Pode ser null em caso de falta de permissão.

merchant (Merchant!) O comerciante que realizou a transação.

Possui campos como razão social, nome fantasia, documentos legais (CNPJ) e categorias (MCC).

currency (String!) Código da moeda com 3 letras (ISO4217) Exemplo: EUR, USD, BRL...

value (String!) Valor total da transação

A moeda é especificada em currency. A compra pode ter sido parcelada conforme installments.

installments (Int!) Número de parcelas.

Caso a compra não tenha sido parcelada, será 1.

status (CardTransactionStatus) Estado da transação

timestamp (DateTime!) Quando a transação ocorreu.

Modo de captura (entrada) do cartão.

O modo de captura define como o cartão pode ser utilizado, exemplos tradicionais:

  • POS (Point of Sale, ou Ponto de Venda)
  • TEF (Transferência Eletrônica de Fundos)
  • Internet (lojas virtuais, e-commerce)
  • Telemarketing (centrais de venda por telefone)
  • ATM (Automated Teller Machine, ou Caixa Eletrônico)

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto

name (String!) Nome da Captura

code (Int!) Código Bancário da Captura

Nos sistemas tradicionais pode ser necessário transitar o código da captura, que é fornecido por este número.

Por exemplo:

  • POS = 1
  • TEF = 2
  • Internet = 3
  • Telemarketing = 4
  • ATM = 5

Representa um BIN (Bank Identification Number ou Número de Identificação do Banco) no sistema.

O BIN é relativo aos números iniciais de um cartão e identifica o emissor e produtos associados ao mesmo.

Cada bandeira tem faixas de BIN reservadas a seu uso, estas estão disponíveis como reserved na consulta binTable.

Porém o maior interesse é por BIN em uso (alocados), o qual carregará informações sobre o emissor (banco), financiamento (funding, se crédito, débito ou ambos), produtos (pagamentos à prazo, pré-pago, Cartão para construção civil - Construcard...) e mesmo serviços como emissão de seguros ou acesso à WiFi.

A tabela de BIN é dinâmica:

  • Conforme os cartões de um mesmo prefixo (BIN) vão sendo inutilizados e ficam sem usuários, o BIN pode ser então reciclado para um novo uso.

  • Conforme novos produtos são inseridos, um BIN previamente reservado e sem usuários será então alocado, entrando em uso.

Por isso é importante manter a tabela de BIN atualizada, vide consulta binTable. Para saber se a tabela foi atualizada utilize os campos de nome similares ao HTTP lastModified (data e horário da última modificação) e etag (entity tag ou etiqueta da entidade), que oferece um identificador único sobre a tabela, se ele mudou então a tabela mudou.

Parâmetros de entrada

number (String!) Número desta entrada, único na tabela.

O tamanho do número em caracteres define o tamanho do prefixo utilizado. No passado os BINs eram de apenas 4, hoje são de 6 dígitos, porém o mercado está migrando para até 9 dígitos nos próximos anos. Logo utilize a quantidade de dígitos parametrizada no seu código!

Veja também panSizeRange, afinal quando o tamanho do prefixo muda, em geral muda-se também o tamanho total do cartão.

panSizeRange (IntRange!) Define os tamanhos de número de cartão (PAN) necessários para este BIN. O número do cartão (PAN - Primary Account Number) tem em geral tamanho de 16 dígitos, sendo retornado como min: 16, max: 16.

Porém devido à necessidade de mais cartões disponíveis, o mercado está gradualmente migrando para mais dígitos -- espera-se que num futuro próximo chegue até a 19.

Ao pedir e validar entrada do usuário, encontre um BIN válido para o prefixo e então verifique este campo para saber se o número de dígitos está correto.

funding (CardFunding!) Qual o financiamento do cartão: Crédito, Débito ou Múltiplo (ambos).

product (CardProduct!) Produto associado ao Cartão.

Cada cartão é associado a um tipo de produto. Por exemplo os cartões Elo utilizam os produtos:

  • Básico
  • Clássico
  • Corporativo
  • Grafite
  • Nanquim
  • Viagem
  • Pré-pago

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

País de origem do cartão, ou seja, onde é domiciliado -- é considerado doméstico.

O cartão só poderá ser utilizado neste país caso isInternational for false.

isInternational (Boolean!) Diz se o cartão é de uso internacional. Se true, então o cartão é de uso internacional e doméstico. Se false, então o cartão só permite uso doméstico e só poderá ser utilizado no país especificado em country.

regexp (String!) Expressão Regular que identifica este BIN em particular. A expressão regular retornada irá identificar o BIN (number) e o número de dígitos relativos ao panSizeRange.

Por exemplo, para o number: "509069" com panSizeRange: { min: 16, max: 16 } a expressão regular será: ^509069\d{10}$. Já para um fictício number: "12345678" com panSizeRange: { min: 17, max: 19}, a expressão regular será ^12345678\d{9,11}$

isCompany (Boolean!) Diz se o cartão é corporativo (pessoa jurídica) ou pessoa física.

Se true, então o cartão é corporativo, ou seja, pessoa jurídica. Se false, então o cartão é para pessoas físicas.

isToken (Boolean!) Diz se o cartão é virtual (token, vide CardToken).

Tokens são muitas vezes compreendidos como "cartões virtuais" (VCN - Virtual Card Numbers), eles são associados a um cartão real e podem ter maior controle, como restrição de moeda, número de compras, valor das compras, categoria de comerciante e outros.

O maior uso de tokens é para reduzir problemas com segurança, seja de um comerciante ou portador.

Se true, então este BIN é utilizado para tokens ao invés de cartões físicos (plástico). Se false então este BIN é utilizado para cartões tradicionais, físicos (plástico).

brand (CardBrand!) Bandeira do Cartão

A bandeira responsável pelo Cartão. Para cartões da Elo, sempre será Elo.

allowedCaptures (CardCapture!) Modos de captura permitidos para o cartão.

Esta lista diz quais os modos de captura são permitidos para o cartão, por exemplo se POS então pode ser utilizado num ponto de venda (Point Of Sale), caso contrário ao tentar utilizá-lo com tal irá resultar em transação rejeitada.

usages (CardUsage!) Usos permitidos permitidos para o cartão.

Esta lista diz se o cartão pode ser utilizado para débito, para crédito à vista, crédito parcelado pela loja, dentre outros.

network (CardNetwork!) Rede para uso do Cartão.

Cada cartão deve ser utilizado em uma rede, a qual é listada neste campo. Por exemplo os cartões Elo utilizam as redes:

  • Elo: uso doméstico (isInternational = false);
  • Elo-Discovery: uso internacional.

issuer (CardIssuer!) Emissor do cartão.

Todo BIN está associado a um e apenas um emissor, o qual pode ser consultado com este campo para obtenção do identificador global único, razão social, nome fantasia, CNPJ, endereço, contatos e afins.

metadata (CardMetadata!) Metadados para apresentação do cartão ao usuário.

Metadados tais como:

  • imagem
  • cores Estes deverão ser utilizados para apresentação de um cartão ao usuário de modo a esclarecer a informação e evitar erros.

services (CardHolderService!) Serviços (benefícios) disponíveis ao portador do cartão.

Os serviços, também conhecidos como benefícios, ao portador. Por exemplo:

  • Seguro Viagem, para compra de passagens aéreas;
  • Proteção de Compra, para compra de bens;
  • Garantia Estendida, para compra de bens;
  • Acesso ao WiFi.

Informação de produto associado ao cartão

Cada cartão é relacionado a um produto. No caso da Elo, exemplos de produto são:

  • Básico
  • Clássico
  • Corporativo
  • Grafite
  • Nanquim
  • Viagem
  • Pré-pago

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto

code (CodeProduct!) Código que identifica produto.

name (String!) Nome do produto.

Exemplos de Produtos Elo:

  • Básico
  • Clássico
  • Corporativo
  • Grafite
  • Nanquim
  • Viagem
  • Pré-pago

image (ImageUrl) URL da imagem. 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.

url (String) URL do produto

Bandeira (marca) do cartão

A bandeira do cartão atualmente retorna Elo.

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto

name (String!) Nome da bandeira

image (ImageUrl) URL da imagem. 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.

url (String) URL da bandeira

Rede para utilização do Cartão

Cada cartão deve ser utilizado em uma rede, por exemplo para cartões Elo:

  • Elo para cartões domésticos;
  • Elo-Discovery para cartões internacionais.

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto

name (String!) Nome da Rede

Exemplos para Elo:

  • Elo para cartões domésticos;
  • Elo-Discovery para cartões internacionais.

image (ImageUrl) URL da imagem. 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.

url (String) URL da rede

Entidade do Emissor de Cartão

Parâmetros de entrada

id (ID!) Identificador Global Único para o objeto.

name (String!) Nome visível publicamente. Normalmente nome bem conhecido, marca, etc.

legalName (String!) Nome legal, como escrito em documentos.

description (String) Descrição da empresa para ser apresentado a usuários.

image (ImageUrl) URL da imagem. 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.

legalIds (CompanyLegalIds!) Todos os documentos legais de identificação da empresa.

contacts (CompanyContact!) Contatos da empresa.

addresses (Address!) Endereço físico da empresa.

url (String) Endereço Virtual (Uniform Resource Locator).

cards (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.

Metadados de cartão: como representar o cartão visualmente

Parâmetros de entrada

image (ImageUrl) URL da imagem. 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.

backgroundColor (String) Cor de fundo (background) em notação web padrão: #ffffff (branco), #ff0000 (vermelho), #00ff00 (verde), #0000ff (azul). Deve ser usado em conjunto com foregroundColor quando não é possível usar imagem.

foregroundColor (String) Cor de primeiro plano (foreground) em notação web padrão: #ffffff (branco), #ff0000 (vermelho), #00ff00 (verde), #0000ff (azul). Deve ser usado em conjunto com backgroundColor quando não é possível usar imagem.

issuer (String) Emissor de cartão, i.e.: "Um Banco" Deve ser usado quando não é possível utilizar imagem.

É o mesmo que consultar o BIN { issuer { name } }

brand (String) Bandeira do cartão, i.e: Elo Deve ser usado quando não é possível utilizar imagem.

É o mesmo que consultar o BIN { brand { name } }

product (String) Nome do produto associado ao cartão, i.e.: Nanquim, Grafite.

É o mesmo que consultar o BIN { product { name } }

Serviço disponível ao portador do cartão.

A Elo oferece aos portadores serviços como acesso à internet, estes são representados por este tipo.

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto

name (String!) Nome do serviço

description (String) Descrição do serviço

image (ImageUrl) URL da imagem. 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.

url (String) URL do serviço

discounts (Discounts) Percentual de descontos

Informa o percentual de descontos (ex: 100% de desconto, 50% de desconto, ou se não tem desconto)

Parâmetros de entrada

holderOrAdditional (Int) Percentual de desconto aplicado para o portador ou adicional.

companion (Int) Percentual de desconto aplicado ao acompanhante.

Sumário de Transações de Cartão para uma Categoria de Comerciante

Parâmetros de entrada

category (MerchantCategory!) Categoria deste sumário

count (Int!) Número de transações nesta categoria

value (String!) Valor total das transações em BRL (R$) nesta categoria

Conexão de CardFraudTransaction em conformidade com o Relay.

Parâmetros de entrada

pageInfo (PageInfo!) Cursor opaco para ser usado com queries (consultas) after ou before.

edges ([CardFraudTransactionsEdge]) Lista de arestas que compõem esta conexão.

totalCount (Int) Contagem total de objetos nesta conexão.

Arestas são limitadas a cursores before e after, assim como primeiras e últimas contagens. Assim o tamanho de arestas é possivelmente menor que a conexão como um todo.

totalCount, se não for null, indica o número total de itens na conexão considerando-se o filtro.

Aresta de conexão contendo um CardFraudTransaction em conformidade com o Relay.

Parâmetros de entrada

cursor (String!) Cursor opaco para ser usado com queries (consultas) after ou before.

node (CardFraudTransaction) O objeto CardFraudTransaction que compõe essa aresta conexão.

Representa uma transação fraudulenta de cartão.

Parâmetros de entrada

cardTransaction (CardTransaction!) Dados da Transação fraudulenta.

last4 (String) Últimos 4 dígitos do cartão, para ser mostrado ao usuário

authorization (Authorization!) Dados da autorização

status (CardFraudTransactionStatus!) Estado da transação fraudulenta

reference (String) Número de referência do Banknet.

codePos (ID!) Código que identifica o PDV.

liability (LiabilityType) Identifica o responsável pela transação fraudulenta.

codeEic (Int!) Identificar o código 3D Secure específico aplicável.

flaggedAt (DateTime) Data que o cartão foi cancelado após ser confirmado como fraude pelo titular do cartão.

arn (Int!) Número de referença do adquirente, são 23 números unicos que marcam a transação do cartão quando ela vai da processadora para o emissor. Somente esta disponivel para transações finalizadas. Esta campo é util para estabelecimentos comerciais para fazer o de-para do alerta como a transação original, especialmente quando existem multiplas transações no mesmo cartão e no mesmo estabelecimento comercial com o mesmo valor e na mesma hora.

initiated (InitiatedType!) Identificar quem detectou a fraude.

settled (Date!) Data que a transação foi liquidada (se já liquidada).

Dados da autorização de uma transação

Parâmetros de entrada

date (DateTime!) Data da autorização da transação.

code (ID!) Código da autorização da transação.

decision (String!) Descrição da autorização da transação.

Conexão de TravelInsurance em conformidade com o Relay.

Parâmetros de entrada

pageInfo (PageInfo!) Cursor opaco para ser usado com queries (consultas) after ou before.

edges ([TravelInsurancesEdge]) Lista de arestas que compõem esta conexão.

totalCount (Int) Contagem total de objetos nesta conexão.

Arestas são limitadas a cursores before e after, assim como primeiras e últimas contagens. Assim o tamanho de arestas é possivelmente menor que a conexão como um todo.

totalCount, se não for null, indica o número total de itens na conexão considerando-se o filtro.

Aresta de conexão contendo um TravelInsurance em conformidade com o Relay.

Parâmetros de entrada

cursor (String!) Cursor opaco para ser usado com queries (consultas) after ou before.

node (TravelInsurance) O objeto TravelInsurance que compõe esta aresta de conexão.

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.

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto.

cardHolder (CardHolder!) 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!) O BIN (Bank Identification Number) referente ao cartão que ofereceu o seguro.

O serviço (benefício) de seguro é oferecido para determinados produtos (i.e: Cartões Elo Nanquim), o qual é determinado pelo seu BIN.

merchant (MerchantInsurance) Informações do comerciante.

journey (Journey!) Dados da Viagem.

startDate (Date!) A data inicial da cobertura.

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

endDate (Date!) 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!) Seguradora responsável pelo seguro.

Parâmetros de entrada

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

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

name (String!) Nome Fantasia do Comerciante

legalName (String!) Razão Social do Comerciante

Dados da viagem.

Parâmetros de entrada

companyTravel (String) Companhia responsável pela viagem.

journeyLocator (String!) Número de Confirmação.

trips (Trip!) Trechos da vigem (Possíveis escalas).

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

Trechos da vigem (Possíveis escalas).

Parâmetros de entrada

tripNumber (Int!) Identificador Global Único do trecho da viagem.

tripLocator (String!) Número de Confirmação.

type (TripType!) Identifica o tipo de viagem.

departure (Layover!) Informações da saída da escala.

arrival (Layover!) Informações da chegada da escala.

travelers (TravelInsuranceTraveler!) Dados do(s) Viajante(s) a qual este seguro se refere.

Para emissão de seguro informar os dados de todos os viajantes, informe todos os campos obrigatórios.

Informações da escala.

Parâmetros de entrada

IataCode (String) IATA - Associação Internacional de Transportes Aéreos

Caso o tipo da viagem seja aérea, esse campo deve ser informado.

Exemplo: GRU - Guarulhos/SP

IcaoCode (String) ICAO ou OACI - Organização da Aviação Civil Internacional

Exemplo: SBGR - Guarulhos/SP

city (String!) Nome da Cidade.

country (String!) País da viagem. Código do país com 3 letras (ISO3166-alpha3). Exemplos: USA, BRA...

dateTime (DateTime!) Data e hora da escala. Seguindo o formato estendido ISO 8601: Exemplo: "2017-06-01T12:00:00-03:00"

Viajante do Seguro Viagem

Parâmetros de entrada

insurances ([InsuranceTraveler]) Lista de Seguro viagem contratados.

legalIds (InsuranceLegalIds!) Todos os documentos legais de identificação do viajante.

name (String!) Nome completo do viajante como no documento oficial (CPF).

birthday (Date!) Data de nascimento.

gender (Gender!) Masculino ou Feminino, conforme documentos oficiais.

pregnancyWeeks (Int) Se feminino e estiver grávida, de quantas semanas.

Se masculino ou não estiver grávida, será null.

maritalStatus (MaritalStatus!) Estado civil.

occupation (PersonOccupation!) Profissão do viajante.

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.

income (PersonYearlyIncome!) Renda anual do viajante (individual e familiar).

address (Address!) Endereço do viajante.

contacts ([PersonContact]) Contatos do viajante.

politicalExposure (Boolean!) Pessoa Exposta Politicamente.

Dados de Seguro viagem contratados para viajante.

Parâmetros de entrada

insuranceId (ID!) Identificador Global Único de Seguro viagem contratados.

description (String!) Descrição do Produto

status (CardHolderInsuranceStatus!)

Toda a possível identificação legal de pessoa Física

Parâmetros de entrada

cpf (CPF!)

rg (RG)

Propósito (Motivo) da Viagem

Parâmetros de entrada

leisure (Boolean!) Se true, um dos propósitos da viagem é lazer.

business (Boolean!) Se true, um dos propósitos da viagem é negócios.

adventure (Boolean!) Se true, um dos propósitos da viagem é realizar atividades de aventura.

Atividades de aventura ou perigosas, tais como andar a cavalo, jet ski, bungee jump, rafting, canoagem ou ciclismo.

_("ExtendedWarrantyInsurancesConnection")

Parâmetros de entrada

pageInfo (PageInfo!) _("ExtendedWarrantyInsurancesConnection.pageInfo")

edges ([ExtendedWarrantyInsurancesEdge]) _("ExtendedWarrantyInsurancesConnection.edges")

totalCount (Int) _("ExtendedWarrantyInsurancesConnection.totalCount")

_("ExtendedWarrantyInsurancesEdge")

Parâmetros de entrada

cursor (String!) _("ExtendedWarrantyInsurancesEdge.cursor")

node (ExtendedWarrantyInsurance) _("ExtendedWarrantyInsurancesEdge.node")

Seguro de Garantia Estendida para portadores de cartão.

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto.

cardHolder (CardHolder!) O Portador do cartão ao qual o seguro se refere.

O serviço (benefício) de seguro é oferecido para determinados produtos (i.e: Cartões Elo Nanquim) ao portador do cartão.

bin (BIN!) O BIN (Bank Identification Number) referente ao cartão que ofereceu o seguro.

O serviço (benefício) de seguro é oferecido para determinados produtos (i.e: Cartões Elo Nanquim), o qual é determinado pelo seu BIN.

status (CardHolderInsuranceStatus!)

merchant (MerchantInsurance) Informações do comerciante.

startDate (Date!) A data inicial da cobertura.

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

endDate (Date!) 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 (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.

Categoria de Produtos para Seguros de Garantia Estendida

Parâmetros de entrada

id (ID!) Identificador opaco da categoria de produto.

Deve ser informado como entrada quando a categoria for requisitada.

display (String!) Texto a ser exibido ao usuário em formulários e consultas.

Este texto é localizado (traduzido) para a linguagem informada na consulta ou mutação

product (ProductCategory!) Produto segurado.

Produto coberto pelo seguro

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto.

display (String!) Texto a ser exibido ao usuário em formulários e consultas.

Conexão de PurchaseSecurityInsurance em conformidade com o Relay.

Parâmetros de entrada

pageInfo (PageInfo!) Cursor opaco para ser usado com queries (consultas) after ou before.

edges ([PurchaseProtectionInsurancesEdge]) Lista de arestas que compõem esta conexão.

totalCount (Int) Contagem total de objetos nesta conexão.

Arestas são limitadas a cursores before e after, assim como primeiras e últimas contagens. Assim o tamanho de arestas é possivelmente menor que a conexão como um todo.

totalCount, se não for null, indica o número total de itens na conexão considerando-se o filtro.

Aresta de conexão contendo um PurchaseSecurityInsurance em conformidade com o

Relay.

Parâmetros de entrada

cursor (String!) Cursor opaco para ser usado com queries (consultas) after ou before.

node (PurchaseProtectionInsurance) O objeto PurchaseSecurityInsurance que compõe esta aresta de conexão.

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

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto.

cardHolder (CardHolder!) O Portador do cartão ao qual o seguro se refere.

O serviço (benefício) de seguro é oferecido para determinados produtos (i.e: Cartões Elo Nanquim) ao portador do cartão.

merchant (MerchantInsurance) Informações do comerciante.

bin (BIN!) O BIN (Bank Identification Number) referente ao cartão que ofereceu o seguro.

O serviço (benefício) de seguro é oferecido para determinados produtos (i.e: Cartões Elo Nanquim), o qual é determinado pelo seu BIN.

status (CardHolderInsuranceStatus!)

startDate (Date!) A data inicial da cobertura.

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

endDate (Date!) 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!) 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 (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!) Marca do Produto

model (String!) Modelo do Produto

description (String!) Descrição do Produto

value (Float!) Valor do Produto

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

_t("PurchaseProtectionProductCategory")

Parâmetros de entrada

id (ID!) _t("PurchaseProtectionProductCategory.id")

display (String!) _t("PurchaseProtectionProductCategory.display")

product (ProductCategory!) Produto segurado.

Node compatível com Relay.

Parâmetros de entrada

id (ID!) Identificador Global Único para este objeto

Interface que todo estado de cartão (CardStatus) deve implementar

Parâmetros de entrada

status (CardStatus!) O estado

Opções de gênero

Parâmetros de entrada

FEMALE

MALE

Opções de estado civil

Parâmetros de entrada

DIVORCED Divorciado

MARRIED Casado

COMMON_LAW_MARRIED União Estável

SINGLE Solteiro

WIDOWED Viúvo

Tipo de contato com pessoa física.

Parâmetros de entrada

PHONE o valor é um número de telefone, celular ou fax

EMAIL o valor é um e-mail

IM aplicativo de mensagens instantâneas O valor é um identificador de usuário com o campo de contexto

OTHER valor que segue texto livre

Estados de verificação.

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

Parâmetros de entrada

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.

Estado do cartão

Cada estado possui seu próprio payload em implementações específicas de CardStatusInterface. Use fragmentos para consultar seus campos.

Parâmetros de entrada

INACTIVE Cartão não foi ativado

ACTIVE Cartão foi ativado e está pronto para o uso

SUSPENDED Cartão foi suspenso e não pode ser utilizado

Tipo de contato com a empresa.

Parâmetros de entrada

PHONE o valor é um número de telefone, celular ou fax

EMAIL o valor é um e-mail

IM aplicativo de mensagens instantâneas O valor é um identificador de usuário com o campo de contexto

OTHER valor que segue texto livre

Financiamento do cartão: crédito, débito ou múltiplo.

Parâmetros de entrada

CREDIT Cartão de Crédito

DEBIT Cartão de Débito

MULTIPLE Cartão de Crédito e Débito (ambos simultaneamente).

Código que identifica produto. Pode ser adicionados novos registros nessa lista. Exemplos de Produtos Elo:

Parâmetros de entrada

BASIC

  • BÁSICO

BUSINESS

  • EMPRESARIAL

CORPORATE

  • CORPORATIVO

ELO_PLUS

  • ELO MAIS

SHOPPING

  • COMPRAS

GRAFITE

  • GRAFITE

NANQUIM

  • NANQUIM

AWARDS

  • PREMIAÇÃO

CORPORATE_EXPENDITURE

  • DESPESAS CORPORATIVAS

TRAVEL

  • VIAGEM

CORPORATE_NANQUIM

  • CORPORATIVO NANQUIM

GRAFITE_BUSINESS

  • EMPRESARIAL GRAFITE

PAYMENT_OF_SUPPLIERS

  • PAGAMENTO DE FORNECEDORES

GENERAL_USE

  • USO GERAL

GIFT_CARD

  • GIFT CARD

PAYMENTS

  • PAGAMENTOS

Estado da Transação feita por Comerciante via Facilitador

Parâmetros de entrada

APPROVED Aprovada

REJECTED Negada

RETURNED Desfeita

REFUNDED Estornada ou Cancelada

CHARGEBACK TODO Confirmar ??? senão unificar com Facilitadores PSPTransactionStatus

Estado da Transação fraudulenta

Parâmetros de entrada

RECEIVED Recebida

IN_PROGRESS Em processamento

PROCESSED Processada

COMPLETED Concluido

Identifica se o emissor ou o comerciante é responsável pela transação fraudulenta.

Parâmetros de entrada

YES Issuer is liable

NO Merchant is liable

NOT_APPLICABLE Not Applicable

Identificar se o emissor ou o portador de cartão detectou a fraude.

Parâmetros de entrada

CARD_ISSUER Emissor

CARD_HOLDER Portador

Indicador do tipo de viagem. Pode ser adicionados novos registros nessa lista. Valores possíveis:

Parâmetros de entrada

AIR

  • Viagem Aérea

SEA

  • Viagem Marítima

ROAD

  • Viagem Terrestre.

Estado do Seguro

As transições de estado de um seguro são:

  • RECEIVED
  • HIRED
  • CANCELED

Parâmetros de entrada

RECEIVED Solicitação de contratação do seguro foi registrada.

HIRED Seguro contratado.

CANCELED Seguro cancelado e não está mais vigente.

Entrada para filtragens de busca com informações textuais.

Parâmetros de entrada

filter (String) TODO: document filter language, something like Google or GMail

Entrada que filtra cartões a serem retornados

Parâmetros de entrada

status (CardStatus) Se não-nula, retorna apenas cartões com dado estado. Exemplo: ACTIVE Se null, retorna cartões em todos os estados.

usageConstraints (CardUsageConstraintsInput) Se não-nula, retorna apenas cartões com as dadas restrições de uso. Se null, retorna cartões com quaisquer restrições de uso.

cardHolderServiceId (ID) Se não-nula, retorna apenas cartões oferecendo um certo serviço (CardHolderService), referente a availableServices. Se null, retorna cartões que ofereçam quaisquer serviços.

funding (CardFunding) Se não-nula, retorna apenas cartões com dado financiamento. Exemplo: DEBIT Se null, retorna cartões em todos os tipos.

cardProductId (ID) Se não-nula, retorna apenas cartões de um certo produto (CardProduct). Se null, retorna cartões de todos os produtos.

cardBrandId (ID) Se não-nula, retorna apenas cartões de uma certa bandeira (CardBrand). Se null, retorna cartões de todas as bandeiras.

NOTA: em cardBrandId só possuí bandeira ELO disponível.

cardCaptureId (ID) Se não-nula, retorna apenas cartões que permitem uma dada captura (CardCapture). Se null, retorna cartões de todas as capturas.

cardUsageId (ID) Se não-nula, retorna apenas cartões de um certo uso (CardUsage). Se null, retorna cartões de todos os usos.

cardNetworkId (ID) Se não-nula, retorna apenas cartões de um certa rede (CardNetwork). Se null, retorna cartões de todas as redes.

cardIssuerId (ID) Se não-nula, retorna apenas cartões de um certo emissor (CardIssuer). Se null, retorna cartões de todos os emissores.

Entrada de informações sobre como o cartão ou token podem ser usados.

Emissores, cartões e produtos podem impor restrições extras.

Parâmetros de entrada

maxUsage (Int) Número de vezes que o cartão pode ser usado.

-1 significa ilimitado null significa uso não definido.

expiry (DateTime) Uso é permitido até a data e horário de validade

allowedTxAmounts ([CardCurrencyRangeInput]) Quantias permitidas por transações permitidas (TX) como limites por moedas.

Cada moeda será listada no máximo uma vez.

Nenhuma conversão de moedas é executada. Se uma moeda não é listada, é porque não é autorizada.

Se null, é ilimitada.

allowedMerchants ([ID]) Lista de comerciantes autorizados.

Se null, é ilimitada.

allowedMerchantCategories ([MerchantCategoryRangeInput]) Série de categorias de comerciantes autorizadas, definidas por código ISO.

Se null, é ilimitada.

deniedMerchantCategories ([MerchantCategoryRangeInput]) Série de categorias de comerciantes proibidas, definidas por código ISO.

Se null, é ilimitada.

Define limites operacionais para uma moeda.

Parâmetros de entrada

currency (String!) Código da moeda com 3 letras (ISO4217) Exemplo: EUR, USD, BRL...

min (Float) Valor mínimo ou null para ilimitado.

max (Float) Valor máximo ou null para ilimitado.

Série de códigos ISO18245 para categorias de comerciantes.

Também conhecido como MCC (Merchant Category Code), tem 4 dígitos.

Parâmetros de entrada

min (Int) Código ISO18245 mínimo a ser incluído na série.

max (Int) Código ISO18245 máximo a ser incluído na série.

Entrada que filtra transações a serem retornadas.

Parâmetros de entrada

startTimestamp (DateTime) Se não-nula, retorna apenas transações à partir (inclusive) da data e horário dados. Se null, retorna transações até o início dos tempos.

endTimestamp (DateTime) Se não-nula, retorna apenas transações até (inclusive) a data e horário dados. Se null, retorna transações até o momento atual.

includeMerchantCategories ([MerchantCategoryRangeInput]) Se não-nula e não vazia, especifica série de códigos ISO de categorias a serem incluídas.

Se null ou vazia, não filtra por categoria de comerciantes (MCC).

excludeMerchantCategories ([MerchantCategoryRangeInput]) Se não-nula e não vazia, especifica série de códigos ISO de categorias a serem excluídas.

Se null ou vazia, não filtra por categoria de comerciantes (MCC).

status (CardTransactionStatus) Se não-nula, retorna apenas transações no dado estado. Se null, retorna transações em qualquer estado.

captureId (ID) Se não-nula, retorna apenas transações capturadas pelo dado método Se null, retorna transações capturadas por qualquer método.

Exemplos de método de captura: POS, TEF, Internet...

O id se refere ao CardCapture { id }

usageId (ID) Se não-nula, retorna apenas transações com o uso especificado. Se null, retorna transações com qualquer uso.

Exemplos de uso: Débito, Crédito à Vista, Crédito parcelado pela loja...

O id se refere ao CardUsage { id }

Entrada que filtra transações a serem consolidadas retornadas.

Parâmetros de entrada

startTimestamp (DateTime) Se não-nula, retorna apenas transações à partir (inclusive) da data e horário dados. Se null, retorna transações até o início dos tempos.

endTimestamp (DateTime) Se não-nula, retorna apenas transações até (inclusive) a data e horário dados. Se null, retorna transações até o momento atual.

includeMerchantCategories ([MerchantCategoryRangeInput]) Se não-nula e não vazia, especifica série de códigos ISO de categorias a serem incluídas.

Se null ou vazia, não filtra por categoria de comerciantes (MCC).

excludeMerchantCategories ([MerchantCategoryRangeInput]) Se não-nula e não vazia, especifica série de códigos ISO de categorias a serem excluídas.

Se null ou vazia, não filtra por categoria de comerciantes (MCC).

Entrada que filtra transações fraudulentas a serem retornadas.

Parâmetros de entrada

cardTransactionId (ID) Identificador Global Único para CardTransaction.

O id se refere ao CardTransaction { id }

codeCapture (Int) Tipo de Captura cardCapture { code: Int }.

codeUsage (Int) Uso do Cartão CardUsage { code: Int }.

legalIds (CompanyLegalIdsInput) Os documentos legais para determinar o comerciante (i.e: CNPJ)

Ao menos um documento legal deverá ser especificado para que esta consulta retorne o comerciante.

iso (Int) ISO18245

startTimestamp (DateTime) Se não-nula, retorna apenas transações fraudulentas à partir (inclusive) da data e horário dados. Se null, retorna transações fraudulentas até o início dos tempos.

endTimestamp (DateTime) Se não-nula, retorna apenas transações fraudulentas até (inclusive) a data e horário dados. Se null, retorna transações fraudulentas até o momento atual.

Entrada para CompanyLegalIds

Parâmetros de entrada

cnpj (String) Número CNPJ sem hífen ou pontos

Entrada que filtra Seguros Viagem (TravelInsurance) a serem retornados.

Parâmetros de entrada

status (CardHolderInsuranceStatus) Se não-nula, retorna apenas seguros com dado estado. Exemplo: ACTIVE. Se null, retorna seguros em todos os estados.

startDate (Date) Se não-nula, retorna apenas seguros posteriores à data (inclusive). Se null, retorna até o seguro mais antigo.

endDate (Date) Se não-nula, retorna apenas seguros anteriores à data (inclusive). Se null, retorna até o seguro mais recente.

originCountry (String) Se não-nula, retorna apenas seguros emitidos para o dado País de Origem da viagem. Se null, retorna seguros para todas as origens.

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

destinationCountry (String) Se não-nula, retorna apenas seguros emitidos para o dado País de Destino da viagem. Se null, retorna seguros para todos os destinos.

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

Entrada que filtra Seguros de Garantia Estendida (ExtendedWarrantyInsurance) a serem retornados.

Parâmetros de entrada

status (CardHolderInsuranceStatus) Se não-nula, retorna apenas seguros com dado estado. Exemplo: ACTIVE. Se null, retorna seguros em todos os estados.

startDate (Date) Se não-nula, retorna apenas seguros posteriores à data (inclusive). Se null, retorna até o seguro mais antigo.

endDate (Date) Se não-nula, retorna apenas seguros anteriores à data (inclusive). Se null, retorna até o seguro mais recente.

categoryId (ID) Se não-nula, retorna apenas seguros de uma certa categoria de produtos. Se null, retorna seguros de todas as categorias de produtos.

Obtenha lista de categorias com extendedWarrantyProductCategories.

Entrada que filtra Seguros de Proteção de Compra de Produtos (PurchaseSecurityInsurance) a serem retornados.

Parâmetros de entrada

status (CardHolderInsuranceStatus) Se não-nula, retorna apenas seguros com dado estado. Exemplo: ACTIVE. Se null, retorna seguros em todos os estados.

startDate (Date) Se não-nula, retorna apenas seguros posteriores à data (inclusive). Se null, retorna até o seguro mais antigo.

endDate (Date) Se não-nula, retorna apenas seguros anteriores à data (inclusive). Se null, retorna até o seguro mais recente.

categoryId (ID) Se não-nula, retorna apenas seguros de uma certa categoria de produtos. Se null, retorna seguros de todas as categorias de produtos.

Obtenha lista de categorias com purchaseSecurityProductCategories.