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-23 00:19 UTC.

API reference Models

SandboxAchStatusAdvanceRequestDto

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

Which settlement outcome to drive a sandbox ACH sale to, and the return detail when the outcome is a return.

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
targetStatus required SandboxAchTargetStatus SandboxAchTargetStatus The settlement status to drive the transaction to: a terminal outcome, or one of the intermediate statuses a debit passes through on the way to one. Required. 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.
SettlementSucceeded The debit cleared and the money moved. The ordinary success case.
SettlementRolledBack The receiving bank returned the debit. Requires a NACHA return code and reason. Arriving after SettlementSucceeded makes it a late return, which the resulting Transaction.Returned event flags.
NotEligible The entry was voided on the processor's side before it reached the ACH network.
SettlementFailed The processor reported an error on the entry rather than accepting it.
Accepted The processor accepted the entry and queued it for the next origination window. The first intermediate status.
Verifying The processor is verifying the account before origination. Follows Accepted.
Originated The entry was originated onto the ACH network and is in flight. Follows Verifying.
PartiallySettled Part of the amount has settled. The last intermediate status; follows Originated.
nachaReturnCode required string The NACHA return code to record, for example `R01`. Required when `targetStatus` is `SettlementRolledBack`, and rejected otherwise: a code on a settlement would be persisted and then published as part of an event that says the debit cleared. 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.
nachaReturnReason required string The return reason to record, for example `Insufficient funds`. Required alongside `nachaReturnCode`, and rejected on any other outcome for the same reason. nullablemax length 120
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.