Create payout scheduler
curl -X POST "https://test-api.kashier.io/v2/transfers/schedulers/single" \ -H "Content-Type: application/json" \ -d '{ "batchName": "Monthly supplier payout", "type": "single", "scheduler": { "method": "bank", "recipientName": "Ahmed Mohamed", "recipientNumber": "1012345678", "recipientBank": "CIB", "amount": 100, "startDate": "2026-08-01 00:00:00+00:00", "recurringFrequency": "MONTHLY" } }'{ "messages": { "en": "We're processing your transfer.", "ar": ".جاري معالجة المعاملة" }, "data": { "schedulerId": "507f1f77bcf86cd799439011", "merchantTransferId": "transfer12349", "recipientName": "Ahmed Mohamed", "recipientNumber": "1012345678", "recipientBank": "CIB", "amount": 100, "method": "bank", "status": "ACTIVE", "recurringFrequency": "MONTHLY", "nextRun": "2026-08-01 00:00:00+00:00", "createdAt": "2026-07-30 10:30:00+00:00" }}Creates a recurring payout scheduler from a single transfer template. Kashier repeats the transfer on the recurringFrequency you set, starting on startDate, until you deactivate the scheduler or it passes its endDate. Each run produces an ordinary transfer you can follow with Get transfer details. The recipient rules are the same as for a one-off transfer: recipientBank is required when method is bank or card, and wallet recipients must be an Egyptian mobile number.
Authorization
secretKey Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
The transfer template to repeat, plus how often to repeat it.
Response Body
application/json
application/json
application/json
application/json
Get payout scheduler details GET
Retrieves one recurring payout scheduler, including the transfer template it repeats, its recurring frequency, and the date it next runs.
List payout batches GET
Lists your payout batches, with pagination. Every bulk payout you submit with Bulk transfers becomes a batch whose row shows how many of its transfers have succeeded and how many have failed, so yo…