Create a payment quote

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.13/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "source": {
    "type": "walletCrypto",
    "details": {
      "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
      "asset": "usdc",
      "network": "polygon"
    },
    "amount": "100.00"
  },
  "destination": {
    "type": "bankUs",
    "details": {
      "id": "ext_fky491gakzj0dd46qb6whsr2vq",
      "asset": "usd",
      "network": "ach"
    }
  },
  "sponsorGas": true,
  "metadata": {
    "orderId": "order_12345"
  }
}
'

import requests

url = "https://sandbox-api.polygon.technology/v0.13/quotes"

payload = {
    "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
    "source": {
        "type": "walletCrypto",
        "details": {
            "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
            "asset": "usdc",
            "network": "polygon"
        },
        "amount": "100.00"
    },
    "destination": {
        "type": "bankUs",
        "details": {
            "id": "ext_fky491gakzj0dd46qb6whsr2vq",
            "asset": "usd",
            "network": "ach"
        }
    },
    "sponsorGas": True,
    "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({
    customerId: 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    source: {
      type: 'walletCrypto',
      details: {id: 'wlt_5h4jzzpr9xre3bamd9ca7qyghn', asset: 'usdc', network: 'polygon'},
      amount: '100.00'
    },
    destination: {
      type: 'bankUs',
      details: {id: 'ext_fky491gakzj0dd46qb6whsr2vq', asset: 'usd', network: 'ach'}
    },
    sponsorGas: true,
    metadata: {orderId: 'order_12345'}
  })
};

