Setup Token Request Card

November 13, 2025 ยท View on GitHub

A Resource representing a request to vault a Card.

Structure

SetupTokenRequestCard

Fields

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

Constraints: Minimum Length: 1, Maximum Length: 300, Pattern: ^.{1,300}$
String getName()setName(String name)
NumberStringOptionalThe primary account number (PAN) for the payment card.

Constraints: Minimum Length: 13, Maximum Length: 19, Pattern: ^[0-9]{13,19}$
String getNumber()setNumber(String number)
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)
SecurityCodeStringOptionalThe three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when payment_initiator=MERCHANT.

Constraints: Minimum Length: 3, Maximum Length: 4, Pattern: ^[0-9]{3,4}$
String getSecurityCode()setSecurityCode(String securityCode)
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)
BillingAddressAddressOptionalThe portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.Address getBillingAddress()setBillingAddress(Address billingAddress)
VerificationMethodVaultCardVerificationMethodOptionalThe verification method of the card.

Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[0-9A-Z_]+$
VaultCardVerificationMethod getVerificationMethod()setVerificationMethod(VaultCardVerificationMethod verificationMethod)
ExperienceContextVaultCardExperienceContextOptionalA resource representing an experience context of vault a card.VaultCardExperienceContext getExperienceContext()setExperienceContext(VaultCardExperienceContext experienceContext)

Example (as JSON)

{
  "name": "name2",
  "number": "number0",
  "expiry": "expiry0",
  "security_code": "security_code4",
  "brand": "STAR"
}