Interface: DisburseResult
Defined in: packages/pesa/src/types/disbursement.ts:65
Result returned after initiating a disbursement.
Example
const result = await pesa.disburse({
amount: 50000,
currency: 'TZS',
reference: 'payout_001',
recipient: { phone: '255754321098', network: 'MPESA' },
});
if (result.status === 'SUCCESS') {
console.log(`Disbursement ${result.disbursementId} sent`);
}Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
disbursementId | string | Provider-assigned disbursement ID. | packages/pesa/src/types/disbursement.ts:67 |
raw? | unknown | Raw provider response. Escape hatch. | packages/pesa/src/types/disbursement.ts:78 |
reference | string | Your reference, echoed back. | packages/pesa/src/types/disbursement.ts:69 |
status | "SUCCESS" | "FAILED" | "QUEUED" | Disbursement status. - SUCCESS — funds sent - QUEUED — processing, poll for updates - FAILED — definitively failed | packages/pesa/src/types/disbursement.ts:76 |