Skip to main content
POST
Trigger orchestration

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId
string
required

ID of the user.

Pattern: ^user_[A-Za-z0-9]+$
orchestrationAddressId
string<uuid>
required

ID of the orchestration address.

Response

Result of POST /orchestrate. Either a freshly-created batch (triggered: true, with batch populated) or an idempotent no-op (triggered: false, with reason indicating why).

Result of a manual POST /orchestrate call. Either a freshly-created batch (triggered: true) or an idempotent no-op (triggered: false).

triggered
enum<boolean>
required
Available options:
true
batch
object
required

A batch of one or more deposits rolled up into a single offramp transaction.