Introduction - Beem API

The Beem Payments Hub (Bpay) Checkout service lets you accept payments from mobile subscribers through Beem’s hosted payment page or an embedded checkout iframe in your application.

Redirect method

Send customers to Beem’s secured hosted checkout page to complete payment.

Iframe method

Embed a checkout button and iframe so customers stay on your website.

Checkout flow

Customer proceeds to checkout
        │
        ▼
Your application requests Beem checkout
        │
        ▼
Beem hosted payment page / iframe
        │
        ▼
Customer completes payment
        │
        │ HTTP POST callback
        ▼
Your server receives payment status

API reference

Endpoint	Description
Request checkout page	`GET /checkout` — start a redirect checkout session
Whitelist website	`POST /whitelist/add-to-list` — required for iframe checkout
Receive checkout callback	`POST /callback` — webhook your server implements

Integration methods

Method	Guide	API
Redirect	Redirect method	Request checkout page
Iframe	Iframe method	Whitelist website

Both methods use the same callback format for payment status notifications.

What’s in this section

Prerequisites — account setup and route configuration
Authentication — Basic Auth or access token
Redirect method — hosted checkout page integration
Iframe method — embedded checkout library
Callbacks — receive payment status notifications
Error codes — common checkout errors
Sandbox — test your integration