Consulta BIN

Query and get card information.

EnvironmentMethodEndpoint
Sandboxhttps://apiquerysandbox.cieloecommerce.cielo.com.br/1/cardBin/{BIN}
Productionhttps://apiquery.cieloecommerce.cielo.com.br/1/cardBin/{BIN}
ℹ️

Learn more about this feature in the documentation.

⚠️

Warning

  • To enable Consulta BIN, contact the Cielo support team;
  • Some BINs or card brands may not provide card information in the response;
  • If the API returns error code 323, contact Customer Support to enable the feature. Learn more in Consulta BIN Return Codes
ℹ️

To use Consulta BIN in Sandbox, check the simulation scenarios in Consulta BIN in Sandbox.

In Sandbox, the returned values are simulations and not real BIN validations. Consider only the request response and its format. For real BIN identification, use the production environment.

The matching based on the first card digits (digits 1 to 6) is used only to generate simulated scenarios and does not represent the behavior of the query in Production.

Consulta BIN response

The API will return the following BIN Query properties:

ParameterDescriptionTypeSize
StatusStatus of the BIN analysis request:
00 – Analysis authorized
01 – Card brand not supported
02 – Card not supported in the BIN query
73 – Blocked affiliation
Refer to the Consulta BIN Return Codes.
string2
ProviderCard brandstring255
CardTypeCard type in use:

Credit
Debit
Multiple
string20
ForeingCardIndicates whether the card is issued abroad (true/false).boolean-
CorporateCardIndicates whether the card is corporate (true/false).boolean-
IssuerCard issuer name.string255
IssuerCodeCard issuer code.string255
PrepaidReturns "true" if the card is prepaid.boolean-
Path Params
int32
required

Enter the BIN (the first 6 to 8 digits of the card) or the full card number (up to 19 digits).

Headers
string
required

Merchant identifier in API E-commerce Cielo. Size: 6. This documentation provides a default MerchantId to allow testing in the sandbox, but you can also provide the enabled MerchantId during the deployment process.

string
required

Public Key for Double Authentication in API E-commerce Cielo. Size: 40. This documentation provides a default MerchantKey to allow testing in the sandbox, but you can also provide the enabled MerchantKey during the deployment process.

string

Request identifier, used when the merchant uses different servers for each GET/POST/PUT. Size: 36.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json