Tabela de bins

API de Tabela de BINs permite com que o estabelecimento comercial identifique uma transação Elo e realize o roteamento adequado de autorização, possibilidando ainda utilização destas informações para fins de prevenção de fraudes.

Como funciona

Primeiros passos

  1. Leia Introdução ao GraphQL, com exemplos reais da nossa API.
  2. Crie um usuário no portal do desenvolvedor.
  3. Cadastre sua primeira aplicação.
  4. Utilize o dashboard para acessar suas configurações de acesso.
  5. Para explorar rapidamente as APIs aqui na página de documentação, use o console de GraphQL, na seção de referências. Nele, você pode ver as consultas de exemplo, executá-las e alterá-las.

Primeiros passos na plataforma de Desenvolvedores Elo

Jaydson GomesDesenvolvedor Evangelista

Introdução

O número do cartão (PAN - Primary Account Number) é segmentado por prefixos chamados "BIN", sigla em inglês para Bank Identification Number ou Número de Identificação do Banco.

O tamanho do prefix, também conhecido como "tamanho do BIN", diz quantos dígitos à esquerda do número do cartão são utilizados. Originalmente já foi de apenas 4 dígitos, hoje são 6 e espera-se que chegue até 9 dígitos. Logo o tamanho é parametrizado como uma faixa, informada na consulta binTable { sizeRange } (veja mais a seguir).

Como o tamanho do BIN impacta no tamanho do número do cartão (PAN), cada BIN parametriza os tamanhos de PAN que ele espera, também como uma faixa na consulta BIN { panSizeRange }.

Uma vez reconhecido o BIN, pode-se então consultar o sistema por diversos atributos, tais como:

  • Qual o país de origem (domicílio) do cartão? BIN { country }
  • O cartão pode ser utilizado internacionalmente? BIN { isInternational }
  • Qual o financiamento do cartão? crédito, débito, múltiplo (ambos)? BIN { funding }
  • É um cartão corporativo ou de pessoas físicas? BIN { isCompany }
  • É um cartão real ou virtual (CardToken)? BIN { isToken }
  • Onde posso capturar o cartão? (Ex. Caixa Eletrônico, Ponto de Venda, Internet...) BIN { allowedCaptures }
  • Quais tipo de uso? (Ex. Crédito à Vista, Crédito Parcelado pela Loja, Débito...) BIN { usage }
  • Qual é a bandeira do cartão? BIN { brand }
  • Qual rede o cartão pode ser utilizado? (Ex. Elo, Elo-Discovery...) BIN { cardNetwork }
  • Qual o emissor (banco) do cartão? BIN { issuer }
  • Quais serviços ao portador o cartão oferece? (Ex. Seguro Viagem) BIN { services }

Consultando um único BIN

Um BIN pode ser consultado com a consulta bin(id):

query OneBin {
  bin(number: "509069") { # Banco do Brasil - Grafite

    # Deverá retornar Banco do Brasil
    issuer {
      name
    }

    # Deverá retornar Grafite
    product {
      name
    }

    # Capturas permitidas (i.e: ponto de venda `POS`, Internet,
    # Telemarketing...)
    allowedCaptures {
      name
      code
    }

    # Usos permitidos (i.e: Crédito à Vista, Débito, Parcelado pela
    # Loja...)
    usages {
      name
      code
    }

    # Serviços (benefícios) ao portador (i.e: Seguro de Viagem,
    # Proteção de Compra, Garantia Estendida, WiFi)
    services {
      name
    }
  }
}

Tais parâmetros podem ser utilizados por terceiros, por exemplo um comerciante, para validação do cartão e até prevenção à fraude. No entanto consultar um BIN por vez pode não ser eficiente, já que os BINs não mudam com tanta frequência. Seria melhor baixar uma cópia de toda a tabela.

Baixando toda a Tabela de BINs

Para isso utilizamos a consulta binTable, a qual retorna uma lista de todos os BINs e cada um pode ser consultado do mesmo modo que utilizamos individualmente no exemplo anterior:

