Endpoint
List the ways an order can be paid
/v1/orders/{id}/payment_optionsEvery asset a payer could choose for this order, with the rail it would use and an estimate. An asset that cannot be used right now is listed with available: false and unavailable_reason (the refusal codes are relay_unavailable, relay_no_route, relay_amount_too_low, relay_low_liquidity, relay_paused, route_fee_over_cap, refund_wallet_unavailable; and asset_not_covered, rail_off, asset_not_enabled, below_minimum); nothing is hidden and nothing is switched silently. Estimates are not quotes: the instruction fixes the amount.
- Scope a restricted key needs
orders:read- Publishable key
- Not allowed: secret or restricted key only
- Idempotency-Key
- Not used. A GET is already safe to repeat.
Parameters
| Parameter | Type and place | Meaning |
|---|---|---|
idrequired | stringpath | The id of the order. |
Orrerie-Version | stringheader | API version date. Default: the version the key was created with. Example 2026-10-11. |
Example request
curl
curl https://api.orrerie.com/v1/orders/ord_0zymngngvf12b8b2cra7tb8e/payment_options \
-H "Authorization: Bearer $ORRERIE_SECRET_KEY"JavaScript
const response = await fetch("https://api.orrerie.com/v1/orders/ord_0zymngngvf12b8b2cra7tb8e/payment_options", {
headers: {
Authorization: `Bearer ${process.env.ORRERIE_SECRET_KEY}`,
},
});
const result = await response.json();
if (!response.ok) throw new Error(`${result.error.code}: ${result.error.message}`);
console.log(result);Python
import os
import requests
response = requests.get(
"https://api.orrerie.com/v1/orders/ord_0zymngngvf12b8b2cra7tb8e/payment_options",
headers={"Authorization": f"Bearer {os.environ['ORRERIE_SECRET_KEY']}"},
timeout=30,
)
result = response.json()
if not response.ok:
raise RuntimeError(f"{result['error']['code']}: {result['error']['message']}")
print(result)PHP
<?php
$request = curl_init('https://api.orrerie.com/v1/orders/ord_0zymngngvf12b8b2cra7tb8e/payment_options');
curl_setopt_array($request, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('ORRERIE_SECRET_KEY'),
],
]);
$body = curl_exec($request);
if ($body === false) {
throw new RuntimeException(curl_error($request));
}
$result = json_decode($body, true);
if (curl_getinfo($request, CURLINFO_HTTP_CODE) >= 400) {
throw new RuntimeException($result['error']['code'] . ': ' . $result['error']['message']);
}
print_r($result);Responses
200 OK
A list whose data holds payment_option objects. Headers: Orrerie-Request-Id.
Example response, 200
{
"object": "list",
"url": "/v1/orders/ord_0zymngngvf12b8b2cra7tb8e/payment_options",
"has_more": false,
"data": [
{
"object": "payment_option",
"asset": "ethereum:usdc",
"network": "ethereum",
"symbol": "USDC",
"rail": "relay",
"amount_mode": "exact",
"available": true,
"unavailable_reason": null,
"estimated_pay_amount": "22.410000",
"estimated_route_fee": {
"amount": "0.42",
"currency": "USD",
"bearer": "payer"
},
"confirmations_required": 12,
"estimated_seconds": 180
},
{
"object": "payment_option",
"asset": "bitcoin:btc",
"network": "bitcoin",
"symbol": "BTC",
"rail": "relay",
"amount_mode": "open",
"available": true,
"unavailable_reason": null,
"estimated_pay_amount": "0.00019100",
"estimated_route_fee": {
"amount": "0.36",
"currency": "USD",
"bearer": "payer"
},
"confirmations_required": 1,
"estimated_seconds": 900
},
{
"object": "payment_option",
"asset": "litecoin:ltc",
"network": "litecoin",
"symbol": "LTC",
"rail": "direct",
"amount_mode": "exact",
"available": true,
"unavailable_reason": null,
"estimated_pay_amount": "0.20410000",
"estimated_route_fee": null,
"confirmations_required": 3,
"estimated_seconds": 450
},
{
"object": "payment_option",
"asset": "tron:usdt",
"network": "tron",
"symbol": "USDT",
"rail": "relay",
"amount_mode": "open",
"available": false,
"unavailable_reason": "relay_unavailable",
"estimated_pay_amount": null,
"estimated_route_fee": null,
"confirmations_required": 19,
"estimated_seconds": null
}
]
}Any other status: an error
A status of 400 or above answers with the error object. Branch on its code, never on its message.
Errors
This call has no error of its own. It answers with the errors every call can answer with: a bad key, a missing scope, an object that does not exist, the rate limit. Every error code has its own entry.