Payouts

Create payout scheduler

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.

post/v2/transfers/schedulers/single

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/transfers/schedulers/single
  • Auth: API key in header Authorization

Request body

batchNamestring

A human-readable label for the payouts this scheduler produces, used for identification and organization purposes.

type'single'

The kind of scheduler being created.

Response

The scheduler was created and is active.

Changes

No recorded changes to this operation across all 1 revision of this API.