API referencePayouts

List payouts

GET
/api/b/v1/payouts

Query Parameters

status?|null
limit?Limit
Range1 <= value <= 200
Default50
offset?Offset
Range0 <= value
Default0

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/payouts"
{  "payouts": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "reference": "string",      "amount_minor": 0,      "fee_minor": 0,      "total_minor": 0,      "currency": "string",      "status": "created",      "method": "string",      "transaction_type": "string",      "category": "string",      "recipient_name": "string",      "country_code": "string",      "rail": "string",      "provider_reference": "string",      "failure_reason": "string",      "approval_id": "15af2260-72db-4fc4-b587-6b841d6a3d55",      "created_at": "2019-08-24T14:15:22Z",      "completed_at": "2019-08-24T14:15:22Z"    }  ]}

Resume collecting POST

Previous Page

Send a payout POST

Raise a payout and commit the money to it. The money is reserved before this returns, whether or not the payout needs approval. A `requires_approval` response therefore means "the funds are held and somebody must sign", not "nothing has happened yet". In **test mode** the payout is settled as it is raised: no rail is involved, so the response already carries the outcome. `amount_minor` and the destination decide what that outcome is — see the sandbox guide for the values that produce a decline, a timeout, a return or a review hold.