Interface: DisbursePayload
Defined in: packages/pesa/src/types/disbursement.ts:28
Payload for sending a disbursement (B2C / wallet-out).
Pass this to PesaInstance.disburse to send money to a customer's mobile money wallet.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
amount | number | Amount in whole TZS. Must be > 0. | packages/pesa/src/types/disbursement.ts:30 |
currency | "TZS" | Currency code. Currently only 'TZS'. | packages/pesa/src/types/disbursement.ts:32 |
recipient | { name?: string; network?: MobileNetwork; phone: string; } | Recipient details. | packages/pesa/src/types/disbursement.ts:34 |
recipient.name? | string | Recipient's full name (optional but recommended). | packages/pesa/src/types/disbursement.ts:38 |
recipient.network? | MobileNetwork | Target mobile money network. | packages/pesa/src/types/disbursement.ts:40 |
recipient.phone | string | Mobile money phone number in MSISDN format: 255XXXXXXXXX. | packages/pesa/src/types/disbursement.ts:36 |
reference | string | Your internal reference. Must be unique. | packages/pesa/src/types/disbursement.ts:43 |
remarks? | string | Optional remarks / narration for the payout. | packages/pesa/src/types/disbursement.ts:45 |