Cancel a payout batch

curl

curl https://api.orrerie.com/v1/payout_batches/pob_b1xkj45rqwdaf7j2bc94pef3/cancel \
  -H "Authorization: Bearer $ORRERIE_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

JavaScript

const response = await fetch("https://api.orrerie.com/v1/payout_batches/pob_b1xkj45rqwdaf7j2bc94pef3/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ORRERIE_SECRET_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
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/payout_batches/pob_b1xkj45rqwdaf7j2bc94pef3/cancel",
    headers={"Authorization": f"Bearer {os.environ['ORRERIE_SECRET_KEY']}"},
    json={},
    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/pob_b1xkj45rqwdaf7j2bc94pef3/cancel');
curl_setopt_array($request, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('ORRERIE_SECRET_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);
$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);

Example response, 200

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