Class AirtimeService

Index

Constructors

Methods

detectNetwork getCatalog getStatus purchase

Constructors

constructor

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

Methods

detectNetwork

detectNetwork(
msisdn: string,
options?: RequestOptions,
): Promise<APIResponseEnvelope<{ msisdn: string; network: string }>>
Detect mobile network operator from MSISDN phone number.
Parameters
- msisdn: string
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<{ msisdn: string; network: string }>>
- Defined in src/services/airtime.ts:31

getCatalog

getCatalog(
network?: string,
options?: RequestOptions,
): Promise<APIResponseEnvelope<AirtimeCatalogData>>
Retrieve available data bundle catalog by network.
Parameters
- Optionalnetwork: string
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<AirtimeCatalogData>>
- Defined in src/services/airtime.ts:18

getStatus

getStatus(
reference: string,
options?: RequestOptions,
): Promise<APIResponseEnvelope<AirtimePurchaseData>>
Check status of airtime/data purchase transaction by reference UUID.
Parameters
- reference: string
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<AirtimePurchaseData>>
- Defined in src/services/airtime.ts:78

purchase

purchase(
params: AirtimePurchaseParams,
options?: RequestOptions,
): Promise<APIResponseEnvelope<AirtimePurchaseData>>
Purchase airtime or data bundles for MTN, Airtel, or Lyca.
Parameters
- params: AirtimePurchaseParams
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<AirtimePurchaseData>>
Example
```
const topup = await marzpay.airtime.purchase({
  reference: 'ref-airtime-001',
  purchase_type: 'airtime',
  msisdn: '+256777123456',
  amount: 5000,
}, { idempotencyKey: 'idemp-airtime-001' });
```
- Defined in src/services/airtime.ts:59