Payouts
API ReferencePayoutsList
List Payouts
Retrieve a list of payouts with optional filtering and pagination.
POST /payouts/list
Body Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | 10 | Number of payouts to return (max: 100) |
offset | integer | No | 0 | Number of payouts to skip |
status | string | No | — | Filter by payout status |
customer_id | string | No | — | Filter by customer ID |
payout_type | string | No | — | Filter by payout type (card, bank) |
Request Example
curl -X POST 'https://api.v2.paychtec.com/payouts/list' \ -H "Content-Type: application/json" \ -H "api-key: snd_YOUR_API_KEY" \ -d '{ "limit": 10, "status": "success"}'Response
{
"count": 1,
"total_count": 25,
"data": [
{
"payout_id": "po_1234567890abcdef",
"amount": 5000,
"currency": "USD",
"status": "success",
"payout_type": "bank",
"created": "2024-01-22T10:00:00Z"
}
]
}