Card Payment Token

Full representation of a Card Payment Token including network token.

Structure

CardPaymentToken

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`, Pattern: `^[A-Za-z ]+$`	getName(): ?string	setName(?string name): void
`lastDigits`	`?string`	Optional	The last digits of the payment card. Constraints: Minimum Length: `2`, Maximum Length: `4`, Pattern: `[0-9]{2,}`	getLastDigits(): ?string	setLastDigits(?string lastDigits): 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
`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
`billingAddress`	`?AddressDetails`	Optional	Address request details.	getBillingAddress(): ?AddressDetails	setBillingAddress(?AddressDetails billingAddress): void
`verificationStatus`	`?string`	Optional	Verification status of Card. Constraints: Minimum Length: `1`, Maximum Length: `255`, Pattern: `^[0-9A-Z_]+$`	getVerificationStatus(): ?string	setVerificationStatus(?string verificationStatus): void
`verification`	`?CardVerificationDetails`	Optional	Card Verification details including the authorization details and 3D SECURE details.	getVerification(): ?CardVerificationDetails	setVerification(?CardVerificationDetails verification): void
`networkTransactionReference`	`?NetworkTransactionReferenceEntity`	Optional	Previous network transaction reference including id in response.	getNetworkTransactionReference(): ?NetworkTransactionReferenceEntity	setNetworkTransactionReference(?NetworkTransactionReferenceEntity networkTransactionReference): void
`authenticationResult`	`?CardAuthenticationResponse`	Optional	Results of Authentication such as 3D Secure.	getAuthenticationResult(): ?CardAuthenticationResponse	setAuthenticationResult(?CardAuthenticationResponse authenticationResult): void
`binDetails`	`?BinDetails`	Optional	Bank Identification Number (BIN) details used to fund a payment.	getBinDetails(): ?BinDetails	setBinDetails(?BinDetails binDetails): void
`type`	`?string(CardType)`	Optional	Type of card. i.e Credit, Debit and so on. Constraints: Minimum Length: `1`, Maximum Length: `255`, Pattern: `^[A-Z_]+$`	getType(): ?string	setType(?string type): void
`networkToken`	`mixed`	Optional	-	getNetworkToken():	setNetworkToken( networkToken): void

Example (as JSON)

{
  "name": "name2",
  "last_digits": "last_digits6",
  "brand": "STAR",
  "expiry": "expiry0",
  "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"
  }
}

3.7 KiB Raw Blame History

Card Payment Token

Structure

Fields

Example (as JSON)

3.7 KiB

Raw Blame History