Get Payment Instrument Information - Field Descriptions

The following page details each of the fields received in the response when using the Get Payment Instrument Information endpoint.

Response Fields

When successful, the Get Payment Instrument Information endpoint returns a 200 response.

FieldDescription
intentStart of the intent object.
typeThe service which the data needs to be enrolled in. For example, CLICK_TO_PAY.
valueThe product name for which the request is intended.
intentEnd of the intent object.
paymentInstrumentStart of the paymentInstrument object.
typeThe type of payment instrument. For example, CARD.
cardTypeThe card type description. For example, Visa Platinum.
statusThe consumer status.
issuerNameThe name of the issuer of the card.
nameOnCardThe name that appears on the card.
accountNumberThe bank account number.
tokenDetailsThe start of the tokenDetails object.
tokenReferenceIdThe token reference ID.
tokenDetailsThe end of the tokenDetails object.
billingAddressObject that contains information on the cardholder's billing address.
cityThe city for the cardholder's billing address.
stateThe state for the cardholder's billing address.
countryThe country for the cardholder's billing address, expressed as a 3-letter (alpha-3) country code as defined in ISO 3166-1.
postalCodeThe post code for the cardholder's billing address.
addressLine1The first line of the cardholder's billing address.
addressLine2The second line of the cardholder's billing address.
addressLine3The third line of the cardholder's billing address.
billingAddressEnd of the billingAddress object.
expirationDateThe expiration date of the card.
paymentAccountReferenceThe unique payment account reference for the card.
paymentInstrumentEnd of the paymentInstrument object.