Payment Token Request Card
November 13, 2025 ยท View on GitHub
A Resource representing a request to vault a Card.
Structure
PaymentTokenRequestCard
Fields
| Name | Type | Tags | Description | Getter | Setter |
|---|---|---|---|---|---|
Name | String | Optional | The 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) |
Number | String | Optional | The 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) |
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) |
SecurityCode | String | Optional | The 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) |
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) |
BillingAddress | Address | Optional | The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute. | Address getBillingAddress() | setBillingAddress(Address billingAddress) |
Example (as JSON)
{
"name": "name4",
"number": "number8",
"expiry": "expiry2",
"security_code": "security_code6",
"brand": "HIPER"
}