Introduction - Beem API

The Beem Payments Hub (Bpay) enables you to receive and send payments from multiple mobile operators through a single unified API. You must provide your own existing billpay or merchant number for Beem to unify all integrations into one account and API.

Collections

Receive payments initiated by subscribers. Bpay forwards transaction details to your callback endpoint.

Multi-network

Accept payments across supported mobile networks with one integration.

Collections flow

Subscriber initiates payment
        │
        ▼
Mobile Network Operator
        │
        ▼
Beem Payments Hub (Bpay)
        │
        │ HTTP POST (JSON)
        ▼
Your callback URL
        │
        ▼
Your server accepts or rejects transaction

When a subscriber initiates a payment, Bpay forwards the transaction to your API endpoint. Your application returns a success or failure status to accept or reject the transaction. If you return successful: false, the transaction is declined with the mobile network and funds are refunded to the subscriber.

What’s in this section

Prerequisites — account setup and product configuration
Authentication — Basic Auth or access token
Callbacks — receive payment notifications
Check balance — retrieve your available Bpay balance
Bpay collection simulator — test your callback without a live payment

API surface

Integration	Direction	Description
Payment callback	Beem → your server	Collection transaction notifications
Check credit balance	Your server → Beem	Query Bpay balance (`app_name=BPAY`)
Bpay simulator	Testing tool	Debug your callback without a live payment