Execute a transaction (send)

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.12/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "quoteId": "qt_0gq9aesz4wb5etdv88z1j61qcm",
  "metadata": {
    "orderId": "order_12345"
  }
}
'

import requests

url = "https://sandbox-api.polygon.technology/v0.12/transactions"

payload = {
    "quoteId": "qt_0gq9aesz4wb5etdv88z1j61qcm",
    "metadata": { "orderId": "order_12345" }
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({quoteId: 'qt_0gq9aesz4wb5etdv88z1j61qcm', metadata: {orderId: 'order_12345'}})
};

fetch('https://sandbox-api.polygon.technology/v0.12/transactions', 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://sandbox-api.polygon.technology/v0.12/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'quoteId' => 'qt_0gq9aesz4wb5etdv88z1j61qcm',
    'metadata' => [
        'orderId' => 'order_12345'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://sandbox-api.polygon.technology/v0.12/transactions"

	payload := strings.NewReader("{\n  \"quoteId\": \"qt_0gq9aesz4wb5etdv88z1j61qcm\",\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.polygon.technology/v0.12/transactions")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"quoteId\": \"qt_0gq9aesz4wb5etdv88z1j61qcm\",\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.12/transactions")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"quoteId\": \"qt_0gq9aesz4wb5etdv88z1j61qcm\",\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "txn_hdgebv2mns4af7pgs5r6kkacxh",
  "object": "transaction",
  "sourceToDestination": "cryptoToFiatAccount",
  "status": "processing",
  "subStatus": "processing.fundsPulled",
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "precursor": {
    "type": "quote",
    "id": "qt_0gq9aesz4wb5etdv88z1j61qcm"
  },
  "source": {
    "party": {
      "relationship": "customer",
      "id": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
      "name": "Jane Smith"
    },
    "type": "walletCrypto",
    "category": "crypto",
    "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
    "asset": "usdc",
    "network": "polygon",
    "displayName": "0x7B3A9F2C4D1eA8bf6390cE5D2b7fA104c8e3D9B1"
  },
  "destination": {
    "party": {
      "relationship": "externalRegistered",
      "id": "ctp_yp5z8m7n22svc0vh6edqgcfdat",
      "name": "Alice Smith"
    },
    "type": "bankUs",
    "category": "fiatAccount",
    "id": "ext_fky491gakzj0dd46qb6whsr2vq",
    "asset": "usd",
    "network": "ach",
    "secCode": "web",
    "displayName": "••••1234",
    "payoutOrigin": {
      "type": "bank",
      "id": "va_e6nfr4q5jj9bwgb1pyx70wzxta"
    }
  },
  "pricing": {
    "source": {
      "asset": "usdc",
      "amountGross": "100.00",
      "amountNet": "100.00",
      "feesDeducted": {
        "total": "0.00",
        "developer": "0.00",
        "oms": "0.00",
        "gas": "0.00"
      }
    },
    "destination": {
      "asset": "usd",
      "amountGross": "100.00",
      "amountNet": "100.00",
      "feesDeducted": {
        "total": "0.00",
        "developer": "0.00",
        "oms": "0.00",
        "gas": "0.00"
      }
    },
    "pair": "usdc/usd",
    "exchangeRate": "1.0000",
    "effectiveRate": "1.0000",
    "fixedAmountSide": "source",
    "sponsorGas": true,
    "sponsorGasCost": "0.00"
  },
  "estimatedArrival": "2026-03-14T19:30:00Z",
  "metadata": {
    "orderId": "order_12345"
  },
  "createdAt": "2026-03-14T19:00:00Z",
  "updatedAt": "2026-03-14T19:00:20Z"
}

