Interface: OrderResult

Defined in: packages/pesa/src/types/order.ts:104

Result returned after initiating a payment.

The shape varies by provider. Redirect-based providers (DPO, Pesapal) return checkoutUrl. USSD push providers (Selcom, ClickPesa) set ussdPushInitiated: true.

Example

const order = await pesa.createOrder({ ... });

if (order.checkoutUrl) {
  // Redirect-based flow: send customer to the URL
  return redirect(order.checkoutUrl);
}
// USSD push flow: customer receives a PIN prompt on their phone

Properties