Class BillPaymentsService

Index

Constructors

Methods

getDSTVBouquets getGOTVBouquets getNWSCAreas getStatus listTransactions pay verify

Constructors

constructor

new BillPaymentsService(http: HttpClient): BillPaymentsService
Parameters
- http: HttpClient
Returns BillPaymentsService
- Defined in src/services/bill-payments.ts:15

Methods

getDSTVBouquets

getDSTVBouquets(
options?: RequestOptions,
): Promise<APIResponseEnvelope<{ bouquets: TVBouquet[] }>>
Get DSTV bouquet codes and pricing.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<{ bouquets: TVBouquet[] }>>
- Defined in src/services/bill-payments.ts:110

getGOTVBouquets

getGOTVBouquets(
options?: RequestOptions,
): Promise<APIResponseEnvelope<{ bouquets: TVBouquet[] }>>
Get GOTV bouquet codes and pricing.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<{ bouquets: TVBouquet[] }>>
- Defined in src/services/bill-payments.ts:121

getNWSCAreas

getNWSCAreas(
options?: RequestOptions,
): Promise<APIResponseEnvelope<{ areas: string[] }>>
Get supported NWSC areas.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<{ areas: string[] }>>
- Defined in src/services/bill-payments.ts:99

getStatus

getStatus(
reference: string,
options?: RequestOptions,
): Promise<APIResponseEnvelope<PayBillData>>
Get status of a bill payment by reference.
Parameters
- reference: string
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<PayBillData>>
- Defined in src/services/bill-payments.ts:87

listTransactions

listTransactions(
options?: RequestOptions,
): Promise<APIResponseEnvelope<Record<string, unknown>>>
List past bill payment transactions.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<Record<string, unknown>>>
- Defined in src/services/bill-payments.ts:76

pay

pay(
params: PayBillParams,
options?: RequestOptions,
): Promise<APIResponseEnvelope<PayBillData>>
Pay electricity (LIGHT), water (NWSC), or TV (DSTV/GOTV) bill.
Parameters
- params: PayBillParams
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<PayBillData>>
Example
```
const payment = await marzpay.billPayments.pay({
  reference: 'ref-bill-001',
  utility_code: 'NWSC',
  meter_number: '14234567890',
  phone_number: '+256777123456',
  amount: 20000,
  area: 'Kampala'
}, { idempotencyKey: 'idemp-bill-001' });
```
- Defined in src/services/bill-payments.ts:55

verify

verify(
params: VerifyBillParams,
options?: RequestOptions,
): Promise<APIResponseEnvelope<VerifyBillData>>
Verify meter, account number, or smartcard before paying utility bills.
Parameters
- params: VerifyBillParams
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<VerifyBillData>>
Example
```
const verification = await marzpay.billPayments.verify({
  utility_code: 'NWSC',
  meter_number: '14234567890',
  area: 'Kampala'
});
```
- Defined in src/services/bill-payments.ts:29