{
  "id": "<string>",
  "object": "transaction",
  "status": "processing",
  "subStatus": "processing.fundsPulled",
  "customerId": "<string>",
  "precursor": {
    "type": "quote",
    "id": "<string>"
  },
  "source": {
    "type": "walletCrypto",
    "category": "crypto",
    "id": "<string>",
    "asset": "<string>",
    "network": "<string>",
    "displayName": "<string>",
    "party": {
      "relationship": "customer",
      "id": "<string>",
      "name": "<string>"
    },
    "memo": "<string>"
  },
  "destination": {
    "type": "walletCrypto",
    "category": "crypto",
    "id": "<string>",
    "asset": "<string>",
    "network": "<string>",
    "displayName": "<string>",
    "party": {
      "relationship": "customer",
      "id": "<string>",
      "name": "<string>"
    },
    "memo": "<string>",
    "payoutOrigin": {
      "type": "bank",
      "id": "<string>"
    },
    "companyDiscretionaryData": "<string>"
  },
  "pricing": {
    "source": {
      "asset": "<string>",
      "amountGross": "<string>",
      "amountNet": "<string>",
      "feesDeducted": {
        "total": "<string>",
        "developer": "<string>",
        "oms": "<string>",
        "gas": "<string>"
      }
    },
    "destination": {
      "asset": "<string>",
      "amountGross": "<string>",
      "amountNet": "<string>",
      "feesDeducted": {
        "total": "<string>",
        "developer": "<string>",
        "oms": "<string>",
        "gas": "<string>"
      }
    },
    "pair": "<string>",
    "exchangeRate": "<string>",
    "effectiveRate": "<string>",
    "fixedAmountSide": "source",
    "sponsorGas": true,
    "sponsorGasCost": "<string>"
  },
  "sourceToDestination": "cryptoToCrypto",
  "customer": {
    "id": "<string>",
    "name": "<string>"
  },
  "estimatedArrival": "2023-11-07T05:31:56Z",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "occurredAt": "2023-11-07T05:31:56Z",
    "recoverable": true,
    "manualRecovery": {
      "type": "manualRecovery",
      "custodian": "ANCHORAGE_SG",
      "instructions": "<string>",
      "referenceFields": {
        "transactionId": "<string>",
        "sourceTxHash": "<string>"
      }
    }
  },
  "hold": {
    "type": "senderAttribution",
    "required": true,
    "since": "2023-11-07T05:31:56Z",
    "deadline": "2023-11-07T05:31:56Z",
    "resolvedAt": "2023-11-07T05:31:56Z",
    "matchableExternalAccountCriteria": {
      "type": "walletExternal",
      "blockchainAddress": "<string>",
      "networkFamily": "<string>"
    }
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "projectId": "<string>"
}

POST

transactions

Execute a transaction (send)

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.12/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "quoteId": "qt_0gq9aesz4wb5etdv88z1j61qcm",
  "metadata": {
    "orderId": "order_12345"
  }
}
'

import requests

url = "https://sandbox-api.polygon.technology/v0.12/transactions"

payload = {
    "quoteId": "qt_0gq9aesz4wb5etdv88z1j61qcm",
    "metadata": { "orderId": "order_12345" }
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({quoteId: 'qt_0gq9aesz4wb5etdv88z1j61qcm', metadata: {orderId: 'order_12345'}})
};

fetch('https://sandbox-api.polygon.technology/v0.12/transactions', 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://sandbox-api.polygon.technology/v0.12/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'quoteId' => 'qt_0gq9aesz4wb5etdv88z1j61qcm',
    'metadata' => [
        'orderId' => 'order_12345'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://sandbox-api.polygon.technology/v0.12/transactions"

	payload := strings.NewReader("{\n  \"quoteId\": \"qt_0gq9aesz4wb5etdv88z1j61qcm\",\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.polygon.technology/v0.12/transactions")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"quoteId\": \"qt_0gq9aesz4wb5etdv88z1j61qcm\",\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.12/transactions")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"quoteId\": \"qt_0gq9aesz4wb5etdv88z1j61qcm\",\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "txn_hdgebv2mns4af7pgs5r6kkacxh",
  "object": "transaction",
  "sourceToDestination": "cryptoToFiatAccount",
  "status": "processing",
  "subStatus": "processing.fundsPulled",
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "precursor": {
    "type": "quote",
    "id": "qt_0gq9aesz4wb5etdv88z1j61qcm"
  },
  "source": {
    "party": {
      "relationship": "customer",
      "id": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
      "name": "Jane Smith"
    },
    "type": "walletCrypto",
    "category": "crypto",
    "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
    "asset": "usdc",
    "network": "polygon",
    "displayName": "0x7B3A9F2C4D1eA8bf6390cE5D2b7fA104c8e3D9B1"
  },
  "destination": {
    "party": {
      "relationship": "externalRegistered",
      "id": "ctp_yp5z8m7n22svc0vh6edqgcfdat",
      "name": "Alice Smith"
    },
    "type": "bankUs",
    "category": "fiatAccount",
    "id": "ext_fky491gakzj0dd46qb6whsr2vq",
    "asset": "usd",
    "network": "ach",
    "secCode": "web",
    "displayName": "••••1234",
    "payoutOrigin": {
      "type": "bank",
      "id": "va_e6nfr4q5jj9bwgb1pyx70wzxta"
    }
  },
  "pricing": {
    "source": {
      "asset": "usdc",
      "amountGross": "100.00",
      "amountNet": "100.00",
      "feesDeducted": {
        "total": "0.00",
        "developer": "0.00",
        "oms": "0.00",
        "gas": "0.00"
      }
    },
    "destination": {
      "asset": "usd",
      "amountGross": "100.00",
      "amountNet": "100.00",
      "feesDeducted": {
        "total": "0.00",
        "developer": "0.00",
        "oms": "0.00",
        "gas": "0.00"
      }
    },
    "pair": "usdc/usd",
    "exchangeRate": "1.0000",
    "effectiveRate": "1.0000",
    "fixedAmountSide": "source",
    "sponsorGas": true,
    "sponsorGasCost": "0.00"
  },
  "estimatedArrival": "2026-03-14T19:30:00Z",
  "metadata": {
    "orderId": "order_12345"
  },
  "createdAt": "2026-03-14T19:00:00Z",
  "updatedAt": "2026-03-14T19:00:20Z"
}

