curl "https://api.zbdpay.com/api/v1/payouts?status=COMPLETED&from=2026-10-01T00:00:00Z" \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "Payouts retrieved.",
"data": {
"payouts": [
{
"payout_id": "po_8f2c41d7-3b9e-4a10-b6f2-91de0c7a5e44",
"status": "COMPLETED",
"origin": "api",
"user_id": "4ac4fd8a-cc2c-4d03-af09-a76f4e89d652",
"amount": 2500,
"currency": "USD",
"fee_amount": 50,
"net_amount": 2450,
"reference_id": "creator_payout_2026_10",
"project_id": null
}
],
"next_cursor": null
},
"error": null
}
Payouts
List Payouts
List payouts, including those sent from your backend and cash outs from the widget.
GET
/
api
/
v1
/
payouts
curl "https://api.zbdpay.com/api/v1/payouts?status=COMPLETED&from=2026-10-01T00:00:00Z" \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "Payouts retrieved.",
"data": {
"payouts": [
{
"payout_id": "po_8f2c41d7-3b9e-4a10-b6f2-91de0c7a5e44",
"status": "COMPLETED",
"origin": "api",
"user_id": "4ac4fd8a-cc2c-4d03-af09-a76f4e89d652",
"amount": 2500,
"currency": "USD",
"fee_amount": 50,
"net_amount": 2450,
"reference_id": "creator_payout_2026_10",
"project_id": null
}
],
"next_cursor": null
},
"error": null
}
Covers every payout under your key, whether your backend sent it or a user cashed out in the widget. Use it for reconciliation.
Configuration
Header Parameters
string
required
Your ZBD API key.
Query Parameters
string
Only payouts to this user.
string
Only payouts in this status.
string
Only the payout with your reference.
string
Only payouts in this project.
string
ISO 8601 start of the date range.
string
ISO 8601 end of the date range.
integer
Page size.
string
The
next_cursor from the previous page.curl "https://api.zbdpay.com/api/v1/payouts?status=COMPLETED&from=2026-10-01T00:00:00Z" \
-H "x-api-key: YOUR_API_KEY"
{
"success": true,
"message": "Payouts retrieved.",
"data": {
"payouts": [
{
"payout_id": "po_8f2c41d7-3b9e-4a10-b6f2-91de0c7a5e44",
"status": "COMPLETED",
"origin": "api",
"user_id": "4ac4fd8a-cc2c-4d03-af09-a76f4e89d652",
"amount": 2500,
"currency": "USD",
"fee_amount": 50,
"net_amount": 2450,
"reference_id": "creator_payout_2026_10",
"project_id": null
}
],
"next_cursor": null
},
"error": null
}
Response
object[]
Payouts matching your filters, newest first. Each has the same fields as Create a Payout, including
origin, which tells you whether your backend sent it or the user cashed out in the widget.string | null
Pass this as
cursor to get the next page. null when there are no more results.Was this page helpful?