query TableOfBins {
  binTable {
    # Faixa de tamanho (em dígitos) do BIN
    #
    # Indica quais os tamanhos de BIN estão presentes na tabela, por
    # exemplo `{ min: 6, max: 9 }` indica que deve-se conferir os
    # prefixos do número do cartão (PAN) de tamanhos 6, 7, 8 e 9.
    #
    # Caso os valores sejam idênticos, apenas um tamanho é suportado,
    # por exemplo `{ min: 6, max: 6 }`, somente o tamanho 6 está
    # presente.
    sizeRange {
      min
      max
    }

    # BINs em uso (alocados).
    #
    # Nesta consulta iremos extrair muitos dados como exemplo, caso
    # nem todos sejam de seu interesse, pode simplesmente apagar as
    # linhas.
    #
    # Caso mais informações sejam necessárias, como `ID` de algum
    # subcampo, endereço de um emissor ou afins, basta incluí-los
    # conforme os campos listados para cada subtipo.
    bins {
      # Número do BIN
      #
      # O tamanho em caracteres define o número de dígitos (tamanho)
      # do BIN.
      number

      # Faixa de tamanhos do número do cartão (PAN).
      #
      #
      # 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.
      panSizeRange {
        min
        max
      }

      # Se o cartão é `CREDIT`, `DEBIT` ou `MULTIPLE` (ambos).
      funding

      # Se o cartão permite uso internacional ou apenas doméstico
      isInternational

      # Se o cartão é corporativo ou pessoa física
      isCompany

      # Se o cartão é virtual, ou seja, um _token_
      isToken

      # Produto do cartão, ex: Nanquim, Grafite, Viagem...
      product {
        name
      }

      # Capturas permitidas (i.e: ponto de venda `POS`, Internet,
      # Telemarketing...)
      allowedCaptures {
        name
        code
      }

      # Usos permitidos (i.e: Crédito à Vista, Débito, Parcelado pela
      # Loja...)
      usages {
        name
        code
      }
    }
  }
}

No entanto estes parâmetros não são frequentemente modificados, geralmente uma vez na semana. Para isso devemos anotar a última atualização e utilizá-la na próxima consulta, caso ela não tenha sido modificada, nada será retornado.

Baixando toda a Tabela de BINs, apenas se ela mudou

Para isso utilizamos a consulta binTable com o parâmetro ifNoneMatch passando o último etag retornado, ou null caso a tabela nunca tenha sido baixada. Os nomes e uso são exatamente iguais ao If-None-Match e ETag do HTTP, utilizado para evitar baixar recursos inalterados.

Poucas mudanças sobre o exemplo anterior:

query TableOfBins {
  binTable(ifNoneMatch: "algo-retornado-no-etag-anteriormente-ou-null") {

    etag # salve este valor em conjunto com a tabela, e use-o como ifNoneMatch na próxima consulta

    # ... demais campos consultados, como feito antes
  }
}

bin(BIN)

Consulta informações de BIN de um dado número

Se o número não estiver associado a um BIN alocado, então retorna null.

Em geral utilizado apenas em testes ou demonstrações dado que os usuários baixam toda a tabela com binTable() e fazem consultas locais. Dado que a frequência de atualizações é baixa (1 vez por semana).

Parâmetros de entrada

number (String!) O número do BIN, que por sua vez é um prefixo do número do cartão (PAN - Primary Account Number), ou seja pega-se os primeiros dígitos (à esquerda).

A quantidade de dígitos é parametrizada em binTable { sizeRange }, por exemplo { min: 6, max: 9 } indica que o sistema suporta BIN de tamanhos 6, 7, 8 e 9.

Parâmetros de saída

number (String!)

panSizeRange (IntRange!)

funding (CardFunding!)

product (CardProduct!)

country (String!)

isInternational (Boolean!)

regexp (String!)

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.

Para maior informação, veja API: createCardToken().

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!) Meta dados para apresentação do cartão ao usuário.

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

binTable(BINTable)

Baixa toda a tabela caso a tabela tenha sido modificada depois de uma certa data ou versão.

ifModifiedSince e ifNoneMatch são equivalentes ao uso no HTTP (If-Modified-Since para Last-Modified, If-None-Match para ETag) e podem ser utilizados para buscar por atualizações em uma única chamada.

Caso ifModifiedSince e ifNoneMatch sejam especificados e a tabela não tenha sido alterada, null é retornado indicando que a tabela não mudou.

