Skip to main content
POST
Your callback URL must be publicly reachable over HTTPS. The simulator forwards each request to your endpoint via https://paysim.beem.africa/.

​
How to use

1

Choose a network example

Pick Tigo, Airtel, or Vodacom from the examples dropdown. Each sets the correct network_name and mnc_network.
2

Set your callback URL

Replace callbackUrl with your publicly accessible endpoint, then click Try it.
3

Verify your handler

Confirm your server returns HTTP 200 with { "transaction_id": "...", "successful": "true" }.

Body

application/json
​
network_name
enum<string>
required

Mobile network operator to simulate.

Available options:
tigotz,
airteltz,
vodacomtz
​
subscriber_msisdn
string
required

Subscriber phone number (12 digits).

Example:

"255673089337"

​
paybill_number
string
required

Merchant or paybill number receiving the payment.

Example:

"123456789098"

​
amount_collected
string
required

Payment amount in Tanzanian shillings.

Example:

"105000"

​
reference_number
string
required

Reference number entered by the subscriber.

Example:

"123455555558"

​
callbackUrl
string<uri>
required

Your publicly accessible collection callback endpoint (HTTPS).

Example:

"https://your-app.example.com/payment/callback"

​
transaction_id
string
required

Unique transaction ID for this test payment.

Example:

"a1b2c3d4-e5f6-4789-a012-3456789abcde"

​
timestamp
string<date-time>
required

Transaction timestamp (ISO 8601).

Example:

"2024-09-05T10:00:00.000Z"

​
mcc_network
integer
required

Mobile country code. Use 640 for Tanzania.

Example:

640

​
mnc_network
integer
required

Mobile network code: 2 (Tigo), 5 (Airtel), 4 (Vodacom).

Example:

2

​
source_currency
string
required

ISO currency code for sending money.

Example:

"TZS"

​
target_currency
string
required

ISO currency code for receiving money.

Example:

"TZS"

Response

200 - application/json

Response from your callback handler

​
transaction_id
string
required

Echo the transaction_id from the callback request.

​
successful
enum<string>
required

Set to true to accept the payment. If false, the transaction is declined and funds are refunded to the subscriber.

Available options:
true,
false