Skip to main content
POST
/
orchestration
/
rules
Create Orchestration Rule
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": "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"
    }
  }
}
'
{
  "rule": {
    "id": "<string>",
    "ref_id": "<string>",
    "nickname": "<string>",
    "profile_id": "<string>",
    "identity_id": "<string>",
    "account_id": "<string>",
    "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://paxos-0ac97319-preview-travel-rule-api-changes.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

OAuth Scope
orchestration:write_orchestration_rule

Authorizations

​
Authorization
string
header
required

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

Token URLs:

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

​
Updated
destination
object

Response

200 - application/json

A successful response.

​
rule
object