Skip to main content
GET
/
orchestration
/
orchestrations
/
{id}
Get Orchestration
curl --request GET \
  --url https://api.paxos.com/v2/orchestration/orchestrations/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.paxos.com/v2/orchestration/orchestrations/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paxos.com/v2/orchestration/orchestrations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paxos.com/v2/orchestration/orchestrations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.paxos.com/v2/orchestration/orchestrations/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.paxos.com/v2/orchestration/orchestrations/{id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.paxos.com/v2/orchestration/orchestrations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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"
  }
}
OAuth Scope
orchestration:read_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 โ†’

Path Parameters

id
string
required

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