Create a payout schedule

Set up a recurring run. Nothing is validated against a rail here — the lines are checked when each occurrence materialises, so a beneficiary blocked after the schedule was created is caught on the run rather than being paid on stale information.

Set up a recurring run.

Nothing is validated against a rail here — the lines are checked when each occurrence materialises, so a beneficiary blocked after the schedule was created is caught on the run rather than being paid on stale information.

Authorization

OAuth2PasswordBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A recurring set of payouts. IN-302.

The schedule holds lines; each run turns them into a batch unchanged. Which of day_of_month / day_of_week applies depends on cadence, and the run time is read in timezone rather than UTC.

name*Name

Your name for it, shown wherever schedules are listed.

Length1 <= length <= 200

Example"Monthly salaries"

currency*Currency

ISO 4217. Every line is in this currency.

Length3 <= length <= 3

Example"RWF"

cadence*Cadence

daily, weekly or monthly.

Example"monthly"

Value in

"daily"
"weekly"
"monthly"

lines*array<>

The lines to pay on each occurrence. Same columns as a batch row, because each occurrence materialises as a batch. Nothing is validated against a rail here — the lines are checked when the occurrence runs, so a beneficiary blocked after the schedule was written is caught on the run rather than paid on stale information.

Items1 <= items

day_of_month?|

Monthly only. Clamped in shorter months.

day_of_week?|

Weekly only. 0 is Monday.

run_hour?Run Hour

Hour of the run, 0-23, read in timezone.

Range0 <= value <= 23

Default9

Example9

run_minute?Run Minute

Minute of the run, 0-59, read in timezone.

Range0 <= value <= 59

Default0

Example0

timezone?Timezone

IANA name. The run time means this zone's clock, so a payroll on the 25th is the 25th where the business is.

Lengthlength <= 64

Default"UTC"

ends_at?|

RFC 3339, UTC. After this the schedule stops producing runs but is kept, so its history stays readable. Omit for one that runs until you deactivate it.

Example"2027-01-01T00:00:00Z"

Response Body

`application/json`

curl -X POST "https://example.com/api/b/v1/payout-schedules" \  -H "Content-Type: application/json" \  -d '{    "name": "Monthly salaries",    "currency": "RWF",    "cadence": "monthly",    "lines": [      {        "amount_minor": "15000000",        "method": "mobile_money",        "transaction_type": "b2p"      }    ]  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "currency": "string",  "cadence": "daily",  "status": "active",  "day_of_month": 0,  "day_of_week": 0,  "run_hour": 0,  "run_minute": 0,  "timezone": "string",  "line_count": 0,  "total_minor": 158000000,  "next_run_at": "2019-08-24T14:15:22Z",  "last_run_at": "2019-08-24T14:15:22Z",  "ends_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}

Authorization

Cookie Parameters

Request Body

Response Body

201application/json

422application/json

`application/json`

`application/json`