Retrieve Card - Field Descriptions
The following page details each of the fields that can be used in the request and received in the response when using the Retrieve Card endpoint.
Response Fields
The following table describes fields that included in the response after successfully retrieving card details.
| 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 | Array of child public tokens associated with the card. |
| siblingCards | Array of sibling cards' public tokens. (Cards which share the same parent card.) Applicable if the card is a child card. |
| balance | The balance object is 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. |
| balance | End of balance object. |
| cardDetails | The cardDetails object is 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 masked PAN for the card. |
| startDate | The start date of the card. |
| expiryDate | The expiry date of the card. |
| cardDetails | End of cardDetails object. |
| cardholder | The cardholder object is 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. | |
| cardholder | The end of the cardholder object. |
| cardProduct | The cardProduct object is 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 card 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 object captures the 3DS details associated with the card. |
| configuration | The configuration type, such as Cardinal or Apata. |
| defaultCredentials | Array of default 3DS credentials for the card. |
| type | The type of 3DS credential, such as SMS or Biometric. |
| 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 | Array of 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). See the IBAN list of country codes for a full list. |
| 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). See the IBAN list of country codes for a full list. |
| freeText1 | A free text field to communicate details to the card manufacturer. |
| freeText2 | A free text field to communicate details to the card manufacturer. |
| isSingleUse | If true, specifies that the card is for single use only. |
| isNonReloadable | If true, specifies that the card cannot be loaded with more currency. |
| cardAcceptorIds | Array that displays the list of allow and disallow acceptors for the card. |
| allowCardAcceptors | List of Allowed Card Acceptors for the card. |
| disallowCardAcceptors | List of Disallowed Card Acceptors for the card. |
| language3ds | Determines the 3DS Apata enrolment language for a card. This must be a valid BSP-47 code (for example, en-GB). |
| programManagerID | The unique program manager identifier associated with the card. |
| programManagerCode | The code for the program manager. |