Setup Token Response Card

June 5, 2026 ยท View on GitHub

Structure

SetupTokenResponseCard

Fields

NameTypeTagsDescriptionGetterSetter
NameStringOptionalThe card holder's name as it appears on the card.

Constraints: Minimum Length: 2, Maximum Length: 300, Pattern: ^[A-Za-z ]+$
String getName()setName(String name)
LastDigitsStringOptional, Read-onlyThe last digits of the payment card.

Constraints: Minimum Length: 2, Maximum Length: 4, Pattern: [0-9]{2,}
String getLastDigits()setLastDigits(String lastDigits)
BrandCardBrandOptionalThe 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)
ExpiryStringOptionalThe 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)
BillingAddressCardResponseAddressOptionalAddress request details.CardResponseAddress getBillingAddress()setBillingAddress(CardResponseAddress billingAddress)
VerificationStatusCardVerificationStatusOptionalVerification status of Card.

Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[0-9A-Z_]+$
CardVerificationStatus getVerificationStatus()setVerificationStatus(CardVerificationStatus verificationStatus)
VerificationCardVerificationDetailsOptionalCard Verification details including the authorization details and 3D SECURE details.CardVerificationDetails getVerification()setVerification(CardVerificationDetails verification)
NetworkTransactionReferenceNetworkTransactionReferenceEntityOptionalPrevious network transaction reference including id in response.NetworkTransactionReferenceEntity getNetworkTransactionReference()setNetworkTransactionReference(NetworkTransactionReferenceEntity networkTransactionReference)
AuthenticationResultCardAuthenticationResponseOptionalResults of Authentication such as 3D Secure.CardAuthenticationResponse getAuthenticationResult()setAuthenticationResult(CardAuthenticationResponse authenticationResult)
BinDetailsBinDetailsOptionalBank Identification Number (BIN) details used to fund a payment.BinDetails getBinDetails()setBinDetails(BinDetails binDetails)
TypeCardTypeOptionalType of card. i.e Credit, Debit and so on.

Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[A-Z_]+$
CardType getType()setType(CardType type)

Example (as JSON)

{
  "name": "name8",
  "last_digits": "last_digits2",
  "brand": "DISCOVER",
  "expiry": "expiry6",
  "billing_address": {
    "address_line_1": "address_line_12",
    "address_line_2": "address_line_28",
    "admin_area_2": "admin_area_28",
    "admin_area_1": "admin_area_14",
    "postal_code": "postal_code0",
    "country_code": "country_code8"
  }
}