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

PartialApprovalDisposition

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

Tracks what happened to a partially approved authorization: the issuer approved less than the requested amount, and someone (the operator, the cardholder, or a gateway timeout) has to decide whether to keep the reduced authorization, void it, or collect the shortfall on a second tender.

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.
Pending The partial approval has been detected and recorded, but nobody has decided its fate yet. The transaction is holding a reduced authorization at the issuer and is waiting on an operator/cardholder acknowledgment until dispositionDeadlineUtc elapses.
Accepted The reduced authorization was accepted as-is. No reversal is issued and the transaction proceeds through the normal capture/settlement path for the approved (lesser) amount.
Voided The reduced authorization was rejected and reversed, so the issuer hold is released. The reason is recorded on voidReason (operator choice, acknowledgment timeout, or an automatic gateway policy void).
SplitTenderInitiated The reduced authorization was kept and a follow-up tender was started to collect the shortfall. The continuation transaction carries the same SplitTenderGroupId with the next SplitTenderSequence.

Fields

Field Type Description

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.