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

PayloadDecryption

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

The provenance record of a payload decryption the gateway performed through a merchant's payment encryption provider: which provider, which scheme, which key, how it went, and what it cost.

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
providerName required string The provider that performed the decryption, as its registered name. 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.
scheme required string The scheme that was dispatched: `DUKPT` or `ONGUARD`. 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.
ksi required string The key serial identifier the request's key serial number matched. 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.
keyLabel required string The operator's label for the matched key entry. Never the key reference. 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.
outcome required string `Succeeded` or `Failed`. 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.
failureCode required string The `Decryption:` error code when `outcome` is `Failed`; otherwise `null`. 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.
providerResultCode required string The provider's own sanitized result code (a Futurex `AM` code, an HTTP status), carried for triage. Never the provider's error text. 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.
regionUsed required string Which of the provider's regions or endpoints answered, as the provider labels it. 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.
retryCount required integer (int32) How many failover retries the provider ran before answering. 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.
latencyMilliseconds required integer (int64) How long the provider call took, in whole milliseconds. 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.
decryptedAtUtc required string (date-time) When the decryption completed, in UTC. 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.