Endpoint

List payout batches

GET/v1/payout_batches

Returns your payout batches, newest first, a page at a time. Filter by status, 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 payout batches
Parameter	Type and place	Meaning
`status`	stringquery	One state or a comma-separated list.
`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.
`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/payout_batches \
  -H "Authorization: Bearer $ORRERIE_SECRET_KEY"

JavaScript

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

Example response, 200

{
  "object": "list",
  "url": "/v1/payout_batches",
  "has_more": false,
  "data": [
    {
      "id": "pob_b1xkj45rqwdaf7j2bc94pef3",
      "object": "payout_batch",
      "livemode": true,
      "created": "2026-10-12T09:40:00.000Z",
      "status": "awaiting_approval",
      "description": "October contractor payments",
      "row_count": 2,
      "total_value": {
        "amount": "1700.00",
        "currency": "USD"
      },
      "counts": {
        "draft": 0,
        "awaiting_approval": 2,
        "signed": 0,
        "sent": 0,
        "confirmed": 0,
        "failed": 0,
        "unknown": 0,
        "cancelled": 0
      },
      "payouts": [
        "po_crs9tp390f2yjremph9m0npb",
        "po_kyrcy0h8t43wvedbxe5v40bp"
      ],
      "requested_by": {
        "type": "api_key",
        "id": "key_6e3gg2c6ea176xxdek2nar6v"
      },
      "approved_by": null,
      "approval_url": "https://merchant.orrerie.com/approve/pob_b1xkj45rqwdaf7j2bc94pef3",
      "approval_expires_at": "2026-10-19T09:40:00.000Z",
      "approved_at": null,
      "completed_at": null,
      "cancellation_reason": null,
      "metadata": {}
    }
  ]
}

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.