Endpoint

List payouts

GET/v1/payouts

Returns your payouts, newest first, a page at a time. Filter by status, kind, batch, destination or reference, and by the time each was made, with created[gte] and created[lt].

Scope a restricted key needs: payouts:read
Publishable key: Not allowed: secret or restricted key only
Idempotency-Key: Not used. A GET is already safe to repeat.

Parameters

Parameters of List payouts
Parameter	Type and place	Meaning
`status`	stringquery	One state or a comma-separated list.
`kind`	stringquery	Payout, withdrawal or split_leg.
`batch`	stringquery	A `pob_` id.
`destination`	stringquery	A `dst_` id.
`reference`	stringquery	Exact match on your own reference.
`limit`	integerquery	Items per page, 1 to 100. Default 20.
`starting_after`	stringquery	An object id: return the items after it.
`ending_before`	stringquery	An object id: return the items before it.
`created[gte]`	string (date-time)query	Created at or after. Also created[gt], created[lte], created[lt].
`created[lt]`	string (date-time)query	Created before.
`expand`	stringquery	Comma-separated fields to expand (Filtering, sorting and expanding), up to 5, one level deep: `data.destination.saved_address`, `data.batch`. Each field needs the read scope that its object's own GET needs (`customers:read` for a customer, `payments:read` for a payment); without it the call answers `insufficient_scope` naming that scope, and nothing is expanded.
`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/payouts \
  -H "Authorization: Bearer $ORRERIE_SECRET_KEY"

JavaScript

const response = await fetch("https://api.orrerie.com/v1/payouts", {
  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/payouts",
    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/payouts');
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 payout objects. Headers: Orrerie-Request-Id.

Example response, 200

{
  "object": "list",
  "url": "/v1/payouts",
  "has_more": false,
  "data": [
    {
      "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

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.