Authentication

Bpay Collection API requests (such as balance checks) require authentication. Use HTTP Basic Authentication (API Key and Secret) or pass an access token in the Authorization header. Use one method per request — not both.

Payment collection callbacks are inbound webhooks from Bpay to your server — they do not use your API credentials. See Callbacks.

Generate credentials

API Key and Secret are available from BPAY → API Setup in the Beem dashboard.

Your API Secret is displayed only once. Store it securely, as it cannot be viewed again.

Authentication methods

API Key & Secret
Access Token

Header	Value
`Authorization`	`Basic base64(api_key:secret_key)`
`Content-Type`	`application/json`

Username: API Key
Password: API Secret

GET /v1/credit-balance?app_name=BPAY HTTP/1.1
Host: apitopup.beem.africa
Authorization: Basic <base64-encoded-api_key:secret_key>
Content-Type: application/json

Header	Value
`Authorization`	`<access-token>`
`Content-Type`	`application/json`

Pass your access token directly — do not use a Bearer prefix.

GET /v1/credit-balance?app_name=BPAY HTTP/1.1
Host: apitopup.beem.africa
Authorization: <access-token>
Content-Type: application/json

Never expose your API Key, API Secret, or access token in frontend applications or public repositories.

Authentication errors

HTTP Status	Code	Message
`401`	`120`	Invalid Authentication Parameters
`400`	—	No authorization headers

Getting Started

APIs

Generate credentials

Authentication methods

Authentication errors

​Generate credentials

​Authentication methods

​Authentication errors

Generate credentials

Authentication methods

Authentication errors