fetch('https://sandbox-api.polygon.technology/v0.13/quotes', 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.13/quotes",
  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([
    'customerId' => 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    'source' => [
        'type' => 'walletCrypto',
        'details' => [
                'id' => 'wlt_5h4jzzpr9xre3bamd9ca7qyghn',
                'asset' => 'usdc',
                'network' => 'polygon'
        ],
        'amount' => '100.00'
    ],
    'destination' => [
        'type' => 'bankUs',
        'details' => [
                'id' => 'ext_fky491gakzj0dd46qb6whsr2vq',
                'asset' => 'usd',
                'network' => 'ach'
        ]
    ],
    'sponsorGas' => true,
    '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.13/quotes"

	payload := strings.NewReader("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"source\": {\n    \"type\": \"walletCrypto\",\n    \"details\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\",\n      \"asset\": \"usdc\",\n      \"network\": \"polygon\"\n    },\n    \"amount\": \"100.00\"\n  },\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"ext_fky491gakzj0dd46qb6whsr2vq\",\n      \"asset\": \"usd\",\n      \"network\": \"ach\"\n    }\n  },\n  \"sponsorGas\": true,\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.13/quotes")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"source\": {\n    \"type\": \"walletCrypto\",\n    \"details\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\",\n      \"asset\": \"usdc\",\n      \"network\": \"polygon\"\n    },\n    \"amount\": \"100.00\"\n  },\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"ext_fky491gakzj0dd46qb6whsr2vq\",\n      \"asset\": \"usd\",\n      \"network\": \"ach\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"source\": {\n    \"type\": \"walletCrypto\",\n    \"details\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\",\n      \"asset\": \"usdc\",\n      \"network\": \"polygon\"\n    },\n    \"amount\": \"100.00\"\n  },\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"ext_fky491gakzj0dd46qb6whsr2vq\",\n      \"asset\": \"usd\",\n      \"network\": \"ach\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}"

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

{
  "id": "qt_0gq9aesz4wb5etdv88z1j61qcm",
  "object": "quote",
  "status": "open",
  "sourceToDestination": "cryptoToFiatAccount",
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "customer": {
    "id": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
    "name": "Jane Smith"
  },
  "source": {
    "type": "walletCrypto",
    "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
    "asset": "usdc",
    "network": "polygon",
    "details": {
      "address": "0x7B3A9F2C4D1eA8bf6390cE5D2b7fA104c8e3D9B1"
    }
  },
  "destination": {
    "owner": {
      "kind": "counterparty",
      "id": "ctp_yp5z8m7n22svc0vh6edqgcfdat",
      "name": "Alice Smith"
    },
    "type": "bankUs",
    "id": "ext_fky491gakzj0dd46qb6whsr2vq",
    "asset": "usd",
    "network": "ach",
    "details": {
      "accountNumberLast4": "1234",
      "holderName": "Alice Smith"
    },
    "payoutOrigin": {
      "type": "bank",
      "accountHolder": "customer",
      "accountHolderName": "Jane Smith"
    }
  },
  "pricing": {
    "source": {
      "asset": "usdc",
      "amount": "100.000000"
    },
    "destination": {
      "asset": "usd",
      "amount": "100.00"
    },
    "fees": [],
    "exchangeRate": "1.0000",
    "fixedAmountSide": "source",
    "sponsorGas": true
  },
  "expiresAt": "2026-03-14T19:15:00Z",
  "createdAt": "2026-03-14T19:00:00Z"
}

{
  "error": "CustomerRequired",
  "code": 10125,
  "msg": "customer_id is required",
  "cause": "<string>"
}

{
  "error": "FeatureNotEnabled",
  "code": 10153,
  "msg": "cash offramp is not enabled for this partner",
  "cause": "<string>"
}

{
  "error": "ExternalAccountNotFound",
  "code": 10066,
  "msg": "external account not found",
  "cause": "<string>"
}

{
  "error": "AboveMaximumAmount",
  "code": 10110,
  "msg": "amount exceeds the maximum (cash_onramp legacy)",
  "cause": "<string>"
}

{
  "error": "Internal",
  "code": 10124,
  "msg": "internal error",
  "cause": "<string>"
}

{
  "error": "BankRailUnavailable",
  "code": 10295,
  "msg": "bank payment rail is unavailable",
  "cause": "<string>"
}

Quotes

Create a payment quote

Creates a payment quote with a locked exchange rate and fee breakdown for a prospective transfer. Quotes expire after a short window; reference the returned quote ID when executing the transaction. Pass an Idempotency-Key header to safely retry.

A disallowed source→destination instrument pair is rejected with 422 unsupportedInstrumentCombination before any quote is created; the error body carries a details object of { source, destination, supportedDestinations }. (Not modeled as a typed error arm here so the other 422 codes on this operation keep their shape.)

POST

quotes

curl --request POST \
  --url https://sandbox-api.polygon.technology/v0.13/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "source": {
    "type": "walletCrypto",
    "details": {
      "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
      "asset": "usdc",
      "network": "polygon"
    },
    "amount": "100.00"
  },
  "destination": {
    "type": "bankUs",
    "details": {
      "id": "ext_fky491gakzj0dd46qb6whsr2vq",
      "asset": "usd",
      "network": "ach"
    }
  },
  "sponsorGas": true,
  "metadata": {
    "orderId": "order_12345"
  }
}
'

import requests

url = "https://sandbox-api.polygon.technology/v0.13/quotes"

payload = {
    "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
    "source": {
        "type": "walletCrypto",
        "details": {
            "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
            "asset": "usdc",
            "network": "polygon"
        },
        "amount": "100.00"
    },
    "destination": {
        "type": "bankUs",
        "details": {
            "id": "ext_fky491gakzj0dd46qb6whsr2vq",
            "asset": "usd",
            "network": "ach"
        }
    },
    "sponsorGas": True,
    "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({
    customerId: 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    source: {
      type: 'walletCrypto',
      details: {id: 'wlt_5h4jzzpr9xre3bamd9ca7qyghn', asset: 'usdc', network: 'polygon'},
      amount: '100.00'
    },
    destination: {
      type: 'bankUs',
      details: {id: 'ext_fky491gakzj0dd46qb6whsr2vq', asset: 'usd', network: 'ach'}
    },
    sponsorGas: true,
    metadata: {orderId: 'order_12345'}
  })
};

