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

MerchantEnvironment

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

The merchant's lifecycle environment, which decides whether its transactions may reach a live processor endpoint.

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.
Sandbox The merchant transacts against the processor's test host. No live money moves. This is the fail-closed default for anything whose environment cannot be determined.
PendingPromotion The merchant has requested promotion to production and is awaiting approval. It may not transact against any endpoint while in this state.
Production The merchant transacts against the processor's live host. The only state that resolves a production endpoint.
Suspended The merchant has been administratively suspended. It may not transact against any endpoint, live or test, until it is returned to another state.

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.