Parâmetros de entrada

ifModifiedSince (DateTime) Caso fornecido, só retorna a tabela se esta foi atualizada posteriormente à data. Neste caso todos os dados da faixa são retornados, não apenas os que mudaram.

ifNoneMatch (String) Caso fornecido, só retorna a tabela se for diferente do ETag passado. Neste caso todos os dados da faixa são retornados, não apenas os que mudaram.

Parâmetros de saída

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

Pode ser utilizada para identificar que a tabela mudou. Seja fazendo uma consulta pela data e horário, seja fazendo a consulta binTable e passando a data e horário da última versão conhecida -- caso a tabela não tenha mudado, nada será retornado.

etag (String!) Etiqueta da Entidade (Entity Tag).

Similar ao uso em cabeçalhos HTTP, o ETag serve como um identificador que muda quando o conteúdo da tabela muda.

Assim como lastModified, pode ser utilizado para identificar alterações na tabela. Seja consultando pelo novo etag, seja fazendo consulta binTable e passando o etag anterior -- caso a tabela não tenha mudado, nada será retornado.

sizeRange (IntRange!) Tamanhos de BIN conhecidos.

A faixa de tamanhos dos números de dígitos que compõe BINs. Ou seja, ao consultar-se os BINs não deve-se fazer com um tamanho fixo (i.e: 6) e sim todos os tamanhos definidos nesta faixa.

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!

Exemplo: sizeRange { min: 6, max: 9 } informa que deve-se obter prefixos de tamanho 6, 7, 8 e 9 à partir do número do cartão e então buscá-los na tabela.

bins (BIN!) Listagem de BINs em uso (alocados).

reserved (ReservedBIN!) Listagem de BINs reservados, porém sem uso.

binsRegexp (String!) Expressão Regular que identifica BINs em uso (alocados).

A expressão regular retornada irá identificar o BIN (number) e o número de dígitos relativos ao panSizeRange de cada entrada.

Para comodidade do usuário da expressão regular, um grupo será retornado para o BIN encontrado. O número do grupo é indefinido pois vários são utilizados e construídos de forma automática. Porém um e apenas um grupo é retornado em caso de sucesso. Veja os exemplos abaixo para mais detalhes.

Por exemplo, considere uma Tabela de BINs com apenas duas entradas em uso (alocadas):

  • number: "509069" com panSizeRange: { min: 16, max: 16 };
  • number: "12345678" com panSizeRange: { min: 17, max: 19}.

    A expressão regular será: ^(?:(12345678)\d{9,11}|(509069)\d{10})$. Caso identifique o BIN 12345678, por exemplo o cartão 12345678123456789, então o grupo 1 será retornado com o valor 12345678 (BIN). Caso identifique o BIN 509069, por exemplo o cartão 5090691234567890, então o grupo 2 será retornado com o valor 509069 (BIN). Caso outro BIN seja passado, ou o número de dígitos de um cartão não seja correspondente ao panSizeRange do BIN, então nenhum grupo será retornado e a expressão regular não encontrará nada.

reservedRegexp (String!) Expressão Regular que identifica BINs reservados, porém sem uso.

A expressão regular retornada irá identificar o BIN (number) e o número de dígitos relativos ao panSizeRange de cada entrada.

Para comodidade do usuário da expressão regular, um grupo será retornado para o BIN encontrado. O número do grupo é indefinido pois vários são utilizados e construídos de forma automática. Porém um e apenas um grupo é retornado em caso de sucesso. Veja os exemplos abaixo para mais detalhes.

Por exemplo, considere uma Tabela de BINs com apenas duas entradas reservadas (sem uso):

  • number: "509069" com panSizeRange: { min: 16, max: 16 };
  • number: "12345678" com panSizeRange: { min: 17, max: 19}.

    A expressão regular será: ^(?:(12345678)\d{9,11}|(509069)\d{10})$. Caso identifique o BIN 12345678, por exemplo o cartão 12345678123456789, então o grupo 1 será retornado com o valor 12345678 (BIN). Caso identifique o BIN 509069, por exemplo o cartão 5090691234567890, então o grupo 2 será retornado com o valor 509069 (BIN). Caso outro BIN seja passado, ou o número de dígitos de um cartão não seja correspondente ao panSizeRange do BIN, então nenhum grupo será retornado e a expressão regular não encontrará nada.

