PaymentTokenCreateDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Represents the request payload used to create a payment token.
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 | |||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 transaction that minted the token, when one did. Stored as
supplied on create; a token created with it reads as transaction-created, and one created
without it as standalone.
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.
Conditional: When PaymentDetails is not null.
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 of PaymentDetailSnapshot:
This body has no documented fields. | |||||||||||||||||||||||||||||||||
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.
| |||||||||||||||||||||||||||||||
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.
| |||||||||||||||||||||||||||||||
label
required |
string | Optional human-readable label for the token (e.g. "John's Visa").
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) | Id of the related Customer.
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.
| |||||||||||||||||||||||||||||||
isActive
required |
boolean | Gets or sets a value indicating whether this entity is active.
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, Redacted).
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.
| |||||||||||||||||||||||||||||||
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.
| |||||||||||||||||||||||||||||||
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.
| |||||||||||||||||||||||||||||||
This model has no documented fields.