This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-11-12 05:58 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Optional request body for minting a token from a prior transaction. The transaction, merchant and
customer stay on the query string; the body carries what the query string cannot. Sending no body
at all mints the token exactly as a body-less request always has.
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.
The cardholder's stored-credential consent, when it was captured at the moment of the
transaction (for example on a payment terminal). Requires `customerId`: the card is stored
on that customer as a stored payment method and the consent is recorded against it. A consent
on a request that names no customer is refused with
`Transactions:TokenMintConsentRequiresCustomer`.
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
capturedAtUtcrequired
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.
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.
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.
consentTextVersionrequired
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.
evidenceReferencerequired
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.
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.
This model has no documented fields.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.