TokenData
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Represents tokenized payment information used to process a transaction. This model supports internal stored tokens as well as digital wallet tokens such as Internal, Apple Pay, Google Pay, and network tokens.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
token
required |
string | A secure token representing a stored payment method, charged in place of raw card data.
Required: When ProviderType is null or ProviderType == Internal.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
tokenSharing
required |
boolean | The sharing status of the token.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
merchantOriginalId
required |
string (uuid) | The original merchant identifier associated with the token,
typically used when token sharing is enabled.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
providerType
required |
TokenProviderType TokenProviderType | Specifies the provider that generated the token.
Examples include Internal, ApplePay, GooglePay, NetworkToken, and ReaderToken.
This value determines how the token should be processed.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
readerToken
required |
string | A reusable card token issued by a card-reader decryption service, charged in place of a
physical card read. Required when `providerType` is
`ReaderToken`, and ignored otherwise.
Required: When ProviderType == ReaderToken.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
encryptedPaymentToken
required |
string | The encrypted payment token payload received from a digital wallet provider
(for example, Apple Pay or Google Pay). Required for digital wallet transactions.
Required: When ProviderType == ApplePay or ProviderType == GooglePay or ProviderType == Paze.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
network
required |
string | The payment network associated with the token (for example: Visa, Mastercard, Amex).
Typically provided by digital wallet transactions.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
displayName
required |
string | A display-friendly name for the payment method,
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
cryptogram
required |
string | The cryptographic value used for transaction authorization in
digital wallet or network token transactions.
Required for Apple Pay, Google Pay, and network token processing.
Required: When ProviderType == NetworkToken.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
eciIndicator
required |
string | The Electronic Commerce Indicator (ECI) that specifies the authentication
level of the transaction. Commonly used in 3D Secure and digital wallet flows.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||
transactionIdentifier
required |
string | A unique identifier assigned by the wallet provider for the transaction.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.