Sign in

v1

latestOpenAPI 3.0.02026-07-26103425558.9 KB
Orchestration Address

Manually trigger an orchestration

Force an immediate batch of all currently-PENDING deposits for the address, regardless of the configured mode. Useful for SCHEDULED addresses that you want to drain ahead of schedule, for THRESHOLD addresses that haven't crossed yet, or simply for operational backfill.

Idempotent. If no PENDING deposits exist (or the address was deactivated between the read and the row lock), returns 200 with triggered: false and a reason.

For SCHEDULED addresses, manual trigger does NOT advance nextRunAt — the scheduled tick still fires at its appointed time (it'll find zero PENDING deposits and no-op).

The endpoint serializes against concurrent THRESHOLD webhooks and the SCHEDULED job via a FOR UPDATE row lock, so at most one batch is ever produced for a given set of PENDING deposits.

post/v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/orchestrate

Path parameters

userIdstring required

ID of the user

orchestrationAddressIdstring 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).

OR

Example response

{
  "batch": {
    "totalAmount": "150.000000"
  }
}