Endpoint
Request a payout or withdrawal
POST
/v1/payoutsReturns 202 with the payout awaiting_approval. kind is taken from the saved address.
- Scope a restricted key needs
payouts:write- Publishable key
- Not allowed: secret or restricted key only
- Idempotency-Key
- Required. A request without it is refused.
Parameters
| Parameter | Type and place | Meaning |
|---|---|---|
Orrerie-Version | stringheader | API version date. Default: the version the key was created with. Example 2026-10-11. |
Idempotency-Keyrequired | stringheader | Required here: a person at your business approves what this request asks for (money out, or a new saved address), and a retry with the same key never asks for it twice. 1 to 255 characters. |
Request body
A JSON object. The body is required. A field the call does not list is refused with parameter_unknown.
| Field | Type | Meaning |
|---|---|---|
sourcerequired | object | {asset, amount}: which balance and how much leaves the wallet. amount: "max" sends the whole available balance (fee taken from it where the network allows). |
destinationrequired | string | A dst_ id. |
deliver_asset | string | Asset the destination receives when different from source.asset; must match the saved address's network. |
description | string | Up to 500 characters. |
reference | string | Up to 200 characters. |
metadata | object | Your own key-value data (rules in Metadata). |
Example request
curl
curl https://api.orrerie.com/v1/payouts \
-H "Authorization: Bearer $ORRERIE_SECRET_KEY" \
-H "Idempotency-Key: 8f14e45f-ceea-467f-a9d2-6f1c2b3d4e5a" \
-H "Content-Type: application/json" \
-d '{
"source": {
"asset": "base:usdc",
"amount": "250.00"
},
"destination": "dst_92jw0br3z1bzkk45ddjqcm6q",
"description": "October green beans",
"reference": "PO-2210",
"metadata": {
"supplier_id": "s_19"
}
}'JavaScript
const response = await fetch("https://api.orrerie.com/v1/payouts", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.ORRERIE_SECRET_KEY}`,
"Idempotency-Key": "8f14e45f-ceea-467f-a9d2-6f1c2b3d4e5a",
"Content-Type": "application/json",
},
body: JSON.stringify({
"source": {
"asset": "base:usdc",
"amount": "250.00"
},
"destination": "dst_92jw0br3z1bzkk45ddjqcm6q",
"description": "October green beans",
"reference": "PO-2210",
"metadata": {
"supplier_id": "s_19"
}
}),
});
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.post(
"https://api.orrerie.com/v1/payouts",
headers={"Authorization": f"Bearer {os.environ['ORRERIE_SECRET_KEY']}", "Idempotency-Key": "8f14e45f-ceea-467f-a9d2-6f1c2b3d4e5a"},
json={
"source": {
"asset": "base:usdc",
"amount": "250.00",
},
"destination": "dst_92jw0br3z1bzkk45ddjqcm6q",
"description": "October green beans",
"reference": "PO-2210",
"metadata": {
"supplier_id": "s_19",
},
},
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/payouts');
curl_setopt_array($request, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('ORRERIE_SECRET_KEY'),
'Idempotency-Key: 8f14e45f-ceea-467f-a9d2-6f1c2b3d4e5a',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'source' => [
'asset' => 'base:usdc',
'amount' => '250.00',
],
'destination' => 'dst_92jw0br3z1bzkk45ddjqcm6q',
'description' => 'October green beans',
'reference' => 'PO-2210',
'metadata' => [
'supplier_id' => 's_19',
],
]),
]);
$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
202 Accepted
The request was accepted and is waiting: for a person to approve it in the dashboard, or to be built in the background. Nothing has been signed or sent. The answer is the payout object. Headers: Orrerie-Request-Id.
Example response, 202
{
"id": "po_351ggq5kz6kxwpfrhp5qh3b0",
"object": "payout",
"livemode": true,
"created": "2026-10-12T09:30:00.000Z",
"updated": "2026-10-12T09:30:00.000Z",
"kind": "payout",
"status": "awaiting_approval",
"pending_reason": null,
"batch": null,
"source": {
"wallet": "wal_bsfw07hymawmda7gg8jsyy3g",
"asset": "base:usdc",
"amount": "250.000000"
},
"destination": {
"saved_address": "dst_92jw0br3z1bzkk45ddjqcm6q",
"address": "0xD1220A0cf47c7B9Be7A2E6BA89F429762e7b9aDb",
"network": "base",
"asset": "base:usdc"
},
"delivery": {
"rail": "direct",
"amount_estimated": "250.000000",
"route_fee": null,
"fee_bearer": null
},
"value": {
"amount": "250.00",
"currency": "USD"
},
"description": "October green beans",
"reference": "PO-2210",
"network_fee": null,
"requested_by": {
"type": "api_key",
"id": "key_6e3gg2c6ea176xxdek2nar6v"
},
"approved_by": null,
"approval_url": "https://merchant.orrerie.com/approve/po_351ggq5kz6kxwpfrhp5qh3b0",
"approval_expires_at": "2026-10-19T09:30:00.000Z",
"transaction_hash": null,
"failure_code": null,
"cancellation_reason": null,
"approved_at": null,
"sent_at": null,
"confirmed_at": null,
"metadata": {
"supplier_id": "s_19"
}
}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
Beside the errors every call can answer with (a bad key, a missing scope, the rate limit), this call answers with:
| Code | HTTP | Meaning |
|---|---|---|
idempotency_key_required | 400 | The endpoint moves money on approval (refunds, payouts, batches, conversions, saved addresses) and needs an Idempotency-Key. |
insufficient_balance | 409 | The available balance (amount minus reserved) of the source asset is too low; error.available gives it. |
fee_account_low | 409 | The fee account cannot pay the network fee. error.needed says how much of which coin on which network must be held, for example {"asset": "tron:. |
saved_address_not_usable | 409 | The saved address is awaiting_approval, waiting (error.usable_at says until when) or removed. |
destination_blocked | 403 | The destination address is on a sanctions list. The request is refused and recorded. |
screening_unavailable | 503 | The sanctions check could not be made. A failed check is never treated as clean; retry later. |
merchant_restricted | 403 | The merchant is restricted: new orders, payouts to others and conversions are off. Reads and withdrawals to saved addresses work. |
payout_daily_limit_reached | 403 | Payouts to others in the last 24 hours (payouts, split legs and refunds to a saved address) plus this one would pass US$1,000 (Unverified) or US$100,000 (Verified). Withdrawals to own saved addresses have no tier limit. |
rail_unavailable | 503 | The rail cannot be used now. error.reason is the exact refusal: relay_unavailable, relay_no_route, relay_amount_too_low, relay_low_liquidity, relay_paused, route_fee_over_cap, provider_route_mismatch, provider_, refund_, recipient_not_attested, or asset_not_covered; error.available_assets lists what can be used instead. Nothing was created at the provider and nothing was switched. |
amount_below_minimum | 400 | Below the minimum: US$1.00 for an order payable on the relay rail, the network dust limit on the direct rail or for a payout. |
merchant_closing | 403 | The business is closing: new orders, payment links and invoices are off, and money goes out only to its own saved addresses. Reads, exports and withdrawals to saved addresses work until it closes. |
wallet_needs_review | 409 | The wallet holds less than Orrerie's records show, because money left it that nothing recorded. Money out from it waits until an Owner has reviewed the wallet in the dashboard. |