Skip to navigation

Look up metadata for a payment method

Best practice – For BIN lookup, use an 8-digit version if available

An 8-digit BIN provides the most detailed and accurate data for card identification and assessment, and is becoming the industry standard. The 6-digit version continues to be used but provides less granular classification that may be ambiguous if 8-digit sub-ranges have been introduced by the issuer.

A transaction’s CardInfo.BIN property returns the 8-digit BIN if its available. In the Card object, the Alias only ever reveals the first 6 digits – the 8-digit version should be preferred.

Authentication

AuthorizationBearer

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

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.
TypestringRequired

Allowed values: BIN, GOOGLE_PAY

The type of metadata.

BinstringOptional

Format: 6 or 8 digits

Required if the Type is BIN. The bank identification number (BIN).

TokenstringOptional

Required if the Type is GOOGLE_PAY.

The tokenized payment data provided by the third-party payment method.

Response

Success
TypestringOptional
The type of metadata.
BinstringOptional

Format: 6 or 8 digits

The bank identification number (BIN).

IssuerCountryCodestringOptional

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country where the card was issued.

IssuingBankstringOptional
The name of the card issuer.
BinDatalist of objectsOptional

Additional data about the card based on the BIN. In the case of co-branded card products, two objects are returned.

TokenFormatstringOptional

Returned values: PAN_ONLY, CRYPTOGRAM_3DS

In the case of Google Pay, the format of the Token.

  • PAN_ONLY – The card is registered in the Google account and requires 3DS authentication.
  • CRYPTOGRAM_3DS – The card is enrolled in the customer’s Google Wallet and authentication is handled by the Android device.