extraProperties
required |
object
|
nullableread only
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.
|
id
required |
string (uuid)
|
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.
|
creationTime
required |
string (date-time)
|
The date and time when this entity was created.
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.
|
creatorId
required |
string (uuid)
|
The ID of the user who created this entity.
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.
|
lastModificationTime
required |
string (date-time)
|
The date and time when this entity was last modified.
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.
|
lastModifierId
required |
string (uuid)
|
The ID of the user who last modified this entity.
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.
|
isDeleted
required |
boolean
|
Indicates whether this entity has been deleted.
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.
|
deleterId
required |
string (uuid)
|
The ID of the user who deleted this entity, if it is deleted.
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.
|
deletionTime
required |
string (date-time)
|
The date and time when this entity was deleted, if it is deleted.
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.
|
tenantId
required |
string (uuid)
|
Id of the related tenant.
nullableread only
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.
|
concurrencyStamp
required |
string
|
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.
|
numericToken
required |
integer (int64)
|
The numeric representation 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.
|
cardFormatToken
required |
string
|
The card format representation 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.
|
transactionId
required |
string (uuid)
|
The unique identifier of the associated transaction when the token was created.
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.
|
paymentDetails
required |
PaymentDetailSnapshot
PaymentDetailSnapshot |
The payment details snapshot associated with this token.
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.
|
type
required |
TokenType
TokenType |
The underlying payment type of the token.
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.
Card |
A card, keyed or read. | Check |
A bank account debited over ACH, or a check. | Cash |
Cash, which carries no instrument block of its own. | DigitalWallet |
A digital wallet (Apple Pay, Google Pay, Paze), which rides the card networks. | AlternativePayment |
An alternative payment method approved inside a provider (PayPal, Venmo, Pay Later, Affirm, Klarna, Afterpay) and presented to the gateway as an approval reference. |
|
category
required |
TokenCategory
TokenCategory |
The category of the token (e.g., internal, network).
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.
|
merchantId
required |
string (uuid)
|
Id of the related Merchant.
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.
|
customerId
required |
string (uuid)
|
The customer this stored credential is bound to, or `null` when it is not bound to one.
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.
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.
|
label
required |
string
|
Optional human-readable label for 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.
|
status
required |
TokenStatus
TokenStatus |
The status of the token (Active, Inactive, Invalidated).
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.
Active |
Token is active and can be used for transactions. | Inactive |
Token is inactive but can be reactivated. | Invalidated |
Token has been invalidated and replaced by a new token. Cannot be used for new transactions and cannot be reactivated. | Redacted |
The vaulted account data has been wiped at the owner's request, leaving an audit shell: the last four, brand, BIN metadata, expiry, customer, merchant and lifecycle history survive, and the card number, cardholder name, bank account / routing / MICR values and any stored processor or network token do not. |
|
invalidatedByTokenId
required |
string (uuid)
|
The ID of the token that replaced this one (if invalidated and regenerated).
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.
|
replacesTokenId
required |
string (uuid)
|
The ID of the token that this token replaced (if this is a regenerated 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.
|
regenerationReason
required |
TokenRegenerationReason
TokenRegenerationReason |
The reason for token regeneration (if applicable).
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.
Manual |
Manually initiated by user. | NearExpiration |
Automated regeneration due to near expiration. | SuspectedCompromise |
Suspected compromise or security concern. | Other |
Other reason. |
|
lastRegeneratedAt
required |
string (date-time)
|
The timestamp when this token was last regenerated.
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.
|
redactedAt
required |
string (date-time)
|
When the token's stored card or bank account details were erased, or `null` for a token
that has not been redacted.
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.
|
redactionReason
required |
string
|
The reason recorded when the token's stored details were erased, or `null` for a token
that has not been redacted.
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.
|
publicReference
required |
string
|
The stable, opaque `pt_`-prefixed handle for this token: the only token identifier
permitted to leave the gateway, and the value to charge against on a merchant-initiated
transaction. Distinct from the internal id, which correlates to a card number and is never
treated as a merchant-facing handle.
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.
|