API referencePayout batches

List payout batches

GET
/api/b/v1/payout-batches

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Query Parameters

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

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/payout-batches"
{  "batches": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "source": "string",      "currency": "string",      "status": "validating",      "total_lines": 0,      "valid_lines": 0,      "invalid_lines": 0,      "total_minor": 0,      "approval_id": "15af2260-72db-4fc4-b587-6b841d6a3d55",      "created_at": "2019-08-24T14:15:22Z",      "completed_at": "2019-08-24T14:15:22Z"    }  ]}

Cancel a payout POST

Withdraw a payout that has not reached a rail. The reservation is released, so the money is spendable again immediately.

Create a batch from rows POST

Validate every row and report what cannot run. Nothing is paid here. The response carries the per-line errors so a bad file is fixed before any money is committed.