BIN

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!)

panSizeRange (IntRange!)

funding (CardFunding!)

product (CardProduct!)

country (String!)

isInternational (Boolean!)

regexp (String!)

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.

Para maior informação, veja API: createCardToken().

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!) Meta dados para apresentação do cartão ao usuário.

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

IntRange

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.

CardProduct

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

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

ImageUrl

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

CardBrand

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

CardCapture

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

CardUsage

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

CardNetwork

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

CardIssuer

Entidade do Emissor de Cartão

Parâmetros de entrada

id (ID!)

name (String!)

legalName (String!)

description (String)

image (ImageUrl)

legalIds (CompanyLegalIds!)

contacts (CompanyContact!)

addresses (Address!)

url (String)

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.

CompanyLegalIds

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

Parâmetros de entrada

cnpj (CNPJ)

CNPJ

CNPJ: Cadastro Nacional Pessoas Jurídicas

Parâmetros de entrada

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

CompanyContact

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

Address

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 obrigatório

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.

CardsConnection

Conexão de Card em conformidade com o Relay.

Parâmetros de entrada

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

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.

PageInfo

PageInfo compatível com Relay.

Parâmetros de entrada

hasPreviousPage (Boolean!)

hasNextPage (Boolean!)

startCursor (String)

endCursor (String)

CardsEdge

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.

Card

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

Ver CardToken com relação a tokens.

Parâmetros de entrada

id (ID!)

sensitive (String)

last4 (String)

expiry (CardExpiry)

holder (CardHolder)

billingAddress (Address)

status (CardStatusInterface!)

usageConstraints (CardUsageConstraints)

availableServices ([CardHolderService])

usedServices ([CardHolderService])

bin (BIN)

funding (CardFunding)

product (CardProduct)

isInternational (Boolean)

isCompany (Boolean)

isToken (Boolean)

brand (CardBrand)

allowedCaptures ([CardCapture])

usages ([CardUsage])

network (CardNetwork)

issuer (CardIssuer)

metadata (CardMetadata)

CardExpiry

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.

CardHolder

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

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.

LegalIds

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

Parâmetros de entrada

cnpj (CNPJ)

cpf (CPF)

rg (RG)

CPF

CPF: Cadastro Pessoa Física

Parâmetros de entrada

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

RG

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

PersonContact

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

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

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.

Wallet

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.

CardUsageConstraints

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.

CardCurrencyRange

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.

Merchant

Entidade de comerciantes.

Parâmetros de entrada

id (ID!)

name (String!)

legalName (String!)

description (String)

image (ImageUrl)

legalIds (CompanyLegalIds!)

contacts (CompanyContact!)

addresses (Address!)

url (String)

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

MerchantCategory

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.

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

MerchantsConnection

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.

MerchantsEdge

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.

CardHolderService

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

CardMetadata

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

BINTable

Tabela de BINs.

Tabela de todos os BINs (Bank Identification Number ou Número de Identificação do Banco) no sistema, tanto os alocados (bins) quanto os reservados (reserved).

Os usuários da tabela são sistemas que frequentemente verificam números de cartão e seus atributos, por exemplo lojas virtuais (e-commerce).

A tabela tem "versão" (etag), bem como data e horário da última modificação, permitindo ao usuário identificar mudanças. Em geral as tabelas são modificadas semanalmente.

Parâmetros de entrada

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

Pode ser utilizada para identificar que a tabela mudou. Seja fazendo uma consulta pela data e horário, seja fazendo a consulta binTable e passando a data e horário da última versão conhecida -- caso a tabela não tenha mudado, nada será retornado.

etag (String!) Etiqueta da Entidade (Entity Tag).

Similar ao uso em cabeçalhos HTTP, o ETag serve como um identificador que muda quando o conteúdo da tabela muda.

Assim como lastModified, pode ser utilizado para identificar alterações na tabela. Seja consultando pelo novo etag, seja fazendo consulta binTable e passando o etag anterior -- caso a tabela não tenha mudado, nada será retornado.

