# Get scheduled payouts

`GET /v2/payout-requests/schedule`

**Base URLs:**

- Sandbox: `https://api.sandbox.bobpay.co.za`
- Production: `https://api.bobpay.co.za`

**Authentication:** Bearer token required. Obtain one via `POST /login` (see the Authentication page).

## Example request

```bash
curl -X GET "https://api.sandbox.bobpay.co.za/v2/payout-requests/schedule" \
  -H "Authorization: Bearer <ACCESS_TOKEN>"
```

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 body**

```json
{
    "payout_request_schedules": [
        {
            "id": 13,
            "account_id": 665,
            "payout_frequency": "monthly",
            "minimum_payout_amount": 10,
            "payout_frequency_day": 1,
            "time_created": "2025-03-20T15:16:31.044149+02:00",
            "time_modified": "0001-01-01T00:00:00Z",
            "modified_by": 602
        }
    ],
    "count": 1
}
```

---

### 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.