Skip to main content
POST
Create Orchestration
OAuth Scope

Authorizations

Authorization
string
header
required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

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<decimal>
required
identity_id
string
account_id
string
source
object
destination
object
metadata
Metadata associated with the orchestration · object

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<decimal>
source_transfer
object

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

destination_transfer
object

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

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
source
object
destination
object
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