Card Response
June 5, 2026 ยท View on GitHub
The payment card to use to fund a payment. Card can be a credit or debit card.
Structure
CardResponse
Fields
| Name | Type | Tags | Description | Getter | Setter |
|---|---|---|---|---|---|
Name | String | Optional | The card holder's name as it appears on the card. Constraints: Minimum Length: 2, Maximum Length: 300 | String getName() | setName(String name) |
LastDigits | String | Optional, Read-only | The last digits of the payment card. Constraints: Pattern: [0-9]{2,} | String getLastDigits() | setLastDigits(String lastDigits) |
Brand | CardBrand | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[A-Z_]+$ | CardBrand getBrand() | setBrand(CardBrand brand) |
AvailableNetworks | List<CardBrand> | Optional, Read-only | Array of brands or networks associated with the card. Constraints: Minimum Items: 1, Maximum Items: 256, Minimum Length: 1, Maximum Length: 255, Pattern: ^[A-Z_]+$ | List | setAvailableNetworks(List |
Type | CardType | Optional | Type of card. i.e Credit, Debit and so on. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[A-Z_]+$ | CardType getType() | setType(CardType type) |
AuthenticationResult | AuthenticationResponse | Optional | Results of Authentication such as 3D Secure. | AuthenticationResponse getAuthenticationResult() | setAuthenticationResult(AuthenticationResponse authenticationResult) |
Attributes | CardAttributesResponse | Optional | Additional attributes associated with the use of this card. | CardAttributesResponse getAttributes() | setAttributes(CardAttributesResponse attributes) |
FromRequest | CardFromRequest | Optional | Representation of card details as received in the request. | CardFromRequest getFromRequest() | setFromRequest(CardFromRequest fromRequest) |
Expiry | String | Optional | The year and month, in ISO-8601 YYYY-MM date format. See Internet date and time format.Constraints: Minimum Length: 7, Maximum Length: 7, Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$ | String getExpiry() | setExpiry(String expiry) |
BinDetails | BinDetails | Optional | Bank Identification Number (BIN) details used to fund a payment. | BinDetails getBinDetails() | setBinDetails(BinDetails binDetails) |
StoredCredential | CardStoredCredential | Optional | Provides additional details to process a payment using a card that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file). Parameter compatibility: payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER. usage=FIRST is compatible only with payment_initiator=CUSTOMER. previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT. Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request. | CardStoredCredential getStoredCredential() | setStoredCredential(CardStoredCredential storedCredential) |
Example (as JSON)
{
"name": "name0",
"last_digits": "last_digits4",
"brand": "CARTE_BANCAIRE",
"available_networks": [
"ELO",
"DINERS",
"CHINA_UNION_PAY"
],
"type": "CREDIT"
}