ratiba_create
Create M-Pesa Ratiba standing orders for recurring collections: subscriptions, loan repayments, insurance premiums. Customers approve via an M-Pesa prompt.
Instructions
Create an M-Pesa Ratiba standing order for recurring collection: subscriptions, loan repayments, insurance premiums, SACCO contributions. The customer approves via an M-Pesa prompt. The standing order name must be unique per customer.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | Amount in KES. Whole numbers only. | |
| endDate | Yes | Final execution date, yyyymmdd or yyyy-mm-dd. | |
| frequency | Yes | How often the standing order executes. | |
| shortCode | No | ||
| startDate | Yes | First execution date, yyyymmdd or yyyy-mm-dd. | |
| callbackUrl | No | ||
| phoneNumber | Yes | Customer phone number. Accepts 07..., +2547..., or 2547... and is normalised. | |
| receiverType | No | Whether the shortcode is a PayBill or a Buy Goods till. | paybill |
| transactionDesc | No | ||
| accountReference | No | ||
| standingOrderName | Yes | Name of the standing order. Must be unique for this customer; a repeat name is rejected. |