@kepas/daraja-js
    Preparing search index...

    Interface RatibaCreateInput

    interface RatibaCreateInput {
        accountReference: string;
        amount: string | number;
        businessShortCode?: string;
        callbackUrl: string;
        endDate: string;
        frequency: RatibaFrequency;
        name: string;
        phone: string;
        startDate: string;
        transactionDesc: string;
        transactionType: "paybill" | "buygoods";
    }
    Index

    Properties

    accountReference amount businessShortCode? callbackUrl endDate frequency name phone startDate transactionDesc transactionType

    Properties

    accountReference: string

    Account number for the paybill. Max 12 chars.

    amount: string | number
    businessShortCode?: string

    Destination shortcode. Defaults to config.shortcode.

    callbackUrl: string
    endDate: string

    yyyymmdd.

    frequency: RatibaFrequency
    name: string

    StandingOrderName — must be unique per customer (duplicate → 1050).

    phone: string

    Customer M-Pesa phone 2547XXXXXXXX (PartyA, the payer).

    startDate: string

    yyyymmdd.

    transactionDesc: string

    Comment. Max 13 chars.

    transactionType: "paybill" | "buygoods"

    Paybill or Buy Goods. Sets TransactionType + ReceiverPartyIdentifierType.

    Settings

    Member Visibility

    On This Page

    Properties