Get Full PAN - Field Descriptions
The following page details each of the fields received in the response when using the Get Full PAN endpoint.
Response Fields
The following table describes fields that included in the response after successfully retrieving a card's full PAN.
| Field | Description |
|---|---|
| cardType | The form factor of the card. |
| publicToken | The unique identifier for the card. |
| status | The current status of the card. |
| cardStatusCode | The current status code of the card. |
| cardStatusDescription | The description of the card status. |
| designId | The unique identifier for the card's image design. |
| childCards | The childCards object contains fields used to capture the child cards associated with the card. |
| siblingCards | The siblingCards object contains fields used to capture the sibling cards (cards that share the same parent card) associated with the card. |
| balance | The balance nested fields are used to capture the balance details of the card. |
| currencyCode | The currency code for the card. |
| cardBalance | The current balance of the card. |
| pendingAmount | Any pending transactions for the card. |
| availableBalance | The current available balance of the card. |
| cardDetails | The next set of fields are used to capture the details for the card. |
| customerReference | The external customer reference provided in the request. |
| fullNameOnCard | The name displayed on the card. |
| maskedPan | The full PAN of the card. |
| startDate | The start date of the card. |
| expiryDate | The expiry date of the card. |
| cardholder | The cardholder nested fields are used to capture the details for the cardholder. |
| title | Title of the cardholder. |
| firstName | First name of the cardholder. |
| middleName | Middle name of cardholder. |
| lastName | Last name of the cardholder. |
| dateOfBirth | Date of Birth of the cardholder. Format YYYY-MM-DD. |
| mobile | Mobile number of cardholder. |
| Email address of the cardholder. | |
| cardProduct | The cardProduct nested fields are used to capture the details for the card product. |
| scheme | The name of the scheme the card is associated with. |
| product | The name of the product the card is associated with. |
| productShortName | The short name of the product. |
| controlGroups | The controlGroups nested fields are used to capture the control groups associated with the card. |
| limitsGroup | Group code of the Limit Group. |
| usageGroup | Group code of the Usage Group. |
| recurringFeeGroup | Group code of the Scheduled Fee Group. |
| webServiceFeeGroup | Group code of the Web Service Fee Group. |
| authFeeGroup | Group code of the Fee Group. |
| mccGroup | Group code of the MCC Group. |
| cardLinkageGroup | Group code of the Card Linkage Group. |
| calendarGroup | Group code of the Auth Calendar Group. |
| fxGroup | Group code of the FX Group |
| paymentTokenUsageGroup | Group code for the Payment Token Usage Group. Defines configuration options specific to the provisioning of a digital payment token. For details, see the Tokenisation Guide. |
| 3DS | The 3DS nested fields are used to capture the 3DS details associated with the card. |
| configuration | The configuration of 3DS, such as Cardinal or Apata |
| type | Credential type. This will be one of the following:
|
| value | Credential value (for example, a phone number, email address or KBA question ID). |
| id | The identifier for the 3DS credential, unique to the card. |
| fallbackCredentials | Object that contains fallback 3DS credentials for the card. |
| type | The type of 3DS credential, such as SMS or Biometric. |
| value | The credential value, determined by its type, For example, email address for email, mobile number for SMS. |
| id | Unique ID of the credentials. |
| address | The address nested fields are used to capture the cardholder's address |
| addressLine1 | First line of the address. |
| addressLine2 | Second line of the address. |
| addressLine3 | Third line of the address. |
| city | City name. |
| state | State. |
| county | County, region or province. |
| postCode | Postcode / Zip code of the address. |
| country | Country of residence. This is represented as a 3-letter alphanumeric ISO country code (e.g. GBR for UK). |
| fulfilment | The fulfilment nested fields are used to capture the cardholder's fulfilment address. |
| addressLine1 | First line of the address. |
| addressLine2 | Second line of the address. |
| addressLine3 | Third line of the address. |
| city | City name. |
| state | State. |
| county | County, region or province. |
| postCode | Postcode / Zip code of the address. |
| country | Country of residence. This is represented as a 3-letter alphanumeric ISO country code (e.g. GBR for UK). |
| freeText1 | A free text field to communicate details to the card manufacturer. |
| freeText2 | A free text field to communicate details to the card manufacturer. |