merchantId
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.
|
customerId
required |
string (uuid)
|
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 |
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:
| Field |
Type |
Description |
|---|
cardData
required |
CardData
CardData |
Conditional: When CardData 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.
| checkData
required |
CheckData
CheckData |
Conditional: When CheckData 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.
| tokenData
required |
TokenData
TokenData |
Conditional: When TokenData 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.
| processorTokens
required |
array of StoredProcessorToken
array of StoredProcessorToken |
Processor-issued reusable tokens (e.g. TSYS `RequestToken`) captured at auth time
and stored alongside the card. Keyed by processor + processor profile; a repeat sale
prefers a matching token at the rail and falls back to the PAN. An empty list when no
processor token is held.
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.
| networkToken
required |
StoredNetworkToken
StoredNetworkToken |
The network token (DPAN) provisioned for this payment method, when one exists. On a read it
carries only non-sensitive metadata: state, network, token suffix, expiry and timestamps. The
token number and the provider identifiers are never returned.
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.
| paymentMethodType
required |
TokenPaymentMethodType
TokenPaymentMethodType |
read 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.
Unknown |
Not classified. | Card |
A card, keyed or read. | Check |
A bank account debited over ACH, or a check. | DigitalWallet |
A digital wallet (Apple Pay, Google Pay, Paze), which rides the card networks. | AlternativePayment |
An alternative payment method approved inside a provider and presented as an approval reference. |
|
This body has no documented fields. |
type
required |
TokenType
TokenType |
Defines the supported token types used in transaction-related models. Also aliased as the
platform's payment-method category (`InitializeContext` imports it as
`PaymentMethodCategory`), which is what the processor-profile pre-filter narrows on.
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 |
Defines the category of a token used in transaction processing.
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.
|
idempotencyKey
required |
string
|
Optional caller-supplied key that makes this create safe to retry. Send the same key with the
same payment details and the gateway returns the token it already minted instead of minting a
second one, so a timeout or a network retry during a bulk import cannot leave you with two
vault records for one card.
Conditional: When IdempotencyKey is not empty.
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.
|
storedCredentialConsent
required |
TokenStoredCredentialConsentInput
TokenStoredCredentialConsentInput |
The cardholder's stored-credential consent, when you obtained it outside the platform before
vaulting the card (for example on a payment terminal's screen or a signed form). Optional. The
card or bank account is stored on the customer as a stored payment method and the consent is
recorded against it, so a later merchant-initiated charge on the token resolves it.
Conditional: When StoredCredentialConsent 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 TokenStoredCredentialConsentInput:
| Field |
Type |
Description |
|---|
capturedAtUtc
required |
string (date-time)
|
When the cardholder agreed, in UTC. Required. A time more than five minutes in the future is
refused.
Conditional: When CapturedAtUtc is not null.
Conditional: When CapturedAtUtc meets a condition.
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.
| method
required |
ConsentCaptureMethod
ConsentCaptureMethod |
How the cardholder agreed. Required. A terminal sends `OnScreen` for acceptance on its
screen, `SignedForm` for a signature, or `InPerson` for verbal agreement at the
counter; `Phone`, `Email`, `OnlineForm` and `Other` are accepted too.
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.
InPerson |
In-person interaction. Cardholder was physically present. | Phone |
Phone call with the cardholder (potentially recorded). | SignedForm |
Paper / digital form signed by the cardholder. | Email |
Email exchange in which cardholder agreed. | OnlineForm |
Online form on the merchant's own website / app. | OnScreen |
The cardholder accepted the terms on a device screen at the point of sale, such as a payment terminal or a tablet, at the moment the card was read. | Other |
Other method not captured above. Operators / merchants use the notes field or merchant reference to explain. |
| allowedUsages
required |
StoredCredentialUsage
StoredCredentialUsage |
The future uses the cardholder agreed to, as flags: `Recurring`, `Installment`,
`UnscheduledCOF` and `OneTimeFuture`, combined when the cardholder agreed to more
than one. Required, and at least one flag must be set.
Conditional: When AllowedUsages != None. 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.
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.
None |
No permitted uses. Consent record is effectively inactive. | Recurring |
Scheduled recurring charges (subscriptions, membership dues). Maps to Recurring. | Installment |
Fixed-schedule installment plans dividing a known total. Maps to Installment. | UnscheduledCOF |
Merchant-triggered charges for pre-agreed events (balance top-ups, usage overages, no-show fees, delayed charges). Maps to several MIT reason codes including UnscheduledCOF, NoShow, DelayedCharge, and IncrementalAuth. | OneTimeFuture |
A single known future cardholder-initiated purchase the credential was saved for (e.g. "save card for my next order"). Not used for MITs. |
| consentTextVersion
required |
string
|
The version of the consent text the cardholder was shown, as returned by the stored-credential
consent configuration endpoint. Required, up to 200 characters.
nullablemax length 200
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.
| evidenceReference
required |
string
|
Your own reference to the evidence you kept, such as the identifier of a stored signature
image or a terminal log line. Optional, up to 200 characters. Shown on the consent's evidence
in the back office.
nullablemax length 200
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.
| enrollmentTerms
required |
EnrollmentTermsInput
EnrollmentTermsInput |
The payment terms the cardholder agreed to. Required when `allowedUsages`
includes `Recurring` or `Installment`, and then the amount, frequency and duration
must each be set.
Conditional: When EnrollmentTerms is not null.
Required: When IncludesRecurringOrInstallment(AllowedUsages) is true.
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 body has no documented fields. |