Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Orchestration Rules

Create Orchestration Rule

Creates a persistent orchestration rule that automatically triggers orchestrations when matching deposits are received.

The rule will:

  1. Generate deposit instructions associated with the rule.
  2. Continuously monitor incoming deposits to those instructions.
  3. Automatically execute orchestrations to the specified destination.

Supported Sources:

  • Crypto deposit
  • Fiat deposit

Supported Destinations:

  • Crypto address on a supported network
  • Bank account
  • Profile ID

Error conditions:

  • Already Exists: Returned if a rule with the same ref_id already exists.
post/orchestration/rules

Request body

ref_idstring required

Client-provided unique reference ID for the rule.

nicknamestring

Optional human-readable nickname for the rule.

profile_idstring required

Profile ID of the account owner.

identity_idstring

Identity ID of the account owner.

account_idstring

Account ID where the rule applies.

source_assetstring required

Asset being converted from.

Valid values: USDG, PYUSD, USDP, USDC, USD

destination_assetstring required

Asset being converted to.

Valid values: USDG, PYUSD, USDP, USDC, USD

Example request

{
  "ref_id": "my-rule-001",
  "nickname": "USDC to USDG conversion",
  "profile_id": "e8ea8b1c-4e8d-4c59-9e7a-c985194ba2e8",
  "source_asset": "USDC",
  "destination_asset": "USDG",
  "source": {
    "crypto": {
      "network": "ETHEREUM"
    }
  },
  "destination": {
    "profile": {
      "profile_id": "e8ea8b1c-4e8d-4c59-9e7a-c985194ba2e8"
    }
  }
}

Response

A successful response.