The Payment Method Metadata object

Description

The Payment Method Metadata object allows you to obtain additional information about a specific payment method used for a transaction. 

The following inputs are available, indicated by the Type:

  • BIN – The bank identification number (BIN) of a card. The BIN is available in the CardInfo parameter returned on transactions with a registered card: direct card pay-in, recurring pay-in (CIT), preauthorization, deposit preauthorization, card validation. It is also available in the Card object in the first 6 digits of the Alias parameter.
  • GOOGLE_PAY – The temporary token returned by the Google Pay API, as submitted in the PaymentData parameter in the Google Pay pay-in.

Attributes

Type
string

Allowed values: BIN, GOOGLE_PAY

The type of metadata.

Bin
string

Format: 6 or 8 digits
Required if the Type is BIN.

The bank identification number (BIN).

Token
string

Required if the Type is GOOGLE_PAY.

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

TokenFormat
string

Allowed 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.
IssuerCountryCode
string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country where the card was issued.

IssuingBank
string

The name of the card issuer.

BinData
array

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

CardType
string

Returned values: CREDIT, DEBIT, CHARGE CARD

The type of the card.

CommercialIndicator
string

Returned values: PERSONAL, COMMERCIAL

Whether the card is held in a personal or commercial capacity.

SubType
string

The subtype of the card product. Examples include: CLASSIC, GOLD, PLATINUM, PREPAID, etc.

Note: The possible returned values are numerous and liable to evolve over time.

Brand
string

The card brand. Examples include: AMERICAN EXPRESS, DISCOVER, JCB, MASTERCARD, VISA, etc.
Note: The possible returned values are numerous and liable to evolve over time.