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

Try it

List Orchestrations

cURL

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

200

{
  "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_id": "<string>",
          "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>"
}

OAuth Scope

orchestration:read_orchestration

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

orchestration_rule_id · string[]

Optionally filter by the initiating orchestration rule ids. There is a limit of 100 orchestration rule ids that can be specified in a single request.

source_asset · string[]

Optionally filter by source assets. There is a limit of 100 source assets that can be specified in a single request.

destination_asset · string[]

Optionally filter by destination assets. There is a limit of 100 destination assets ids that can be specified in a single request.

status · string[]

Optionally filter by statuses. There is a limit of 100 statuses that can be specified in a single request.

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

orchestration_id · string[]

Optionally filter by a list of orchestration IDs. There is a limit of 100 orchestration ids that can be specified in a single request.

profile_id · string[]

Optionally filter by the target profiles. There is a limit of 100 profiles that can be specified in a single request.

Response

200 - application/json

A successful response.

orchestrations · object[]

Show child attributes

orchestrations. id · string

orchestrations. profile_id · string

orchestrations. identity_id · string

orchestrations. account_id · string

orchestrations. customer_id · string

orchestrations. ref_id · string

A client or system-specified unique identifier for the orchestration - used for idempotency protection. Retries of a request should use the same ref_id to avoid duplicate transactions. For system-initiated orchestrations generated by invocation of an orchestration rule, the ref_id is generated the system.

orchestrations. source_asset · string

orchestrations. destination_asset · string

orchestrations. source_amount · string

orchestrations. source_transfer · object

TransferDetails refers to a specific Transfer and encodes its current status.

Show child attributes

orchestrations.source_transfer. transfer_id · string

orchestrations.source_transfer. status · enum<string>

• PENDING: PENDING: a transfer is planned, but its resource_id is not yet known.
• PROCESSING: PROCESSING: a transfer with resource_id is being processed. resource_id is guaranteed to be set if the status is PROCESSING.
• COMPLETED: COMPLETED: a transfer with resource_id has successfully completed.
• FAILED: FAILED: a transfer with resource_id has failed.

Available options: PENDING, PROCESSING, COMPLETED, FAILED

orchestrations. destination_transfer · object

TransferDetails refers to a specific Transfer and encodes its current status.

Show child attributes

orchestrations.destination_transfer. transfer_id · string

orchestrations.destination_transfer. status · enum<string>

• PENDING: PENDING: a transfer is planned, but its resource_id is not yet known.
• PROCESSING: PROCESSING: a transfer with resource_id is being processed. resource_id is guaranteed to be set if the status is PROCESSING.
• COMPLETED: COMPLETED: a transfer with resource_id has successfully completed.
• FAILED: FAILED: a transfer with resource_id has failed.

Available options: PENDING, PROCESSING, COMPLETED, FAILED

orchestrations. status · enum<string>

Status represents the current state of an orchestration.

Available options: PROCESSING, COMPLETED, FAILED

orchestrations. fail_reason · object

Show child attributes

orchestrations.fail_reason. detail · string

orchestrations. source · object

Show child attributes

orchestrations.source. crypto · object

Show child attributes

orchestrations.source.crypto. address_id · string

orchestrations.source.crypto. address · string

orchestrations.source.crypto. network · string

orchestrations.source. fiat · object

Show child attributes

orchestrations.source.fiat. deposit_instructions_id · string

orchestrations.source.fiat. memo · string

orchestrations.source. profile · object

Show child attributes

orchestrations.source.profile. profile_id · string

orchestrations. destination · object

Show child attributes

orchestrations.destination. crypto · object

Show child attributes

orchestrations.destination.crypto. address_id · string

orchestrations.destination.crypto. address · string

orchestrations.destination.crypto. network · string

orchestrations.destination. fiat · object

Show child attributes

orchestrations.destination.fiat. bank_account_id · string

orchestrations.destination.fiat. memo · string

orchestrations.destination. profile · object

Show child attributes

orchestrations.destination.profile. profile_id · string

orchestrations. orchestration_rule_id · string

The ID of the orchestration rule which triggered this orchestration. Can be empty for ad-hoc orchestrations.

orchestrations. created_at · string<date-time>

orchestrations. updated_at · string<date-time>

orchestrations. metadata · Metadata associated with the orchestration · object

Show child attributes

orchestrations.metadata. {key} · string

next_page_cursor · string