Payouts
Get scheduled payouts
This endpoint retrieves the automated payout schedules configured for your account, including frequency, minimum payout amounts, and payout days.
Request
Method: GET
URL: https://api.sandbox.bobpay.co.za/v2/payout-requests/schedule
Query parameters
| Key | Description | Type | Required |
|---|---|---|---|
| account_id | The unique identifier of the account whose payout schedules are requested. | integer | No |
| payout_frequency | Filter by payout frequency (daily, weekly, or monthly). | string | No |
Response
Status code: 200 OK Content-Type: application/json
Response fields
| Key | Description | Type |
|---|---|---|
| payout_request_schedules | Array of payout schedule objects matching the query parameters. | array |
| id | Unique identifier for the payout schedule. | integer |
| account_id | The account associated with the payout schedule. | integer |
| payout_frequency | Frequency of the scheduled payouts (daily, weekly, or monthly). |
string |
| minimum_payout_amount | The minimum amount required to trigger a payout. | number |
| payout_frequency_day | The day on which the payout is scheduled (for weekly: 1 = Monday to 5 = Friday; for monthly: the day of the month). | integer |
| time_created | Timestamp when the payout schedule was created. | string (datetime) |
| time_modified | Timestamp when the payout schedule was last modified. | string (datetime) |
| modified_by | The user ID who last modified the schedule. | integer |
| count | Total number of payout schedules matching the query. | integer |
Note:
The payout_frequency_day field's meaning depends on the frequency:
- For weekly, it's the day of the week: 1 (Monday) to 5 (Friday).
- For monthly, it's the calendar day of the month.
- For daily, it is not used.