Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Orchestrations

Create Orchestration

Creates a one-time orchestration that moves assets from a source profile to a destination. Use this endpoint when funds already reside on the Paxos platform and need to be transferred or converted as part of a single workflow.

A request to create an orchestration can fail with one of the following types of errors:

  • Insufficient Funds if the Profile (profile_id) has insufficient available balance to fund the execution.
  • Already Exists if an orchestration with the same external ID (ref_id) has already been created.
post/orchestration/orchestrations

Request body

identity_idstring
account_idstring
ref_idstring required

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.

source_assetstring required
destination_assetstring required
source_amountstring decimal required
metadataobject

Example request

{
  "ref_id": "orch-usdc-usdg-a3b1c2d4",
  "identity_id": "b2c3d4e5-6f7a-8b9c-0d1e-f2a3b4c5d6e7",
  "account_id": "c3d4e5f6-7a8b-9c0d-1e2f-a3b4c5d6e7f8",
  "source_asset": "USDC",
  "source_amount": "100",
  "destination_asset": "USDG",
  "source": {
    "profile": {
      "profile_id": "7c4e8f2a-1d3b-4a5e-9f6c-8b2d7e0a4f1c"
    }
  },
  "destination": {
    "crypto": {
      "address_id": "d4e5f6a7-8b9c-0d1e-2f3a-b4c5d6e7f8a9"
    }
  },
  "metadata": {
    "my_id": "4f8a2b6c-9d1e-4c3a-b5f7-0e2d8a7c1b9f"
  }
}

Response

A successful response.

idstring
profile_idstring
identity_idstring
account_idstring
customer_idstring
ref_idstring

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.

source_assetstring
destination_assetstring
source_amountstring decimal
status'PROCESSING' | 'COMPLETED' | 'FAILED' | 'PENDING' | 'REJECTED'

Status represents the current state of an orchestration.

  • PROCESSING: The orchestration is actively being processed.
  • COMPLETED: The orchestration completed successfully.
  • FAILED: The orchestration failed during processing.
  • PENDING: The orchestration is awaiting approval before processing begins. Once approved, it transitions to PROCESSING. If rejected, it transitions to REJECTED.
  • REJECTED: The orchestration was rejected during approval.
orchestration_rule_idstring

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

created_atstring date-time
updated_atstring date-time
metadataobject

Example response

{
  "id": "e5f6a7b8-9c0d-1e2f-3a4b-c5d6e7f8a9b0",
  "profile_id": "7c4e8f2a-1d3b-4a5e-9f6c-8b2d7e0a4f1c",
  "customer_id": "a1b2c3d4-5e6f-7a8b-9c0d-e1f2a3b4c5d6",
  "ref_id": "orch-usdc-usdg-a3b1c2d4",
  "source_asset": "USDC",
  "destination_asset": "USDG",
  "source_amount": "100",
  "status": "PROCESSING",
  "source": {
    "profile": {
      "profile_id": "7c4e8f2a-1d3b-4a5e-9f6c-8b2d7e0a4f1c"
    }
  },
  "destination": {
    "crypto": {
      "address_id": "d4e5f6a7-8b9c-0d1e-2f3a-b4c5d6e7f8a9"
    }
  },
  "created_at": "2026-04-20T12:30:01.397730Z",
  "updated_at": "2026-04-20T12:30:01.397730Z",
  "metadata": {
    "my_id": "4f8a2b6c-9d1e-4c3a-b5f7-0e2d8a7c1b9f"
  }
}