{
  "id": "<string>",
  "object": "transaction",
  "status": "processing",
  "subStatus": "processing.fundsPulled",
  "customerId": "<string>",
  "precursor": {
    "type": "quote",
    "id": "<string>"
  },
  "source": {
    "type": "walletCrypto",
    "category": "crypto",
    "id": "<string>",
    "asset": "<string>",
    "network": "<string>",
    "displayName": "<string>",
    "party": {
      "relationship": "customer",
      "id": "<string>",
      "name": "<string>"
    },
    "memo": "<string>"
  },
  "destination": {
    "type": "walletCrypto",
    "category": "crypto",
    "id": "<string>",
    "asset": "<string>",
    "network": "<string>",
    "displayName": "<string>",
    "party": {
      "relationship": "customer",
      "id": "<string>",
      "name": "<string>"
    },
    "memo": "<string>",
    "payoutOrigin": {
      "type": "bank",
      "id": "<string>"
    },
    "companyDiscretionaryData": "<string>"
  },
  "pricing": {
    "source": {
      "asset": "<string>",
      "amountGross": "<string>",
      "amountNet": "<string>",
      "feesDeducted": {
        "total": "<string>",
        "developer": "<string>",
        "oms": "<string>",
        "gas": "<string>"
      }
    },
    "destination": {
      "asset": "<string>",
      "amountGross": "<string>",
      "amountNet": "<string>",
      "feesDeducted": {
        "total": "<string>",
        "developer": "<string>",
        "oms": "<string>",
        "gas": "<string>"
      }
    },
    "pair": "<string>",
    "exchangeRate": "<string>",
    "effectiveRate": "<string>",
    "fixedAmountSide": "source",
    "sponsorGas": true,
    "sponsorGasCost": "<string>"
  },
  "sourceToDestination": "cryptoToCrypto",
  "customer": {
    "id": "<string>",
    "name": "<string>"
  },
  "estimatedArrival": "2023-11-07T05:31:56Z",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "occurredAt": "2023-11-07T05:31:56Z",
    "recoverable": true,
    "manualRecovery": {
      "type": "manualRecovery",
      "custodian": "ANCHORAGE_SG",
      "instructions": "<string>",
      "referenceFields": {
        "transactionId": "<string>",
        "sourceTxHash": "<string>"
      }
    }
  },
  "hold": {
    "type": "senderAttribution",
    "required": true,
    "since": "2023-11-07T05:31:56Z",
    "deadline": "2023-11-07T05:31:56Z",
    "resolvedAt": "2023-11-07T05:31:56Z",
    "matchableExternalAccountCriteria": {
      "type": "walletExternal",
      "blockchainAddress": "<string>",
      "networkFamily": "<string>"
    }
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "projectId": "<string>"
}

Authorizations

Authorization

string

header

required

Token from POST /auth/token

Headers

Idempotency-Key

string

required

Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.

Body

application/json

Request body for executing a transaction. References the quote to accept; the remaining fields are optional routing hints and metadata.

quoteId

string

required

The quote to accept (qt_ prefix). Must be open with non-expired pricing.

deviceFingerprint

string

Device fingerprint of the end user, used for risk screening.

externalAccountId

string

