Class DisbursementsService

Index

Constructors

Methods

getStatus listServices send

Constructors

constructor

new DisbursementsService(http: HttpClient): DisbursementsService
Parameters
- http: HttpClient
Returns DisbursementsService
- Defined in src/services/disbursements.ts:13

Methods

getStatus

getStatus(
uuid: string,
options?: RequestOptions,
): Promise<APIResponseEnvelope<SendMoneyData>>
Retrieve disbursement request status by UUID.
Parameters
- uuid: string
  Transaction UUID returned from disbursement request
- Optionaloptions: RequestOptions
  Optional per-request options
Returns Promise<APIResponseEnvelope<SendMoneyData>>
- Defined in src/services/disbursements.ts:59

listServices

listServices(
params?: { country?: string },
options?: RequestOptions,
): Promise<APIResponseEnvelope<SendMoneyServicesData>>
List limits and available disbursement services per market.
Parameters
- Optionalparams: { country?: string }
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<SendMoneyServicesData>>
- Defined in src/services/disbursements.ts:43

send

send(
params: SendMoneyParams,
options?: RequestOptions,
): Promise<APIResponseEnvelope<SendMoneyData>>
Send funds (disbursement / payout) to a recipient mobile money wallet.
Parameters
- params: SendMoneyParams
  Disbursement request parameters
- Optionaloptions: RequestOptions
  Optional per-request options (e.g. idempotencyKey, custom headers)
Returns Promise<APIResponseEnvelope<SendMoneyData>>
Created payout details with fee deductions and updated wallet balance
- Defined in src/services/disbursements.ts:22