Payouts
Get payout requests
This endpoint allows you to retrieve detailed information about payout requests for your accounts. You can filter requests by status, creation date, and more, enabling you to efficiently monitor and manage outgoing payments.
Request
Method: GET
URL: https://api.sandbox.bobpay.co.za/v2/payout-requests
Query parameters
| Key | Description | Type | Required |
|---|---|---|---|
| id | The ID of a payout request record. | integer | No |
| account_id | The ID of the account whose payout requests are requested. | integer | No |
| status | The payout request status. One of: pending, paid, payment-failed, rejected, cancelled. | string | No |
| start_date | Start date for the time period (format: YYYY-MM-DD HH:MM:SS). | string (date/time) | No |
| end_date | End date for the time period (format: YYYY-MM-DD HH:MM:SS). | string (date/time) | No |
| csv | Use true to export the results to a CSV file. The CSV is generated in the background and emailed to you. | boolean | No |
| order | Sort order: ASC / DESC. | string | No |
| order_by | Order by any field. | string | No |
| offset | The number of records to skip (for pagination). | integer | No |
| limit | Limit the number of records returned. | integer | No |
Response
Status code: 200 OK Content-Type: application/json
Response fields
| Field | Description | Type |
|---|---|---|
| payouts | List of payout request objects | array |
| payouts[].id | Unique identifier for the payout request | integer |
| payouts[].account_id | The ID of the account requesting payout | integer |
| payouts[].account | Account information | object |
| payouts[].account_billing_info | Billing/banking info of the account | object |
| payouts[].amount | The payout amount | float |
| payouts[].status | Status of the payout request (pending, paid, payment-failed, rejected, cancelled) |
string |
| payouts[].payout_rejected_reason | Reason for payout rejection | string |
| payouts[].payout_date | Date the payout was processed | string (datetime) |
| payouts[].transaction_id | Related transaction ID | integer |
| payouts[].banking_details | Destination banking details | object |
| payouts[].time_created | Timestamp when payout request was created | string (datetime) |
| payouts[].time_modified | Timestamp when payout request was last updated | string (datetime) |
| payouts[].from_bank | Name or code of the originating bank | string |
| payouts[].payment_reference | Payment reference | string |
| payouts[].total_note_count | Number of notes attached to the payout request | integer |
| count | Total number of payout requests matching your query | integer |
Note: Payout requests that are still being processed internally are always returned with status pending; filtering by status=pending includes them.