Interface: DisbursePayload

Payload for sending a disbursement (B2C / wallet-out).

Pass this to PesaInstance.disburse to send money to a customer's mobile money wallet or bank account.

Mobile money — provide recipient.phone. Bank payout — provide recipient.accountNumber + recipient.bic.

Since

0.1.0 (mobile money), 0.2.0 (bank payout fields)

Property	Type	Description	Defined in
`amount`	`number`	Amount in whole TZS. Must be > 0.	packages/pesa/src/types/disbursement.ts:38
`currency`	`Currency`	Currency code. Currently only `'TZS'`.	packages/pesa/src/types/disbursement.ts:40
`recipient`	{ `accountNumber?`: `string`; `bic?`: `string`; `name?`: `string`; `network?`: `MobileNetwork`; `phone?`: `string`; `transferType?`: `BankTransferType`; }	Recipient details.	packages/pesa/src/types/disbursement.ts:42
`recipient.accountNumber?`	`string`	Bank account number (for bank payouts).	packages/pesa/src/types/disbursement.ts:50
`recipient.bic?`	`string`	Bank identifier code — fetch via `getBanks()` on supported providers.	packages/pesa/src/types/disbursement.ts:52
`recipient.name?`	`string`	Recipient's full name (optional but recommended).	packages/pesa/src/types/disbursement.ts:46
`recipient.network?`	`MobileNetwork`	Target mobile money network.	packages/pesa/src/types/disbursement.ts:48
`recipient.phone?`	`string`	Mobile money phone number in MSISDN format: `255XXXXXXXXX`.	packages/pesa/src/types/disbursement.ts:44
`recipient.transferType?`	`BankTransferType`	Transfer type for bank payouts: `"ACH"` (default) or `"RTGS"`.	packages/pesa/src/types/disbursement.ts:54
`reference`	`string`	Your internal reference. Must be unique.	packages/pesa/src/types/disbursement.ts:57
`remarks?`	`string`	Optional remarks / narration for the payout.	packages/pesa/src/types/disbursement.ts:59