View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

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-10-22 22:52 UTC.

API reference Models

StoredProcessorToken

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

A processor-issued reusable token (e.g. a TSYS `RequestToken`) captured at authorization time and stored on a payment method alongside the encrypted PAN. Repeat / merchant-initiated sales prefer a matching stored token at the rail and fall back to the PAN when none exists.

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
processorName required string The processor type key the token was minted under (for example `"tsys"`). Part of the token's selection key. 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.
processorProfileId required string (uuid) The processor profile (acquirer credential set) the token was minted under. Part of the token's selection key; a token is only replayed against the same profile. 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.
token required string The processor-issued token value. Encrypted at rest; never logged. 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.
tokenStatus required StoredTokenStatus StoredTokenStatus The token's lifecycle status as last known to the gateway. 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.
Active The token is active and may be replayed at the rail.
Inactive The token is present but should not currently be used (for example the processor reported it inactive). Retained so it can be reactivated rather than re-minted.
Invalidated The token has been invalidated or replaced and cannot be used.
tokenRequestorId required string The token-requestor identifier associated with the token, when the processor supplies 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.
createdAt required string (date-time) When the token was first captured and stored. 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.
lastUsedAt required string (date-time) When the token was last replayed at the rail. `null` until first reuse. 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.

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.