List incoming payouts
customer:readPayouts other Customers sent this Customer by its Receiving Code, newest first, one page at a time.
A Payout appears once its sender's money is held for it, never before and never once cancelled, and reads on_the_way, delivered, delayed (it failed and waits for the sender's side to retry or return it) or returned (the money went back to the sender). The sender's send amount, fees, Route and Providers are never shown. The payout.incoming.updated webhook announces every change.
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.
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
items*array<>next_cursor?stringnext_cursor is passed back as cursor for the next page; absent on the last one.
curl -X GET 'http://localhost:3480/v1/incoming-payouts'{ "items": [ { "account_hint": "4321", "amount": { "amount": "277664.5", "asset": "PKR" }, "created_at": "2026-11-12T09:30:02Z", "delivered_at": "2026-11-12T09:41:17Z", "delivered_to": "bank_account", "id": "0e1f2a3b-4c5d-4e6f-8a7b-9c0d1e2f3a4b", "purpose": "services", "sender_name": "Tom Becker", "status": "delivered", "updated_at": "2026-11-12T09:41:17Z" } ], "next_cursor": "eyJhdCI6IjIwMjYtMTEtMTJUMDk6MzA6MDJaIn0"}Issue a new Receiving Code POST
Puts a new Receiving Code in force: the first one, or one replacing the code in force.
Get an incoming payout GET
One Payout another Customer sent this Customer, as `GET /v1/incoming-payouts` lists it: who sent it, what arrives, the purpose the sender declared, where it stands and, once delivered, whether it was credited to the Customer's balance or paid to its bank account.