Consulta o BIN (seis a nove primeiros dígitos do cartão) e retorna informações do cartão.
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | get | https://apiquerysandbox.cieloecommerce.cielo.com.br/1/cardBin/{BIN} |
| Produção | get | https://apiquery.cieloecommerce.cielo.com.br/1/cardBin/{BIN} |
Importante
- Para habilitar a Consulta BIN, entre em contato com a equipe de suporte da Cielo;
- Alguns BINs ou bandeiras podem não ter o retorno das informações do cartão;
- Se a API retornar o código de erro 323, entre em contato com o Atendimento para habilitar a funcionalidade.
Para usar a Consulta BIN em sandbox, confira os cenários de simulação em Consulta BIN em sandbox.
Em sandbox, os valores retornados são simulações e não validações reais de BINS. Considere apenas o retorno da requisição e o seu formato. Para identificação real dos BINS, use o ambiente de produção.
Parâmetros do header
| Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
|---|---|---|---|---|
MerchantId | Identificador da loja na API E-commerce Cielo. | GUID | 36 | Sim |
MerchantKey | Chave pública para autenticação dupla na API E-commerce Cielo | string | 40 | Sim |
RequestId | Identificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT | GUID | 36 | Não |
Parâmetros do path
| Parâmetro | Descrição | Tipo | Tamanho |
|---|---|---|---|
BIN | São os seis ou nove primeiros dígitos do cartão. Exemplo: para o cartão 4510110012341234 o BIN será 451011. | Integer | 9 |
Resposta da consulta BIN
{
"Status": "00",
"Provider": "MASTERCARD",
"CardType": "Crédito",
"ForeignCard": true,
"CorporateCard": true,
"Issuer": "Bradesco",
"IssuerCode": "237",
"Prepaid":true
}
Bad request
Internal Server Error
[
{
"ReturnCode": 323,
"ReturnMessage": "Bin Query is not enabled"
}
]
A API irá retornar as seguintes propriedades da Consulta BIN:
| Parâmetro | Descrição | Tipo | Tamanho |
|---|---|---|---|
Status | Status da requisição de análise de Bins: 00 – Análise autorizada 01 – Bandeira não suportada 02 – Cartão não suportado na consulta de bin 73 – Afiliação bloqueada | string | 2 |
Provider | Bandeira do cartão. | string | 255 |
CardType | Tipo do cartão em uso : Crédito Débito Múltiplo | string | 20 |
ForeingCard | Se o cartão é emitido no exterior (true/false). | boolean | - |
CorporateCard | Se o cartão é corporativo (true/false). | boolean | - |
Issuer | Nome do emissor do cartão. | string | 255 |
IssuerCode | Código do emissor do cartão. | string | 255 |
Prepaid | Retornará "true" caso o cartão seja do tipo pré-pago. | boolean | - |