{
  "orchestrations": [
    {
      "id": "<string>",
      "profile_id": "<string>",
      "identity_id": "<string>",
      "account_id": "<string>",
      "customer_id": "<string>",
      "ref_id": "<string>",
      "source_asset": "<string>",
      "destination_asset": "<string>",
      "source_amount": "<string>",
      "source_transfer": {
        "transfer_id": "<string>",
        "status": "PENDING"
      },
      "destination_transfer": {
        "transfer_id": "<string>",
        "status": "PENDING"
      },
      "status": "PROCESSING",
      "fail_reason": {
        "detail": "<string>"
      },
      "source": {
        "crypto": {
          "address_id": "<string>",
          "address": "<string>",
          "network": "<string>"
        },
        "fiat": {
          "deposit_instructions_id": "<string>",
          "memo": "<string>"
        },
        "profile": {
          "profile_id": "<string>"
        }
      },
      "destination": {
        "crypto": {
          "address": "<string>",
          "network": "<string>"
        },
        "fiat": {
          "bank_account_id": "<string>",
          "memo": "<string>"
        },
        "profile": {
          "profile_id": "<string>"
        }
      },
      "orchestration_rule_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "next_page_cursor": "<string>"
}

Orchestrations

List Orchestrations

List all orchestrations, optionally filtering and paging the results.

By default, orchestrations 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 orchestrations which were created.

The paginated results default to display up to 100 orchestrations, 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.

When filtering by profile IDs using the profile_ids parameter, there is a limit of 100 profiles that can be specified in a single request.

Orchestrations are provided for various operations including:

Deposits to a paxos-platform crypto address or bank account
Withdrawals to a customer-owned crypto address or bank account
Conversions from one asset to another
Orchestrated workflows involving some or all of the above
Invocation of an Orchestration Rule

GET

orchestration

orchestrations

{
  "orchestrations": [
    {
      "id": "<string>",
      "profile_id": "<string>",
      "identity_id": "<string>",
      "account_id": "<string>",
      "customer_id": "<string>",
      "ref_id": "<string>",
      "source_asset": "<string>",
      "destination_asset": "<string>",
      "source_amount": "<string>",
      "source_transfer": {
        "transfer_id": "<string>",
        "status": "PENDING"
      },
      "destination_transfer": {
        "transfer_id": "<string>",
        "status": "PENDING"
      },
      "status": "PROCESSING",
      "fail_reason": {
        "detail": "<string>"
      },
      "source": {
        "crypto": {
          "address_id": "<string>",
          "address": "<string>",
          "network": "<string>"
        },
        "fiat": {
          "deposit_instructions_id": "<string>",
          "memo": "<string>"
        },
        "profile": {
          "profile_id": "<string>"
        }
      },
      "destination": {
        "crypto": {
          "address": "<string>",
          "network": "<string>"
        },
        "fiat": {
          "bank_account_id": "<string>",
          "memo": "<string>"
        },
        "profile": {
          "profile_id": "<string>"
        }
      },
      "orchestration_rule_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "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

orchestration_rule_ids

string[]

Optionally filter by the initiating orchestration_rule_ids.

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 created_at time.

Available options:

DESC,

ASC

page_cursor

string

Optional Cursor for getting the next page of results.

orchestration_ids

string[]

Optionally filter by a list of orchestration IDs.

profile_ids

string[]

Optionally filter by the target profiles. Limit 100.

Response

200

application/json

A successful response.

The response is of type object.

Create Orchestration Rule Create Orchestration

Previews

Orchestration Previews

List Orchestrations

Authorizations

Query Parameters

Response