Skip to main content
POST
/
orchestration
/
orchestrations
Create Orchestration
curl --request POST \
  --url https://api.paxos.com/v2/orchestration/orchestrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "identity_id": "<string>",
  "account_id": "<string>",
  "ref_id": "<string>",
  "source_asset": "<string>",
  "destination_asset": "<string>",
  "source_amount": "<string>",
  "source": {
    "profile": {
      "profile_id": "<string>"
    }
  },
  "destination": {
    "crypto": {
      "address": "<string>",
      "network": "<string>",
      "address_id": "<string>"
    },
    "fiat": {
      "bank_account_id": "<string>",
      "memo": "<string>"
    },
    "profile": {
      "profile_id": "<string>"
    }
  },
  "metadata": {}
}'
{
  "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>",
      "address_id": "<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:

Learn more in the API credentials guide →

Body

application/json
​
identity_id
string
​
account_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.

​
source_asset
string
​
destination_asset
string
​
source_amount
string
​
source
object
​
destination
object
​
metadata
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
​
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.

Available options:
PROCESSING,
COMPLETED,
FAILED
​
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
object
⌘I