Skip to main content
GET
Request checkout page

Authorizations

Authorization
string
header
required

Beem API credentials: API key as username, API secret as password.

Headers

beem-secure-token
string

Optional client validation token. Sent back in the callback headers if provided.

Query Parameters

amount
integer
required

Amount the customer must pay. Decimals are not allowed.

Required range: x >= 1
Example:

1200

reference_number
string
required

Alphanumeric reference matching your route pattern (e.g. SAMPLE-12345).

Example:

"SAMPLE-12345"

transaction_id
string<uuid>
required

UUID v4 to track the payment.

Example:

"96f9cc09-afa0-40cf-928a-d7e2b27b2408"

mobile
string

Customer mobile number with country code.

Example:

"255701000000"

email
string<email>

Customer email address.

currency
string
default:TZS

ISO currency code. Defaults to TZS.

Example:

"TZS"

sendSource
boolean

When true, returns a checkout URL in JSON. When false or omitted, responds with HTTP 302 redirect.

Example:

true

Response

Checkout page URL when sendSource=true

src
string
required

URL of the hosted checkout page.