fetch('https://sandbox-api.polygon.technology/v0.13/quotes', 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.13/quotes",
  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([
    'customerId' => 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
    'source' => [
        'type' => 'walletCrypto',
        'details' => [
                'id' => 'wlt_5h4jzzpr9xre3bamd9ca7qyghn',
                'asset' => 'usdc',
                'network' => 'polygon'
        ],
        'amount' => '100.00'
    ],
    'destination' => [
        'type' => 'bankUs',
        'details' => [
                'id' => 'ext_fky491gakzj0dd46qb6whsr2vq',
                'asset' => 'usd',
                'network' => 'ach'
        ]
    ],
    'sponsorGas' => true,
    '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.13/quotes"

	payload := strings.NewReader("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"source\": {\n    \"type\": \"walletCrypto\",\n    \"details\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\",\n      \"asset\": \"usdc\",\n      \"network\": \"polygon\"\n    },\n    \"amount\": \"100.00\"\n  },\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"ext_fky491gakzj0dd46qb6whsr2vq\",\n      \"asset\": \"usd\",\n      \"network\": \"ach\"\n    }\n  },\n  \"sponsorGas\": true,\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.13/quotes")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"source\": {\n    \"type\": \"walletCrypto\",\n    \"details\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\",\n      \"asset\": \"usdc\",\n      \"network\": \"polygon\"\n    },\n    \"amount\": \"100.00\"\n  },\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"ext_fky491gakzj0dd46qb6whsr2vq\",\n      \"asset\": \"usd\",\n      \"network\": \"ach\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"customerId\": \"cst_vfa0nxw6zvyws9g237jrxn4y7k\",\n  \"source\": {\n    \"type\": \"walletCrypto\",\n    \"details\": {\n      \"id\": \"wlt_5h4jzzpr9xre3bamd9ca7qyghn\",\n      \"asset\": \"usdc\",\n      \"network\": \"polygon\"\n    },\n    \"amount\": \"100.00\"\n  },\n  \"destination\": {\n    \"type\": \"bankUs\",\n    \"details\": {\n      \"id\": \"ext_fky491gakzj0dd46qb6whsr2vq\",\n      \"asset\": \"usd\",\n      \"network\": \"ach\"\n    }\n  },\n  \"sponsorGas\": true,\n  \"metadata\": {\n    \"orderId\": \"order_12345\"\n  }\n}"

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

{
  "id": "qt_0gq9aesz4wb5etdv88z1j61qcm",
  "object": "quote",
  "status": "open",
  "sourceToDestination": "cryptoToFiatAccount",
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "customer": {
    "id": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
    "name": "Jane Smith"
  },
  "source": {
    "type": "walletCrypto",
    "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
    "asset": "usdc",
    "network": "polygon",
    "details": {
      "address": "0x7B3A9F2C4D1eA8bf6390cE5D2b7fA104c8e3D9B1"
    }
  },
  "destination": {
    "owner": {
      "kind": "counterparty",
      "id": "ctp_yp5z8m7n22svc0vh6edqgcfdat",
      "name": "Alice Smith"
    },
    "type": "bankUs",
    "id": "ext_fky491gakzj0dd46qb6whsr2vq",
    "asset": "usd",
    "network": "ach",
    "details": {
      "accountNumberLast4": "1234",
      "holderName": "Alice Smith"
    },
    "payoutOrigin": {
      "type": "bank",
      "accountHolder": "customer",
      "accountHolderName": "Jane Smith"
    }
  },
  "pricing": {
    "source": {
      "asset": "usdc",
      "amount": "100.000000"
    },
    "destination": {
      "asset": "usd",
      "amount": "100.00"
    },
    "fees": [],
    "exchangeRate": "1.0000",
    "fixedAmountSide": "source",
    "sponsorGas": true
  },
  "expiresAt": "2026-03-14T19:15:00Z",
  "createdAt": "2026-03-14T19:00:00Z"
}

{
  "error": "CustomerRequired",
  "code": 10125,
  "msg": "customer_id is required",
  "cause": "<string>"
}

{
  "error": "FeatureNotEnabled",
  "code": 10153,
  "msg": "cash offramp is not enabled for this partner",
  "cause": "<string>"
}

{
  "error": "ExternalAccountNotFound",
  "code": 10066,
  "msg": "external account not found",
  "cause": "<string>"
}

{
  "error": "AboveMaximumAmount",
  "code": 10110,
  "msg": "amount exceeds the maximum (cash_onramp legacy)",
  "cause": "<string>"
}

{
  "error": "Internal",
  "code": 10124,
  "msg": "internal error",
  "cause": "<string>"
}

{
  "error": "BankRailUnavailable",
  "code": 10295,
  "msg": "bank payment rail is unavailable",
  "cause": "<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 creating a quote. Pick a type on each side and set the amount on exactly one side; OMS calculates the other.

customerId

string

required

The customer this quote is for (cst_ prefix).

source

OMS wallet · object

required

What funds the transaction. Pick a type: an OMS crypto wallet (walletCrypto) or a registered card (card, pull-from-card).

OMS wallet
Fiat wallet
Card

Hide child attributes

source.type

enum<string>

required

Type discriminator.

Available options:

walletCrypto

source.details

object

required

Hide child attributes

source.details.id

string

required

OMS wallet ID (wlt_ prefix).

source.details.asset

string

required

Crypto asset. One of: usdc, usdt.

source.details.network

enum<string>

required

Network identifier.

Available options:

ethereum,

polygon,

base,

solana,

tron,

bnb

source.amount

string

Wire-safe decimal string for financial float values (USD amounts, percentages).

destination

OMS wallet · object

required

The instrument that receives the funds. Pick a type: a wallet (walletCrypto / walletExternal), a bank account (bankUs / bankIban / bankCanada), a card, or cash.

Hide child attributes

destination.type

enum<string>

required

Type discriminator.

Available options:

walletCrypto

destination.details

object

required

Hide child attributes

destination.details.id

string

required

OMS wallet ID (wlt_ prefix).

destination.details.asset

string

required

Crypto asset. One of: usdc, usdt.

destination.details.network

enum<string>

required

Network identifier.

Available options:

ethereum,

polygon,

base,

solana,

tron,

bnb

destination.amount

string

Wire-safe decimal string for financial float values (USD amounts, percentages).

When true, OMS absorbs the on-chain gas cost for the destination delivery. Only true is currently supported. Ignored for non-crypto destinations (no on-chain leg).

metadata

object

Free-form key-value pairs stored on the quote and copied to the resulting transaction.

Hide child attributes

metadata.{key}

string

Response

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

A price quote for moving money between two instruments. It locks an exchange rate and the amounts for a short window; execute it by creating a transaction that references this quote's id.

string

required

Quote ID (qt_ 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 "quote".

Available options:

quote

status

enum<string>

required

Current status of the quote.

Available options:

open,

accepted,

expired

customerId

string

required

The OMS customer that owns this record (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})$

source

OMS wallet · object

required

The funding side, echoed from the request with resolved instrument detail.

Hide child attributes

source.type

enum<string>

required

Available options:

walletCrypto

source.asset

string

required

Lowercase asset.

source.network

string

required

Lowercase blockchain.

source.id

string

The wallet (wlt_); an older wallet keeps its original wlt_<uuid> id. Left out while a deposit's receiving wallet is not resolved yet.

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.owner

object

Who owns an account that is not the resource's customer's.

Hide child attributes

source.owner.kind

enum<string>

required

counterparty, or customer for another customer's account.

Available options:

counterparty,

customer

source.owner.id

string

required

The counterparty (ctp_) or customer (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})$

source.owner.name

string

The counterparty's name. A customer's name is on the customer resource.

source.details

object

OMS crypto wallet details.

Hide child attributes

source.details.address

string

On-chain address.

destination

OMS wallet · object

required

The receiving side, echoed from the request with resolved instrument detail.

Hide child attributes

destination.type

enum<string>

required

Available options:

walletCrypto

destination.asset

string

required

Lowercase asset.

destination.network

string

required

Lowercase blockchain.

destination.id

string

The wallet (wlt_); an older wallet keeps its original wlt_<uuid> id. Left out while a deposit's receiving wallet is not resolved yet.

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.owner

object

Who owns an account that is not the resource's customer's.

Hide child attributes

destination.owner.kind

enum<string>

required

counterparty, or customer for another customer's account.

Available options:

counterparty,

customer

destination.owner.id

string

required

The counterparty (ctp_) or customer (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})$

destination.owner.name

string

The counterparty's name. A customer's name is on the customer resource.

destination.details

object

OMS crypto wallet details.

Hide child attributes

destination.details.address

string

On-chain address.

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; left out 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

Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q.

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.payoutOrigin.accountHolder

enum<string>

Whose legal identity the payment is sent under. Determined by OMS from the route's configuration — not a request field. Left out when OMS cannot determine it, and on destinations that have no sending legal identity (cash payouts, and crypto payouts outside a Deposit Address). A bank payout that goes out under the payment provider or the partner records that holder just before it is sent to the provider, and reports it only while a payout was or may have been created there; a send interrupted after the holder was recorded and before it went out has an unknown outcome and may report it. A failed send known to have created no payout at the provider, and a payout sent before holders were recorded whose holder could not be recovered afterwards, report the fallback value instead, which may differ from the holder actually used. The fallback value, also reported before a holder is recorded and for payouts that always go out under the customer's own name, is the holder the Deposit Address fixed for the destination type the transaction pays on a transaction created from a Deposit Address, and the value its route implies on any other.

Available options:

customer,

paymentProvider,

partner

destination.payoutOrigin.accountHolderName

string

The legal name the payment is sent under, resolved from accountHolder — the customer's own legal name for customer, the owning customer's legal name for partner (for now; a partner-level name may replace it later), or the payment provider's name for paymentProvider, which differs between a bank origin ("Coinme Inc FBO its Customers") and a blockchain origin. This is what the recipient sees as the sender. Like accountHolder and unlike id, it is populated as soon as it is determinable, so it appears on Quote, Deposit Address and Virtual Account responses as well as Transactions. Left out whenever accountHolder is, and when the customer's name cannot be read at that moment.

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.fees

object[]

required

Every fee charged across both sides. [] when there are none — never omitted, never null.

Hide child attributes

pricing.fees.type

string

required

Fee kind. OPEN — clients must tolerate an unrecognised type. Known values today: "developer", "oms", "gas".

pricing.fees.side

enum<string>

required

Which side this fee was deducted from.

Available options:

source,

destination

pricing.fees.asset

string

required

Currency this fee is denominated in — that side's asset.

pricing.fees.amount

string

required

Fee amount in asset, at the asset's precision.

pricing.source

object

The source side, in the source asset.

Hide child attributes

pricing.source.asset

string

required

Lowercase asset of this side, the same as the side's instrument asset.

pricing.source.amount

string

On the source, the gross amount the customer pays; on the destination, the amount that arrives. A decimal string at the asset's precision. Always set on the source; set on the destination once priced.

pricing.destination

object

The destination side, in the destination asset.

Hide child attributes

pricing.destination.asset

string

required

Lowercase asset of this side, the same as the side's instrument asset.

pricing.destination.amount

string

pricing.exchangeRate

string

Mid-market rate from the source asset to the destination asset, set together with the destination amount. Identity: (source.amount − Σ source fees) × exchangeRate = destination.amount + Σ destination fees.

pricing.fixedAmountSide

enum<string>

The side whose amount was fixed at creation. OMS calculated the other side.

Available options:

source,

destination

Present and true when OMS absorbs the destination gas cost; omitted otherwise.

sourceToDestination

enum<string>

Corridor composite derived from the two sides.

Available options:

cryptoToCrypto,

cryptoToCash,

cryptoToFiatAccount,

cashToCrypto,

fiatAccountToCrypto,

fiatAccountToFiatAccount

customer

object

Display-safe summary of the owning customer (customer.id equals customerId). Omitted when the customer cannot be resolved.

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.

expiresAt

string<date-time>

When the locked pricing expires.

createdAt

string<date-time>

When the quote was created.

metadata

object

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

Hide child attributes

metadata.{key}

string

Overview

Move money

Routes

External Payment Methods

Platform

Read onchain data

Create a payment quote

Authorizations

Headers

Body

Response