Manually trigger an orchestration

curl --request POST \
  --url https://production.hifibridge.com/v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/orchestrate \
  --header 'Authorization: Bearer <token>'

{
  "triggered": true,
  "batch": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "orchestrationAddressId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "totalAmount": "150.000000",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "depositIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "offrampTransactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Orchestration Addresses

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

users

{userId}

orchestration-addresses

{orchestrationAddressId}

orchestrate

Manually trigger an orchestration

curl --request POST \
  --url https://production.hifibridge.com/v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/orchestrate \
  --header 'Authorization: Bearer <token>'

{
  "triggered": true,
  "batch": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "orchestrationAddressId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "totalAmount": "150.000000",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "depositIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "offrampTransactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

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

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

Option 1
Option 2

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.

Show child attributes

Retrieve a batch

List all onramps

⌘I