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

Create Orchestration

cURL

curl --request POST \
  --url https://api.paxos.com/v2/orchestration/orchestrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ref_id": "<string>",
  "source_asset": "<string>",
  "destination_asset": "<string>",
  "source_amount": "<string>",
  "identity_id": "<string>",
  "account_id": "<string>",
  "source": {
    "profile": {
      "profile_id": "<string>"
    }
  },
  "destination": {
    "crypto": {
      "address_id": "<string>"
    },
    "fiat": {
      "bank_account_id": "<string>",
      "memo": "<string>"
    },
    "profile": {
      "profile_id": "<string>"
    }
  },
  "metadata": {}
}
'

200

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

OAuth Scope

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

Body

application/json

ref_id · string · 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_asset · string · required

destination_asset · string · required

source_amount · string · required

identity_id · string

account_id · string

source · object

Show child attributes

destination · object

Show child attributes

metadata · Metadata associated with the orchestration · object

Show child attributes

Response

200 - application/json

A successful response.

Orchestrations can be created directly via the CreateOrchestration endpoint, or indirectly by an incoming deposit which matches an OrchestrationRule previously defined with the CreateOrchestrationRule endpoint.

id · string

profile_id · string

identity_id · string

account_id · string

customer_id · string

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.

source_asset · string

destination_asset · string

source_amount · string

source_transfer · object

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

Show child attributes

destination_transfer · object

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

Show child attributes

status · enum<string>

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.

Available options: PROCESSING, COMPLETED, FAILED, PENDING, REJECTED

fail_reason · object

Show child attributes

source · object

Show child attributes

destination · object

Show child attributes

orchestration_rule_id · string

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

created_at · string<date-time>

updated_at · string<date-time>

metadata · Metadata associated with the orchestration · object

Show child attributes