List payouts
/api/v2/payoutsNewest first by createdAt, id as tie-breaker. Needs payouts:read.
Query Parameters
Only payouts in this status. Repeat for several values.
Only payouts to this counterparty: its id (counterparty_…) or your customId.
Only payouts created at or after this time. Inclusive.
date-timeOnly payouts created before this time. Exclusive, so windows that share a boundary do not overlap.
date-timeOnly payouts with this tag. Repeat for several values; a payout matches any of them.
Page size, 1 to 100. Default 20.
The nextCursor of the previous page. Opaque: never build or decode it.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v2/payouts"{ "object": "list", "data": [ { "object": "payout", "id": "payout_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e", "customId": "campaign-42", "description": "string", "amount": "100.00", "currency": "USD", "recipient": { "type": "email", "email": "jane@example.com", "phone": "string" }, "status": "created", "locked": true, "availableOn": "2026-10-01", "expiresAt": "2026-09-24T10:00:00.000Z", "tags": [ "string" ], "paymentMethod": { "type": "crypto", "asset": "string", "currency": "EUR" }, "senderInvoiceUrl": "string", "recipientInvoiceUrl": "string", "recipientInvoiceSource": "self_billing", "failureCode": "account_closed", "failureReason": "string", "approvedAt": "2026-09-24T10:00:00.000Z", "claimLinkSentAt": "2026-09-24T10:00:00.000Z", "requestedAt": "2026-09-24T10:00:00.000Z", "completedAt": "2026-09-24T10:00:00.000Z", "createdAt": "2026-09-24T10:00:00.000Z", "updatedAt": "2026-09-24T10:00:00.000Z" } ], "hasMore": true, "nextCursor": "string"}Errors and retries
The error format, common error codes, and how to retry safely.
Create a payout POST
Creates a payout in status `created`. `andThen` runs approval, and then `send-claim-link` or `pay`, in the same request and fails with their codes. Needs `payouts:write`, plus `payouts:approve` when `andThen` is set.