Retrieve an orchestration batch
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Globally unique public ID of the orchestration batch.
^orchbat_.+$Response
A single batch record (with its included deposit IDs and the linked offramp).
A batch of one or more deposits rolled up into a single offramp transaction.
Public orchestration-batch ID prefixed with orchbat_.
Public orchestration-address ID prefixed with orchaddr_.
Sum of the included deposits' amounts, in the source currency.
"150.000000"
usdc, usdt Batch lifecycle.
PENDING— created; the worker has not yet picked it up.PROCESSING— the linked offramp has been created and is in flight.COMPLETED— the linked offramp reachedCOMPLETED.FAILED— terminal failure. SeefailureReason.
PENDING, PROCESSING, COMPLETED, FAILED Populated when status=FAILED.
ADDRESS_NOT_ACTIVE— the address was deactivated before the worker created the offramp. The only input condition that terminally fails a batch.- All other values are terminal statuses surfaced from the linked offramp
transaction (e.g. lost product access →
NOT_INITIATED, a rejected AML review → a terminal status).
Internal inconsistencies (missing address, payout account lost its rail, a
processor-validation bug) do not appear here — the worker pauses the batch
(leaves it PENDING) and alerts ops instead of marking it FAILED.
ADDRESS_NOT_ACTIVE, NOT_INITIATED, QUOTE_FAILED, CRYPTO_FAILED, FIAT_FAILED, EXPIRED, REJECTED, CANCELLED IDs of all deposits included in this batch.
Public orchestration-deposit ID prefixed with orchdep_.
ID of the offramp transaction produced from this batch. null while
status=PENDING (the worker has not yet created the offramp). Call
GET /v2/offramps/{transferId} for full offramp details.