sizeRange (IntRange!) Tamanhos de BIN conhecidos.

A faixa de tamanhos dos números de dígitos que compõe BINs. Ou seja, ao consultar-se os BINs não deve-se fazer com um tamanho fixo (i.e: 6) e sim todos os tamanhos definidos nesta faixa.

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!

Exemplo: sizeRange { min: 6, max: 9 } informa que deve-se obter prefixos de tamanho 6, 7, 8 e 9 à partir do número do cartão e então buscá-los na tabela.

bins (BIN!) Listagem de BINs em uso (alocados).

reserved (ReservedBIN!) Listagem de BINs reservados, porém sem uso.

binsRegexp (String!) Expressão Regular que identifica BINs em uso (alocados).

A expressão regular retornada irá identificar o BIN (number) e o número de dígitos relativos ao panSizeRange de cada entrada.

Para comodidade do usuário da expressão regular, um grupo será retornado para o BIN encontrado. O número do grupo é indefinido pois vários são utilizados e construídos de forma automática. Porém um e apenas um grupo é retornado em caso de sucesso. Veja os exemplos abaixo para mais detalhes.

Por exemplo, considere uma Tabela de BINs com apenas duas entradas em uso (alocadas):

  • number: "509069" com panSizeRange: { min: 16, max: 16 };
  • number: "12345678" com panSizeRange: { min: 17, max: 19}.

    A expressão regular será: ^(?:(12345678)\d{9,11}|(509069)\d{10})$. Caso identifique o BIN 12345678, por exemplo o cartão 12345678123456789, então o grupo 1 será retornado com o valor 12345678 (BIN). Caso identifique o BIN 509069, por exemplo o cartão 5090691234567890, então o grupo 2 será retornado com o valor 509069 (BIN). Caso outro BIN seja passado, ou o número de dígitos de um cartão não seja correspondente ao panSizeRange do BIN, então nenhum grupo será retornado e a expressão regular não encontrará nada.

reservedRegexp (String!) Expressão Regular que identifica BINs reservados, porém sem uso.

A expressão regular retornada irá identificar o BIN (number) e o número de dígitos relativos ao panSizeRange de cada entrada.

Para comodidade do usuário da expressão regular, um grupo será retornado para o BIN encontrado. O número do grupo é indefinido pois vários são utilizados e construídos de forma automática. Porém um e apenas um grupo é retornado em caso de sucesso. Veja os exemplos abaixo para mais detalhes.

Por exemplo, considere uma Tabela de BINs com apenas duas entradas reservadas (sem uso):

  • number: "509069" com panSizeRange: { min: 16, max: 16 };
  • number: "12345678" com panSizeRange: { min: 17, max: 19}.

    A expressão regular será: ^(?:(12345678)\d{9,11}|(509069)\d{10})$. Caso identifique o BIN 12345678, por exemplo o cartão 12345678123456789, então o grupo 1 será retornado com o valor 12345678 (BIN). Caso identifique o BIN 509069, por exemplo o cartão 5090691234567890, então o grupo 2 será retornado com o valor 509069 (BIN). Caso outro BIN seja passado, ou o número de dígitos de um cartão não seja correspondente ao panSizeRange do BIN, então nenhum grupo será retornado e a expressão regular não encontrará nada.

ReservedBIN

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

Este BIN não está em uso no momento, porém tem alguns atributos reconhecidos os quais podem ser utilizados em sistemas antifraudes ou para provisionamentos diversos.

Parâmetros de entrada

number (String!)

panSizeRange (IntRange!)

funding (CardFunding!)

product (CardProduct!)

country (String!)

isInternational (Boolean!)

regexp (String!)

CardStatusInterface

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

Parâmetros de entrada

status (CardStatus!) O estado

CardFunding

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

CompanyContactType

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

Gender

Opções de gênero

Parâmetros de entrada

FEMALE

MALE

MaritalStatus

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

PersonContactType

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

VerifiedStatus

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.

CardStatus

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

CardFilterInput

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.

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.

CardUsageConstraintsInput

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.

CardCurrencyRangeInput

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.

MerchantCategoryRangeInput

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.

SearchFilterInput

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

Parâmetros de entrada

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