How to integrate

Use these query parameters to pre-fill and customize the Pretium Checkout when using the iframe.

Required parameters

Parameter
Type
Description
Example

amount

Number

Amount in fiat/local currency

1000

currency_code

String

3-letter ISO 4217 fiat currency code

KES, MWK, GHS

checkout_ref

String

Your unique checkout reference

chk_01hxyz

order_id

String

Your internal order ID (will be returned in webhook)

ORD-2025-123

Quick Start (Copy-Paste Integration)

Retrieve the checkout key from your merchant dashboard and pass it as your checkout_ref.

Add this single tag to your checkout or payment page:

<iframe
  src="https://checkout.pretium.africa?amount=30&currency_code=KES&checkout_ref=jdhdyeere&order_id=123"
  width="100%"
  height="600px"
  frameborder="0"
  >
</iframe>

Full Example URL:


  https://checkout.pretium.africa?amount=30&currency_code=KES&checkout_ref=kwe2213w&order_id=123

Webhook / Callback (Recommended)

callback-url?order_id=your_order_id

Use this to:

  • Mark the order as paid

  • Send receipt email

Last updated