forked from LiveCarta/PayPal-PHP-Server-SDK
* Automated commit message * add changelog --------- Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com> Co-authored-by: Patrick Powers <patickpowers@hey.com>
3.0 KiB
3.0 KiB
Setup Token Request Card
A Resource representing a request to vault a Card.
Structure
SetupTokenRequestCard
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}$ |
getName(): ?string | setName(?string name): void |
number |
?string |
Optional | The primary account number (PAN) for the payment card. Constraints: Minimum Length: 13, Maximum Length: 19, Pattern: ^[0-9]{13,19}$ |
getNumber(): ?string | setNumber(?string number): void |
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])$ |
getExpiry(): ?string | setExpiry(?string expiry): void |
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}$ |
getSecurityCode(): ?string | setSecurityCode(?string securityCode): void |
brand |
?string(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_]+$ |
getBrand(): ?string | setBrand(?string brand): void |
billingAddress |
?Address |
Optional | The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute. | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void |
verificationMethod |
?string(VaultCardVerificationMethod) |
Optional | The verification method of the card. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[0-9A-Z_]+$ |
getVerificationMethod(): ?string | setVerificationMethod(?string verificationMethod): void |
experienceContext |
?SetupTokenCardExperienceContext |
Optional | Customizes the Vault creation flow experience for your customers. | getExperienceContext(): ?SetupTokenCardExperienceContext | setExperienceContext(?SetupTokenCardExperienceContext experienceContext): void |
Example (as JSON)
{
"name": "name2",
"number": "number0",
"expiry": "expiry0",
"security_code": "security_code4",
"brand": "DINERS"
}