The BPN external-account id of the debit card funding (buy) or receiving (sell) this transaction. BPN resolves it to the Coinme paymentMethodId.

paymentMethodId

string

Deprecated for cards: raw Coinme paymentMethodId passthrough. Use externalAccountId instead.

partnerTransactionId

integer<int32>

Your own transaction reference, for reconciliation.

externalCustodyCreditInfo

object

External custody credit details, required for EXTERNAL settlement.

Hide child attributes

externalCustodyCreditInfo.walletAddress

string

required

On-chain wallet address.

externalCustodyCreditInfo.blockchainMemo

string

On-chain memo/tag to attach to the credit.

sourceWalletAddress

string

Expected sending address for crypto-funded transactions.

Response

The request has succeeded and a new resource has been created as a result.

A single movement of money from a source to a destination. Created by accepting a quote, or generated automatically by a deposit address, virtual account, or cash-in. Track its progress with status.

string

required

Transaction ID (txn_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

object

enum<string>

required

Resource type discriminator. Always "transaction".

Available options:

transaction

status

enum<string>

required

Current lifecycle status. See subStatus for finer granularity.

Available options:

processing,

awaitingAction,

completed,

failed

subStatus

enum<string>

required

Status-scoped sub-state (e.g. processing.fundsPulled). Always present: each status carries a default member (e.g. processing.initiated) when no more specific value applies.

Available options:

processing.fundsPulled,

processing.cashPickupReady,

processing.underReview,

completed.cashPickupCollected,

completed.cashPickupExpired,

awaitingAction.awaitingSenderAttribution,

awaitingAction.depositAddressFrozen,

awaitingAction.depositAddressInactive,

failed.attributionTimeout,

failed.depositAddressFrozenTimeout,

failed.depositAddressInactiveTimeout,

failed.depositAddressClosed,

processing.awaitingCryptoOut,

processing.cryptoOut,

processing.awaitingFiatOut,

processing.fiatOut,

processing.inboundPending,

processing.inboundProcessing,

failed.inboundFailed,

failed.returnPending,

failed.returnStarted,

failed.returnComplete,

failed.returnFailed,

processing.initiated,

awaitingAction.held,

completed.settled,

failed.unspecified,

failed.expired,

failed.outboundFailed

customerId

string

required

The owning (sender) customer. OMSX customer TypeID (cst_…).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

precursor

object | null

required

What created this transaction, as a uniform {type, id} reference — dereference the resource by id for its full record. null for a genuine out-of-band arrival with no originating OMS resource at all (e.g. funds pushed directly to a wallet from outside OMS); the manual arm (id: null) is reserved for a future operator-initiated transaction, distinct from an out-of-band arrival.

Hide child attributes

precursor.type

enum<string>

required

Available options:

quote,

depositAddress,

virtualAccount,

cashIn,

manual

precursor.id

string | null

required

qt_ / da_ / va_ / ci_. Null only for manual.

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

source

OMS wallet · object

required

The funding side: a typed instrument carrying identity and detail.

Hide child attributes

source.type

enum<string>

required

Type discriminator.

Available options:

walletCrypto

source.category

enum<string>

required

High-level grouping: fiatAccount for bank or card accounts, crypto for wallets.

Available options:

crypto

source.id

string | null

required

OMS wallet ID (wlt_ prefix).

DEVIATION from the ratified OMS v0.12 contract (docs/specs/2026-08-05-oms-v0.12-openapi.yaml, WalletCryptoInstrument): the ratified shape has id required and non-nullable. A row can classify as this arm (destination_type=walletCrypto/legacy walletOms, per #2528) before the wallet FK has actually resolved — the "in-flight deposit" window destInstrumentKind's own doc comment describes — so id is nullable rather than emitting an empty string that fails the typeId scalar's pattern. Not recorded in the upstream snapshot's §4 errata (that section is for defects IN the ratified snapshot, not BPN's own accepted deviations from it) — flagged here and in the PR description instead, same class as the CardInstrument.id/WalletFiatInstrument.id/ BankUsInstrument.network deviations elsewhere in this same change.

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

source.asset

string

required

Canonical asset identifier.

source.network

string

required

Network identifier.

source.displayName

string

required

Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN.

source.party

object

Structured identity of who is on this side.

Hide child attributes

source.party.relationship

enum<string>

required

Which kind of party this is.

Available options:

customer,

otherCustomer,

externalRegistered,

externalUnregistered

source.party.id

string | null

required

cst_ for customer/otherCustomer; ctp_ for externalRegistered; null for externalUnregistered.

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

source.party.name

string | null

required

Display name. Null only when genuinely unknown (an unattributed external sender).

source.memo

string

Free-text message travelling with the transfer on this side's rail.

destination

OMS wallet · object

required

The receiving side: a typed instrument plus payoutOrigin.

Hide child attributes

destination.type

enum<string>

required

Type discriminator.

Available options:

walletCrypto

destination.category

enum<string>

required

High-level grouping: fiatAccount for bank or card accounts, crypto for wallets.

Available options:

crypto

destination.id

string | null

required

OMS wallet ID (wlt_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

destination.asset

string

required

Canonical asset identifier.

destination.network

string

required

Network identifier.

destination.displayName

string

required

Opaque, render-only summary for list/detail display. Never a full account number/IBAN/PAN.

destination.party

object

Structured identity of who is on this side.

Hide child attributes

destination.party.relationship

enum<string>

required

Which kind of party this is.

Available options:

customer,

otherCustomer,

externalRegistered,

externalUnregistered

destination.party.id

string | null

required

cst_ for customer/otherCustomer; ctp_ for externalRegistered; null for externalUnregistered.

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

destination.party.name

string | null

required

Display name. Null only when genuinely unknown (an unattributed external sender).

destination.memo

string

Free-text message travelling with the transfer on this side's rail.

destination.payoutOrigin

object

Where last-mile delivery is sent from, as a uniform {type, id} reference — response-only. id is the Virtual Account (va_) or OMS wallet (wlt_) funding the leg; null before execution (Quote / Deposit Address echo the choice only) or when the origin has no partner-visible resource. Rail identifiers for the last-mile transfer live in the top-level tracking array with leg: destination — not here.

Hide child attributes

destination.payoutOrigin.type

enum<string>

required

Available options:

bank,

blockchain

destination.payoutOrigin.id

string | null

required

Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

destination.companyDiscretionaryData

string

Echo of the ACH companyDiscretionaryData supplied on the originating request. Null/absent on non-ACH destinations or when not supplied.

pricing

object

required

Consolidated economics.

Hide child attributes

pricing.source

object

Economics for the source side, denominated in the source asset.

Hide child attributes

pricing.source.asset

string

Currency these amounts are in. Same as the side's instrument asset, repeated here so pricing is self-contained.

pricing.source.amountGross

string

Amount on this side before fees are applied.

pricing.source.amountNet

string

Amount after fees: what is actually pulled from a source, or delivered to a destination.

pricing.source.feesDeducted

object

Itemized fees deducted on this side.

Hide child attributes

pricing.source.feesDeducted.total

string

required

pricing.source.feesDeducted.developer

string

required

Per-side aggregated developer fee total in this side's asset. Always "0" in alpha - alpha invariant, mirrors the gas line.

pricing.source.feesDeducted.oms

string

required

pricing.source.feesDeducted.gas

string

required

pricing.destination

object

Economics for the destination side, denominated in the destination asset.

Hide child attributes

pricing.destination.asset

string

Currency these amounts are in. Same as the side's instrument asset, repeated here so pricing is self-contained.

pricing.destination.amountGross

string

Amount on this side before fees are applied.

pricing.destination.amountNet

string

Amount after fees: what is actually pulled from a source, or delivered to a destination.

pricing.destination.feesDeducted

object

Itemized fees deducted on this side.

Hide child attributes

pricing.destination.feesDeducted.total

string

required

pricing.destination.feesDeducted.developer

string

required

Per-side aggregated developer fee total in this side's asset. Always "0" in alpha - alpha invariant, mirrors the gas line.

pricing.destination.feesDeducted.oms

string

required

pricing.destination.feesDeducted.gas

string

required

pricing.pair

string

Asset pair, e.g. "usdc/usd".

pricing.exchangeRate

string

Mid-market rate between source and destination assets. Identity: source.amountNet × exchangeRate = destination.amountGross.

pricing.effectiveRate

string

All-in rate including all fees. Identity: source.amountGross × effectiveRate = destination.amountNet.

pricing.fixedAmountSide

enum<string>

The side you set amount on when creating the quote. OMS calculated the other side.

Available options:

source,

destination

When true, OMS absorbs the destination gas cost. Currently always true.

Gas absorbed by the developer when sponsorGas is true. Currently always 0.00.

sourceToDestination

enum<string>

Corridor composite derived from the two sides.

Available options:

cryptoToCrypto,

cryptoToCash,

cryptoToFiatAccount,

cashToCrypto,

fiatAccountToCrypto,

fiatAccountToFiatAccount

customer

object

Resolved id + display name of the owning customer, so list/detail rendering needs no follow-up customer fetch (v0.12, #2665).

Hide child attributes

customer.id

string

required

The OMS customer id (cst_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

customer.name

string

required

Customer display name.

estimatedArrival

string<date-time>

Estimated completion time. Present when the destination rail has a predictable settlement time (e.g. bank payouts and some crypto legs); null otherwise.

error

object

Failure detail. Set when the transaction fails; includes refund or recovery state where applicable.

Hide child attributes

error.code

string

required

Machine-readable code.

error.message

string

required

Human-readable detail.

error.occurredAt

string<date-time>

required

When the error occurred.

error.recoverable

boolean

required

Whether the failure can be recovered.

error.manualRecovery

object

Populated only for terminal failures with no resolved refund/return path (v0.11).

Hide child attributes

error.manualRecovery.type

enum<string>

Available options:

manualRecovery

error.manualRecovery.custodian

enum<string>

Available options:

ANCHORAGE_SG,

ANCHORAGE_US,

AQUANOW_CA,

B2C2_UK,

B2C2_US,

BITGO_SG,

BITGO_US,

BITSTAMP_US,

BVNK_US,

CIRCLE_FR,

CIRCLE_US,

CITIBANK_US,

COINBASE_US,

COINSMART_CA,

COPPER_CH,

COPPER_UK,

CUMBERLAND_DRW_LLC_US,

CUMBERLAND_SG,

EREBOR_BANK_US,

FALCONX_US,

FIDELITY_UK,

FIDELITY_US,

FIREBLOCKS_APAC,

FIREBLOCKS_US,

GALAXY_KY,

GEMINI_US,

KRAKEN_BVI,

KRAKEN_EU_IE,

KRAKEN_UK,

KRAKEN_US,

NUBANK_BR,

PAXOS_US,

RAMP_NETWORK_US,

ROBINHOOD_US,

WINTERMUTE_GB,

SELF_HOSTED,

OTHER

error.manualRecovery.instructions

string

error.manualRecovery.referenceFields

object

Reference identifiers for an operator-driven recovery.

Hide child attributes

error.manualRecovery.referenceFields.transactionId

string

Transaction ID (txn_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

error.manualRecovery.referenceFields.sourceTxHash

string

Transaction hash of the originating inbound transfer.

hold

Sender attribution · object

Present while status is awaitingAction; explains the hold + deadline. Populated when the hold model is wired.

Sender attribution
Deposit address frozen
Deposit address inactive

Hide child attributes

hold.type

enum<string>

required

Type discriminator.

Available options:

senderAttribution

hold.required

boolean

Whether the hold is still blocking; false once resolved.

hold.since

string<date-time>

When the hold started.

hold.deadline

string<date-time>

Deadline to resolve before timeout.

hold.resolvedAt

string<date-time>

When the hold was resolved; null while outstanding.

hold.matchableExternalAccountCriteria

object

Registering a matching walletExternal EA releases this hold.

Hide child attributes

hold.matchableExternalAccountCriteria.type

enum<string>

Always walletExternal — the EA type that resolves the hold.

Available options:

walletExternal

hold.matchableExternalAccountCriteria.blockchainAddress

string

On-chain address.

hold.matchableExternalAccountCriteria.networkFamily

string

Network family (e.g. evm).

metadata

object

Free-form key-value pairs supplied at creation or update.

Hide child attributes

metadata.{key}

string

createdAt

string<date-time>

When the transaction was created.

updatedAt

string<date-time>

When the transaction was last updated.

expiresAt

string<date-time>

Expiry of the transaction's actionable window: present on auto-created transactions and on cash payouts (the pickup-code expiry), and retained after completion for audit. Null for other quote-initiated transactions.

projectId

string

The owning project. Populated only on the cross-project admin endpoints (e.g. GET /admin/transactions/redrivable) so operators can tell which project a stranded transaction belongs to. Omitted on partner endpoints, where the project is implicit from the auth token.

Pattern: ^prj_.+$

⌘I

Overview

Move money

Routes

External Payment Methods

Platform

Execute a transaction (send)

Authorizations

Headers

Body

Response