Skip to main content
GET
/
payouts
List payouts
curl --request GET \
  --url https://api.withacclaim.com/v1/payouts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "po_dlZwQyd0Sn",
      "treasury_account_id": "tac_b0TrsSg91h",
      "payee_id": "pyee_KfIuLz83Ya",
      "batch_id": "ba_r8PxTnQ5Dv",
      "funded_amount": 125000,
      "funding_currency": "USD",
      "payment_amount": 125000,
      "payment_currency": "USD",
      "exchange_rate": "1.00000000",
      "status": "ReadyToProcess",
      "payout_link_url": "<string>",
      "payout_method": {
        "id": "pmet_abc123",
        "payout_method_type": "UnitedStatesAch",
        "active": true,
        "currency": "<string>",
        "country": "<string>",
        "account_number": "<string>",
        "routing_type1": "<string>",
        "routing_value1": "<string>",
        "routing_type2": "<string>",
        "routing_value2": "<string>",
        "bank_name": "<string>",
        "account_holder_name": "<string>",
        "account_type": "<string>",
        "swift_code": "<string>",
        "iban": "<string>",
        "tax_id_type": "<string>",
        "tax_id": "<string>",
        "payout_speed": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "reference": "REF-2025-001",
      "description": "Payment for services rendered",
      "purpose_of_payment": "ProviderBillPayment",
      "processed_at": "2025-10-08T18:25:00Z",
      "payment_date": "2025-10-08",
      "swift_charge_option": "Our",
      "lock_side": "Funding",
      "failure_code": "insufficient_funds",
      "failure_message": "Insufficient funds in treasury account",
      "metadata": {
        "custom_field": "value",
        "source": "api"
      },
      "created_at": "2025-10-08T18:20:31Z",
      "updated_at": "2025-10-08T18:25:00Z"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:25
Required range: 1 <= x <= 100
cursor
string
status
enum<string>
Available options:
ReadyToProcess,
Processing,
Succeeded,
Failed,
Canceled,
RequiresPayeeInfo,
RequiresAction,
RequiresPayoutMethod,
NeedsApproval

Response

A list of payouts.

data
object[]
next_cursor
string | null
has_more
boolean
Last modified on April 16, 2026