Receive payment collection callback

curl --request POST \ --url https://example.com/callback \ --header 'Content-Type: application/json' \ --data ' { "transaction_id": "121w", "amount_collected": "4000", "source_currency": "TZS", "target_currency": "TZS", "subscriber_msisdn": "2557777777", "reference_number": "6cc545R", "paybill_number": "2233", "timestamp": "2024-09-05T10:00:00.000Z", "mcc_network": 640, "mnc_network": 4, "network_name": "vodacomtz" } '

Body

application/json

transaction_id

string

required

Unique transaction ID generated by Beem.

amount_collected

string

required

Amount of money collected from the subscriber.

source_currency

string

required

ISO currency code for sending money (default TZS).

target_currency

string

required

ISO currency code for receiving money (default TZS).

subscriber_msisdn

string

required

Subscriber mobile number in international format without the plus symbol, e.g. 255444444444.

reference_number

string

required

Reference number entered by the subscriber.

paybill_number

string

required

Merchant or paybill number the payment was received into.

timestamp

string

required

Transaction timestamp (ISO 8601).

mcc_network

integer

required

Mobile country code identifying the network.

mnc_network

integer

required

Mobile network code identifying the network.

network_name

string

required

Carrier name, e.g. tigotz, airteltz, vodacomtz.

Response

200 - application/json

Acknowledge and accept or reject the payment

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

Getting Started

APIs

Receive payment collection callback

Body

Response