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

Try it

Create Orchestration Rule

cURL

curl --request POST \
  --url https://api.paxos.com/v2/orchestration/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ref_id": "my-rule-001",
  "nickname": "ETH to USD conversion",
  "profile_id": "e8ea8b1c-4e8d-4c59-9e7a-c985194ba2e8",
  "source_asset": "ETH",
  "destination_asset": "USD",
  "source": {
    "crypto": {
      "network": "ETHEREUM"
    }
  },
  "destination": {
    "profile": {
      "profile_id": "e8ea8b1c-4e8d-4c59-9e7a-c985194ba2e8"
    }
  }
}
'

200

{
  "rule": {
    "id": "<string>",
    "ref_id": "<string>",
    "nickname": "<string>",
    "profile_id": "<string>",
    "identity_id": "<string>",
    "account_id": "<string>",
    "status": "ACTIVE",
    "source_asset": "<string>",
    "destination_asset": "<string>",
    "source": {
      "crypto": {
        "address_id": "<string>",
        "address": "<string>",
        "network": "<string>"
      },
      "fiat": {
        "deposit_instructions_id": "<string>",
        "network": "<string>",
        "account_type": "<string>",
        "memo_id": "<string>"
      },
      "profile": {
        "profile_id": "<string>"
      }
    },
    "destination": {
      "crypto": {
        "address": "<string>",
        "network": "<string>"
      },
      "fiat": {
        "fiat_account_id": "<string>",
        "memo": "<string>"
      },
      "profile": {
        "profile_id": "<string>"
      }
    },
    "created_at": "2023-11-07T05:31:56Z"
  }
}

OAuth Scope

orchestration:write_orchestration_rule

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Body

application/json

ref_id · string · required

Client-provided unique reference ID for the rule.

profile_id · string · required

Profile ID of the account owner.

source_asset · string · required

Asset being converted from.

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

destination_asset · string · required

Asset being converted to.

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

source · object · required

Show child attributes

source. crypto · object

Show child attributes

source.crypto. network · string

The blockchain network for the crypto source.

Valid values: ETHEREUM, SOLANA, STELLAR, BASE, POLYGON

source. fiat · object

Show child attributes

source.fiat. network · string

The fiat network for the source.

Valid values: WIRE, CUBIX

source.fiat. account_type · string

The account type for the fiat source.

Valid values: SWIFT, ABA

nickname · string

Optional human-readable nickname for the rule.

identity_id · string

Identity ID of the account owner.

account_id · string

Account ID where the rule applies.

destination · object

Show child attributes

destination. crypto · object

Show child attributes

destination.crypto. crypto_address_id · string

The ID of a pre-approved crypto destination address.

Valid crypto addresses can be retrieved using:

• ListCryptoDestinationAddresses endpoint (/transfer/crypto-destination-addresses)
• PutCryptoDestinationAddress endpoint (/transfer/crypto-destination-address)

destination. fiat · object

Show child attributes

destination.fiat. fiat_account_id · string

The ID of a pre-approved fiat account.

Valid fiat account IDs can be retrieved using:

• CreateFiatAccount endpoint (/transfer/fiat-accounts)
• GetFiatAccount endpoint (/transfer/fiat-accounts/{id})
• ListFiatAccounts endpoint (/transfer/fiat-accounts)

destination.fiat. memo · string

destination. profile · object

Show child attributes

destination.profile. profile_id · string

Response

200 - application/json

A successful response.

rule · object

Show child attributes

rule. id · string

Unique identifier for the orchestration rule.

rule. ref_id · string

Unique reference ID for the rule.

rule. nickname · string

Optional human-readable nickname for the rule.

rule. profile_id · string

Profile ID of the account owner.

rule. identity_id · string

Identity ID of the account owner.

rule. account_id · string

Account ID where the rule applies.

rule. status · enum<string>

• ACTIVE: The rule is active, deposits matching the source_asset and source of this rule start a conversion and subsequent delivery of the destination_asset to the specified destination.
• DELETED: The rule has been deleted, newly deposited source_assets to the source of this rule will not be converted. The deposited source_asset is still going to be credited to the Profile specified by profile_id.
• PENDING: The rule creation is pending approval(s) before the rule becomes ACTIVE.
• REJECTED: The rule creation has been rejected during the approval process.
• CANCELLED: The rule creation has been cancelled before it could be approved.

Available options: ACTIVE, DELETED, PENDING, REJECTED, CANCELLED

rule. source_asset · string

Asset being converted from.

rule. destination_asset · string

Asset being converted to.

rule. source · object

Show child attributes

rule.source. crypto · object

Show child attributes

rule.source.crypto. address_id · string

rule.source.crypto. address · string

rule.source.crypto. network · string

rule.source. fiat · object

Show child attributes

rule.source.fiat. deposit_instructions_id · string

rule.source.fiat. network · string

rule.source.fiat. account_type · string

rule.source.fiat. memo_id · string

rule.source. profile · object

Show child attributes

rule.source.profile. profile_id · string

rule. destination · object

Show child attributes

rule.destination. crypto · object

Show child attributes

rule.destination.crypto. address · string

rule.destination.crypto. network · string

rule.destination. fiat · object

Show child attributes

rule.destination.fiat. fiat_account_id · string

rule.destination.fiat. memo · string

rule.destination. profile · object

Show child attributes

rule.destination.profile. profile_id · string

rule. created_at · string<date-time>

Timestamp when the rule was created.