List Payouts
customer:readThe Customer's Payouts, newest first, one page at a time. Pass next_cursor back as cursor for the next page; it is absent on the last one.
A Payout's state is one of awaiting_approval (held by the Customer's approval rules for a second person), accepted (waiting for funds at the Provider its Route starts at), funded, processing, completed, failed (it stopped and waits for the operations team to retry or refund it), refunded or cancelled. completed, refunded and cancelled are final.
Requires the customer:read permission. A Platform may call it for one of its End Customers with Apex-End-Customer.
ApiKeyAuthorizationBearer <API key>A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.
state?stringOnly Payouts in this state.
"awaiting_approval""accepted""funded""processing""completed""failed""refunded""cancelled"limit?integerHow many Payouts one page holds.
1 <= value <= 10050cursor?stringThe next_cursor of the previous page; leave it out for the first page.
Apex-End-Customer?stringA Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers end_customer_not_found.
uuidOK
application/json- response
next_cursor?stringnext_cursor is passed back as cursor for the next page; absent on the last one.
payouts*array<>curl -X GET 'http://localhost:3480/v1/payouts'{ "next_cursor": "eyJhdCI6IjIwMjYtMTEtMTJUMDk6MzA6MDJaIn0", "payouts": [ { "beneficiary": { "country": "DE", "id": "7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a", "name": "Berlin Supplies GmbH", "party_type": "business" }, "cancellable": false, "created_at": "2026-11-12T09:30:02Z", "delivered_to": "bank_account", "failure": null, "fees": [ { "amount": { "amount": "1", "asset": "USDC" }, "component": "provider", "provider": "bvnk" }, { "amount": { "amount": "0.5", "asset": "EUR" }, "component": "provider", "provider": "bvnk" } ], "id": "5f8d0c3e-2b7a-4d1e-9c6f-8a3b2e1d0c9f", "initiated_by": { "actor": "customer", "id": "6e5d4c3b-2a1f-4e0d-8c9b-7a6f5e4d3c2b", "kind": "api_key" }, "initiated_by_you": true, "legs": [ { "from": "USDC", "index": 0, "provider": "bvnk", "settled_at": "2026-11-12T09:30:41Z", "state": "completed", "to": "EUR" }, { "from": "EUR", "index": 1, "provider": "bvnk", "settled_at": "2026-11-12T09:31:05Z", "state": "completed", "to": "EUR" } ], "rates": [ { "provider": "bvnk", "rate": "0.92" } ], "receive": { "amount": "918.58", "asset": "EUR" }, "send": { "amount": "1000", "asset": "USDC" }, "state": "completed", "updated_at": "2026-11-12T09:31:05Z" } ]}