Get Card BIN Data [v3]
This API returns the details associated with a Card BIN, this is also referred as the IIN of a card. This API will be able to provide information regarding the payment type of the card i.e. credit, debit or prepaid as well as the scheme of the card i.e. Visa, Mastercard, RuPay etc. Other information related to the card will also be provided as is available
Request Body required
The first 6 digits of the card number, if more digits are sent, only the first 6 digits will be considered
The order for which you want to validate the bin details, if not passed simply card bin details are returned.
- 200
- 4XX
- 5XX
When the BIN data is successfully fetched, the response will be as below
Schema
The first 6 digits of the card number, shared by you in the request
Possible values: [Visa
, Mastercard
, RuPay
, American Express
, Maestro
, SBI Maestro
, Diners
, JCB
, Unknown
]
The name of the scheme or network of the card
Possible values: [visa
, master
, rupay
, amex
, maestro
, sbi_maestro
, diners
, jcb
, unknown
]
The code of the scheme or network of the card as defined by Nimbbl
This is a public URL from which the logo of the scheme can be fetched
Possible values: [domestic
, international
, unknown
]
This is geography of the card issuer
Possible values: [credit_card
, debit_card
, prepaid_card
, unknown
]
This is the payment mode code of the card that is assigned by Nimbbl
Possible values: [Credit Card
, Debit Card
, Prepaid Card
, Unknown
]
This is the payment mode of the card
Possible values: [retail
, corporate
, unknown
]
This is the type of of customer to whom the card has been issued. Where this isn't known it will come as unknown or blank
This is the code of the issuer of the card. Where this isn't known it will come as unknown or blank
This is the name of the issuer of the card. Where this isn't known it will come as unknown or blank
This is for future use by Nimbbl and will contain the URL for the logo of the card issuer
This is for future use by Nimbbl and will contain the country code of the card issuer
This is for future use by Nimbbl and will contain the country of the card issuer
{
"card_bin": "471227",
"scheme_name": "Visa",
"scheme_code": "visa",
"scheme_logo_url": "https://s3.ap-south-1.amazonaws.com/nimbbl/card/visa_v1.png",
"card_geography": "domestic",
"payment_mode_code": "credit_card",
"payment_mode": "Credit Card",
"card_type": "retail",
"issuer_code": "BARB",
"issuer_name": "Bank of Baroda",
"issuer_logo_url": "https://s3.ap-south-1.amazonaws.com/nimbbl/card/hdfc.png",
"card_country_code": "IN",
"card_country_name": "INDIA"
}
When the BIN data cannot be fetched, the response will be as below
Schema
error object
This is the error_code generated by Nimbbl
This is a customer friendly message that can be displayed to your consumer
This explains to your team how to recover from the error
{
"error": {
"nimbbl_error_code": "INVALID_REQUEST_PARAMETER",
"nimbbl_consumer_message": "Sorry, your payment cannot be processed due to a technical error. Please try again after some time.",
"nimbbl_merchant_message": "There is an input validation error, please check the payload of your request."
}
}
When there is a problem on the server, the response will be as below
Schema
error object
This is the error_code generated by Nimbbl
This is a customer friendly message that can be displayed to your consumer
This explains to your team how to recover from the error
{
"error": {
"nimbbl_error_code": "INVALID_REQUEST_PARAMETER",
"nimbbl_consumer_message": "Sorry, your payment cannot be processed due to a technical error. Please try again after some time.",
"nimbbl_merchant_message": "There is an input validation error, please check the payload of your request."
}
}