SchemaPaymentsCards

Lookup BIN information

Perform a BIN (Bank Identification Number) lookup to retrieve information about a card.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
cardobjectRequired
Object that contains information about the card.
processingTerminalIdstringOptional>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
amountlongOptional
The amount in the currency's lowest denomination. If the card is eligible for surcharging, sending this field will allow the gateway to calculate and return the surcharge amount.
currencyenumOptional

Currency of the transaction. The value for the currency follows the ISO 4217 standard.

Response

Successful request. Returns the BIN information.
typestring
Card brand, for example, Visa.
cardNumberstring>=12 characters<=19 characters

Masked card number. Our gateway shows only the first six digits and the last four digits of the card number, for example, 548010******5929.

countrystringOptionalformat: "iso-3166-1"
Country of the issuing bank.
currencyenumOptional

Currency of the transaction. The value for the currency follows the ISO 4217 standard.

debitbooleanOptional
Indicates if the card is a debit card.
surchargingobjectOptional
Object that contains surcharge information. Our gateway returns this object only if the merchant adds a surcharge to transactions.

Errors