Class CollectionsService

Index

Constructors

Methods

create getStatus listServices

Constructors

constructor

new CollectionsService(http: HttpClient): CollectionsService
Parameters
- http: HttpClient
Returns CollectionsService
- Defined in src/services/collections.ts:14

Methods

create

create(
params: CreateCollectionParams,
options?: RequestOptions,
): Promise<APIResponseEnvelope<CreateCollectionData>>
Initiate a mobile money or card collection request.
Parameters
- params: CreateCollectionParams
  Collection parameters including amount, optional reference UUID, and country
- Optionaloptions: RequestOptions
  Optional per-request options (e.g. idempotencyKey, custom headers)
Returns Promise<APIResponseEnvelope<CreateCollectionData>>
Initiated transaction details and processing info
- Defined in src/services/collections.ts:23

getStatus

getStatus(
uuid: string,
options?: RequestOptions,
): Promise<APIResponseEnvelope<GetCollectionStatusData>>
Retrieve status and details of a collection request by UUID.
Parameters
- uuid: string
  Transaction UUID returned during collection creation
- Optionaloptions: RequestOptions
  Optional per-request options
Returns Promise<APIResponseEnvelope<GetCollectionStatusData>>
- Defined in src/services/collections.ts:60

listServices

listServices(
params?: { country?: string },
options?: RequestOptions,
): Promise<APIResponseEnvelope<CollectionServicesData>>
List available collection services and providers by country.
Parameters
- Optionalparams: { country?: string }
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<CollectionServicesData>>
- Defined in src/services/collections.ts:44