Request checkout page
Request Beem’s hosted checkout page. Set sendSource=true to receive a checkout URL in the response (recommended for backend redirects). Omit or set sendSource=false for an HTTP 302 redirect (recommended for frontend redirects).
Authorizations
Beem API credentials: API key as username, API secret as password.
Headers
Optional client validation token. Sent back in the callback headers if provided.
Query Parameters
Amount the customer must pay. Decimals are not allowed.
x >= 11200
Alphanumeric reference matching your route pattern (e.g. SAMPLE-12345).
"SAMPLE-12345"
UUID v4 to track the payment.
"96f9cc09-afa0-40cf-928a-d7e2b27b2408"
Customer mobile number with country code.
"255701000000"
Customer email address.
ISO currency code. Defaults to TZS.
"TZS"
When true, returns a checkout URL in JSON. When false or omitted, responds with HTTP 302 redirect.
true
Response
Checkout page URL when sendSource=true
URL of the hosted checkout page.
