GET
/
v2
/
orchestration
/
orchestration-rules
{
  "orchestration_rules": [
    {
      "id": "<string>",
      "ref_id": "<string>",
      "nickname": "<string>",
      "profile_id": "<string>",
      "identity_id": "<string>",
      "account_id": "<string>",
      "status": "PROCESSING",
      "source_asset": "<string>",
      "destination_asset": "<string>",
      "source_deposit_instructions": {
        "crypto": {
          "address_id": "<string>",
          "address": "<string>",
          "network": "<string>"
        },
        "fiat": {
          "id": "<string>",
          "bank_name": "<string>",
          "bank_country": "<string>",
          "bank_address": "<string>",
          "routing_number_type": "ABA",
          "routing_number": "<string>",
          "recipient_name": "<string>",
          "recipient_address": "<string>",
          "account_number": "<string>"
        }
      },
      "destination": {
        "crypto": {
          "address": "<string>",
          "network": "<string>"
        },
        "fiat": {
          "account_id": "<string>",
          "memo": "<string>",
          "network": "<string>"
        },
        "profile": {
          "profile_id": "<string>"
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_page_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
profile_ids
string[]

Optionally filter by the target profiles. Limit 100.

​
ref_ids
string[]

Optionally filter by the target ref_ids.

​
ids
string[]

Optionally filter by orchestration_rule_ids.

​
source_crypto_deposit_address_ids
string[]

Optionally filter by the ID of the rule's source crypto deposit address.

​
source_fiat_deposit_instruction_ids
string[]

Optionally filter by the ID of the rule's source fiat deposit instruction.

​
source_assets
string[]

Optionally filter by source assets

​
destination_assets
string[]

Optionally filter by destination assets

​
statuses
string[]

Optionally filter by statuses.

​
created_at.lt
string<date-time>

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.lte
string<date-time>

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.eq
string<date-time>

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.gte
string<date-time>

Include timestamps greater than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

​
created_at.gt
string<date-time>

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

​
limit
integer

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 insertion time into the Paxos system.

Available options:
DESC,
ASC
​
page_cursor
string

Optional: Cursor for getting the next page of results.

Response

200
application/json

A successful response.

The response is of type object.