Get Click to Pay Data - Field Descriptions
The following page details each of the fields received in the response when using the Click to Pay Data endpoint.
Response Fields
When successful, the Click to Pay Data endpoint returns a 200 response.
| Field | Description |
|---|---|
| intent | Start of the intent object. |
| type | The service which the data needs to be enrolled in. For example, CLICK_TO_PAY. |
| value | The product name for which the request is intended. |
| intent | End of the intent object. |
| paymentInstrument | Start of the paymentInstrument object. |
| type | The type of payment instrument. For example, CARD. |
| cardType | The card type description. For example, Visa Platinum. |
| issuerName | The name of the issuer of the card. |
| nameOnCard | The name that appears on the card. |
| accountNumber | The Thredd public token for the card. |
| billingAddress | Object that contains information on the cardholder's billing address. |
| city | The city for the cardholder's billing address. |
| state | The state for the cardholder's billing address. |
| country | The country for the cardholder's billing address, expressed as a 3-letter (alpha-3) country code as defined in ISO 3166-1. |
| postalCode | The post code for the cardholder's billing address. |
| addressLine1 | The first line of the cardholder's billing address. |
| addressLine2 | The second line of the cardholder's billing address. |
| addressLine3 | The third line of the cardholder's billing address. |
| billingAddress | End of the billingAddress object. |
| expirationDate | The expiration date of the card. |
| paymentInstrument | End of the paymentInstrument object. |
| consumerInformation | Start of the consumerInformation object. |
| emails | The email addresses associated with the customer. |
| locale | The Language and country in which the product communicates with the consumer. For example, en_US. |
| phones | The phone numbers associated with the customer. |
| status | The current status of the request. |
| consent | Start of the consent object. |
| version | The specific version of the terms and conditions that the customer accepts for the user solution. |
| presenter | The presenter of consent to the consumer. |
| timeOfConsent | The Date/Time which the consent is valid, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z. Only accepts present and past dates. |
| consent | End of the consent object |
| lastName | The last name of the customer. |
| firstName | The first name of the customer. |
| middleName | The middle name of the customer. |
| countryCode | The 3 digit country code. |
| nationalIdentifiers | End of the nationalIdentifiers object. |
| type | The identification type for the cardholder. For example, PASSPORT, DRIVING_LICENSE, NATIONAL_IDENTITY. |
| value | The identification number for the identifier type. |
| nationalIdentifiers | End of the nationalIdentifiers object. |
| externalConsumerID | Client-provided unique identifier of the consumer. |
| externalConsumerIDOwnerBID | Visa Business Identifier (BID) of the entity to which thge External Consumer ID belongs. |
| consumerInformation | End of the consumerInformation object. |
Updated about 24 hours ago
Did this page help you?