Class: ClickPesaProvider

Defined in: providers/clickpesa/src/clickpesa.ts:84

Extends

• BasePaymentProvider

Constructors

Constructor

new ClickPesaProvider(config): ClickPesaProvider;

Defined in: providers/clickpesa/src/clickpesa.ts:91

Parameters

Returns

ClickPesaProvider

Overrides

BasePaymentProvider.constructor

Properties

Methods

cancelOrder()?

optional cancelOrder(_orderId): Promise<CancelOrderResult>;

Defined in: packages/pesa/dist/providers/base.d.ts:99

Cancel a pending or in-progress order.

Parameters

Returns

Promise<CancelOrderResult>

Throws

PesaUnsupportedError — if the provider does not support cancellation.

Inherited from

BasePaymentProvider.cancelOrder

createOrder()

createOrder(payload): Promise<OrderResult>;

Defined in: providers/clickpesa/src/clickpesa.ts:200

Initiate a checkout / USSD push / redirect.

The SDK calls validateCreateOrderPayload() before this, so you can assume amount > 0, reference is non-empty, and customer.phone is in MSISDN format.

Parameters

Returns

Promise<OrderResult>

Overrides

BasePaymentProvider.createOrder

disburse()

disburse(payload): Promise<DisburseResult>;

Defined in: providers/clickpesa/src/clickpesa.ts:346

B2C / wallet-out disbursement.

The SDK calls validateDisbursePayload() before this.

Parameters

Returns

Promise<DisburseResult>

Overrides

BasePaymentProvider.disburse

getNameLookup()

getNameLookup(phoneOrAccount): Promise<NameLookupResult>;

Defined in: providers/clickpesa/src/clickpesa.ts:429

Resolve the account holder name for a phone or account number.

Useful for verifying recipient identity before disbursing.

Parameters

Returns

Promise<NameLookupResult>

Throws

PesaUnsupportedError — if the provider does not support name lookup.

Overrides

BasePaymentProvider.getNameLookup

getPaymentStatus()

getPaymentStatus(orderId): Promise<PaymentStatus>;

Defined in: providers/clickpesa/src/clickpesa.ts:261

Poll or fetch the current payment status for an order.

Parameters

Returns

Promise<PaymentStatus>

Overrides

BasePaymentProvider.getPaymentStatus

handleWebhook()

handleWebhook(rawBody, headers): Promise<PaymentEvent>;

Defined in: providers/clickpesa/src/clickpesa.ts:285

Parse + verify an incoming webhook.

The provider must:

1. Verify its own cryptographic signature (HMAC, checksum, etc.)
2. Parse the raw body into structured data
3. Return a normalized PaymentEvent

The SDK handles UUID assignment, event persistence, plugin hooks, and user-registered handler emission after this method returns.

Parameters

Returns

Promise<PaymentEvent>

Overrides

BasePaymentProvider.handleWebhook

listOrders()?

optional listOrders(_params): Promise<ListOrdersResult>;

Defined in: packages/pesa/dist/providers/base.d.ts:139

List payment orders for a date range.

Parameters

Returns

Promise<ListOrdersResult>

Throws

PesaUnsupportedError — if the provider does not support listing orders.

Inherited from

BasePaymentProvider.listOrders

previewDisburse()

previewDisburse(payload): Promise<PreviewResult>;

Defined in: providers/clickpesa/src/clickpesa.ts:408

Preview / dry-run a disbursement before committing.

Parameters

Returns

Promise<PreviewResult>

Throws

PesaUnsupportedError — if the provider does not support preview.

Overrides

BasePaymentProvider.previewDisburse

previewOrder()

previewOrder(payload): Promise<PreviewResult>;

Defined in: providers/clickpesa/src/clickpesa.ts:387

Preview / dry-run a payment before committing.

Returns expected fees and validity without charging the customer.

Parameters

Returns

Promise<PreviewResult>

Throws

PesaUnsupportedError — if the provider does not support preview.

Overrides

BasePaymentProvider.previewOrder

refund()?

optional refund(_orderId, _amount?): Promise<RefundResult>;

Defined in: packages/pesa/dist/providers/base.d.ts:93

Refund a completed payment.

Parameters

Returns

Promise<RefundResult>

Throws

PesaUnsupportedError — if the provider does not support refunds.

Inherited from

BasePaymentProvider.refund

validateCredentials()

validateCredentials(): Promise<{
  message?: string;
  valid: boolean;
}>;

Defined in: providers/clickpesa/src/clickpesa.ts:378

Validate that a provider config works (health check).

Useful for startup checks or /health endpoints.

Returns

Promise<{ message?: string; valid: boolean; }>

{ valid: true } if credentials are correct.

Throws

PesaUnsupportedError — if the provider does not support validation.

Overrides

BasePaymentProvider.validateCredentials