Enroll Cardholder & Payment Data - Field Descriptions
The following page details each of the fields sent in the request and received in the response when using the Enroll Cardholder & Payment Data endpoint.
Request Fields
The following table describes fields that can be included in the body of the request when using the Enroll Cardholder & Payment Data endpoint.
| Field | Description | Mandatory? | Type |
|---|---|---|---|
| customerDetails | The object that contains details of the customer. | - | - |
| customerReferenceId | An external customer reference provided in the request. | Yes | String |
| Email address of the cardholder. | Yes | String | |
| phone | Phone number of the cardholder in E.164 format (For example, +442071234567). | Yes | String |
| firstName | First name of the cardholder. | Yes | String |
| middleName | Middle name of the cardholder. | No | String |
| lastName | Last name of the cardholder. | Yes | String |
| nationalIdentifiers | The object that contains the national identifiers for the cardholder. If the object is included in the request, then the type and value fields must be included in the request. | - | - |
| type | Identification type for the cardholder. For example, PASSPORT, DRIVING_LICENSE, NATIONAL_IDENTITY. | Yes | String |
| value | Identification number for the cardholder. | Yes | String |
| end of nationalIdentifiers object | - | - | - |
| billingAddress | Object that contains information on the cardholder's billing address. When supplied in the request the address is used; when omitted it is retrieved in full from the Thredd database. The two sources are never mixed. For Visa, a country code and postal code are required (from whichever source is used). In addition to the characters rejected in all fields, billing address fields also reject the @ character. A billing address retrieved from the Thredd database is subject to the same character validation (a field containing a disallowed character returns a 400 response), while any field exceeding its maximum length is trimmed to that length rather than rejected. | - | - |
| city | The city for the cardholder's billing address. | Conditional | String |
| state | The state for the cardholder's billing address. | Conditional | String |
| country | The country for the cardholder's billing address, expressed as a 3-letter (alpha-3) country code as defined in ISO 3166-1. | Conditional | String |
| postalCode | The post code for the cardholder's billing address. | Conditional | String |
| addressLine1 | First line of the cardholder's billing address. | Conditional | String |
| addressLine2 | Second line of the cardholder's billing address. | Conditional | String |
| addressLine3 | Third line of the cardholder's billing address. | Conditional | String |
| end of billingAddress object | - | - | - |
| end of customerDetails object | - | - | - |
| pubTokens | An object of public tokens. | - | - |
| value | The Thredd 9 digit unique reference for a PAN. | Yes | String |
| end of pubTokens object | - | - | - |
Response Fields
A successful response for the Enroll Data endpoint will return a 202 response.
| Field | Description |
|---|---|
| requestTraceId | A unique identifier to trace the request. |
Updated 8 days ago
Did this page help you?