List Orchestration Rules

List all orchestration rules, optionally filtering and paging the results.

By default, orchestration rules are returned in reverse chronological (descending) order by creation time. If no query parameters are supplied, the response will include up to the last 100 rules which were created.

The paginated results default to display up to 100 rules, unless otherwise specified with the limit parameter. The maximum limit value is 1000. Every paginated response contains a next_page_cursor field until the last page is reached.

Pass the next_page_cursor value into the page_cursor field of a new request to retrieve the next page of results.

Rules can be filtered by:

• Profile ID (profile_id)
• Status (status)
• Source asset (source_asset)
• Destination asset (destination_asset)

GET /orchestration/rules

Try it

List Orchestration Rules

cURL

curl --request GET \
  --url https://api.paxos.com/v2/orchestration/rules \
  --header 'Authorization: Bearer <token>'

200

{
  "rules": [
    {
      "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"
    }
  ],
  "next_page_cursor": "<string>"
}

OAuth Scope

orchestration:read_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 →

Query Parameters

profile_id · string

Optional filter by profile ID

status · enum<string>[]

Optional filter by statuses

• 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

source_asset · string

Optional filter by source asset

destination_asset · string

Optional filter by destination asset

ids · string[]

Optionally filter by the UUIDs of the orchestration rules. Limit 100.

limit · integer<int32>

Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000.

order · enum<string>

Sort order for the results. Defaults to DESC by created_at time.

Available options: DESC, ASC

page_cursor · string

Optional Cursor for getting the next page of results.

Response

200 - application/json

A successful response.

rules · object[]

Show child attributes

rules. id · string

Unique identifier for the orchestration rule.

rules. ref_id · string

Unique reference ID for the rule.

rules. nickname · string

Optional human-readable nickname for the rule.

rules. profile_id · string

Profile ID of the account owner.

rules. identity_id · string

Identity ID of the account owner.

rules. account_id · string

Account ID where the rule applies.

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

rules. source_asset · string

Asset being converted from.

rules. destination_asset · string

Asset being converted to.

rules. source · object

Show child attributes

rules.source. crypto · object

Show child attributes

rules.source.crypto. address_id · string

rules.source.crypto. address · string

rules.source.crypto. network · string

rules.source. fiat · object

Show child attributes

rules.source.fiat. deposit_instructions_id · string

rules.source.fiat. network · string

rules.source.fiat. account_type · string

rules.source.fiat. memo_id · string

rules.source. profile · object

Show child attributes

rules.source.profile. profile_id · string

rules. destination · object

Show child attributes

rules.destination. crypto · object

Show child attributes

rules.destination.crypto. address · string

rules.destination.crypto. network · string

rules.destination. fiat · object

Show child attributes

rules.destination.fiat. fiat_account_id · string

rules.destination.fiat. memo · string

rules.destination. profile · object

Show child attributes

rules.destination.profile. profile_id · string

rules. created_at · string<date-time>

Timestamp when the rule was created.

next_page_cursor · string