Download OpenAPI specification:
This API is part of the our ecosystem. It allows you to make payments, find out the status of transactions and much more. Here you will find the latest documentation on setting up your solution.
| Provider ID | Provider Name | Country | Notes |
|---|---|---|---|
| 14 | Simulator | ANY | For testing |
During tests runs, using 14 provider ID (simulator) the callback is not returned and the transaction remains in the "in progress" status and if successful you will see in the response
{
"order_id": "54321",
"transaction_id": "12345",
"transaction_ref": "",
"status": 1,
"result": {
"code": 0,
"message": "OK"
},
"provider_result": {
"code": -8888,
"message": "Good"
},
"service_id": 1,
"service_version": "1.03/1.14|1.0/1.26|1.0/1.0|1.01/1.01|1.01/1.01||1.01/1.27",
"service_date_time": "2023-05-15 10:00:00.000000",
"confirm_type": 0
}
Merchant’s request and callback have to be signed to verify sent data. To generate the signature all sent parameters from the payload are included in the order they were sent. The parameter signature should be excluded, of course, and added to the payload after generating.
Note: to generate a correct signature you need a secretKey received with other credentials.
function calculateSignature(array $data, string $secretKey, string $currentParamPrefix = '', int $depth = 16, int $currentRecursionLevel = 0 ): string
{
if ($currentRecursionLevel >= $depth) {
throw new Exception('Recursion level exceeded');
}
$stringForSignature = '';
foreach ($data as $key => $value) {
if (is_array($value)) {
$stringForSignature .= calculateSignature(
$value,
$secretKey,
"$currentParamPrefix$key.",
$depth,
$currentRecursionLevel + 1
);
} else if ($key !== 'signature') {
$stringForSignature .= "$currentParamPrefix$key" . $value;
}
}
if ($currentRecursionLevel == 0) {
return strtolower(hash_hmac('sha512', $stringForSignature, $secretKey));
} else {
return $StringForSignature;
}
}
$postData = [
'merchant_id' => 'fffed61be9780b97c5e4c65e4e07bb6b',
'provider_id' => 10,
'client_id' => '254000000000',
'country' => 'KE',
'order_id' => 'order_3444298767545',
'amount' => 1000,
'currency' => 'KES',
'callback_url' => 'https://my.callback.url'
];
$secretKey = "cf11635572c1e8d77297207152dc0791ad91f22b32d23c758ce3ba2637202ad8f7290ba41f2243cccf32edde1dfb8bf0f5dea62525309e293b3adb2c76eed6a5";
$signature = calculateSignature($postData, $secretKey);
$postData['signature'] = $signature;
Examples in other languages are available on request
| Code | Name | Description |
|---|---|---|
| -1 | undefined | Operation status is undefined (for example in an error situation) |
| 0 | initiated | Operation is initiated |
| 1 | in progress | Operation is in progress |
| 2 | success | Operation is successful |
| 3 | failed | Operation is failed |
| 4 | cancelled | Operation is cancelled |
Depending on the type of request you may see the following code
| Code | Operation |
|---|---|
| 16 | payment_b2c |
| 17 | payment_c2b |
| Code | Name | Locations |
|---|---|---|
| CDF | Congolese Franc | DRC |
| KES | Kenyan shilling | the Republic of Kenya |
| GMD | Gambian Dalasi | Gambia |
| MWK | Malawian kwacha | Malawi |
| NGN | Naira | Nigeria |
| RWF | Rwandan franc | Rwanda |
| TZS | Tanzanian shilling | Tanzania |
| UGX | Ugandan shilling | Uganda |
| XOF | CFA franc BCEAO | Benin, Burkina Faso, Ivory Coast, Guinea-Bissau, Mali, Niger, Senegal, Togo |
| ZMW | Zambian Kwacha | Zambia |
| EGP | Egyptian pound | Egypt |
Responses for confirmation requests have the same format as original operation responses.
Transaction status is sent via callback because it needs a confirmation by client done asynchronously. Usually the callback should be sent in 2-3 minutes maximum. In case of missing callback there is a way to get the transaction status using API method status. It needs the order ID as an parameter and returns a status of the performed transaction.
Payment gateway considers the Merchant system response as successful if HTTP 200 was received.
| Provider ID | Provider Name | Notes |
|---|---|---|
| MOOV | ||
| 9210 | MTN |
2290000000000 - This is the format of the phone number you have to send in the payment requests.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| XOF 100.00 | XOF 100.00 | XOF 1 000 000.00 |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 9209 | Orange | |
| Moov |
22600000000 - This is the format of the phone number you have to send in the payment requests.
*144*4*6*montant#Example Request:
{
"merchant_id": "your merchant id",
"customer_id": "2250705145655",
"order_id": "test_161225_01_1",
"amount": "1100",
"currency": "XOF",
"country": "BF",
"callback_url": "your callback url",
"provider_id": "9209",
"signature": "1c594d338bc3f413bd61cb97d697e98ad5772071da533",
"extra": {
"otp": "5647"
},
}
Note: deposits and withdrawals are made in multiples of 5.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| XOF 200.00 | XOF 200.00 | XOF 1 000 000.00 |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 802, 9062, 702 | Orange | |
| 803, 9063, 703, 9131 | MTN |
237000000000 - This is the format of the phone number you have to send in the payment requests.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| XAF 500 | XAF 500 | XAF 500000 |
| c2b Minimum | b2c Minimum | c2b Maximum | b2c Maximum |
|---|---|---|---|
| KES 10.00 | KES 10.00 | KES 10000.00 | KES 1000000.00 |
For 9062, 9063:
C2B
B2C
For 9062, 9063:
| c2b Minimum | b2c Minimum | c2b Maximum | b2c Maximum |
|---|---|---|---|
| XAF 500 | XAF 500 | XAF 500 000 | XAF 500 000 |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 2197 | Orange | Client's phone should start from 0: 0800000000 |
| 2198 | Airtel | Client's phone shouldn't start from 0: 999000000 |
| 2196 | Vodacom | 243000000000 - This is the format of the phone number sent in the request |
| 2199 | Africel | Client's phone should start from 0: 0900000000 |
The flow is standard, no need to pass extra parameters
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| CDF 100 | CDF 100 | CDF 1500000 |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 9227 | WavePGT GMB | Check provider id with your manager |
For 9227
C2B
B2C
| c2b minimum | b2c minimum | c2b maximum | b2c maximum |
|---|---|---|---|
| GMD 10 | GMD 10 | No Limit | No Limit |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 2303, 2333, 699, 805, 9196, 2430 | MTN | Check provider id with your manager |
| 2304, 2334, 806, 9197 | Orange | Check provider id with your manager |
| 2305, 2335, 804, 9198 | Moov | Check provider id with your manager |
| 2306, 2336, 9199, 2431 | Wave | Check provider id with your manager |
2250000000000 - This is the format of the phone number you have to send in the payment requests.
For B2C payments, you should send a customer full name in the payment requests. Parameter extra->customer_name. Please see the example in the API Methods section.
Note: deposits and withdrawals are made in multiples of 5.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| XOF 200.00 | XOF 200.00 | XOF 1 000 000.00 |
Example Request:
{
"merchant_id": "your merchant id",
"customer_id": "2250705145655",
"order_id": "test_161225_01_1",
"amount": "1100",
"currency": "XOF",
"country": "CI",
"callback_url": "your callback url",
"provider_id": "9197",
"signature": "1c594d338bc3f413bd61cb97d697e98ad5772071da533",
"extra": {
"otp": "5647"
},
}
Note: deposits and withdrawals are made in multiples of 5.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| XOF 200.00 | XOF 200.00 | XOF 1 000 000.00 |
Note: deposits and withdrawals are made in multiples of 5.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| XOF 200.00 | XOF 200.00 | XOF 1 000 000.00 |
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| XOF 1.00 | XOF 1.00 | no limit |
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| XOF 1.00 | XOF 1.00 | no limit |
C2B
Example of a status request:
{
"merchant_id":"cdeffe6210c7fdc7402c13b215455bd8ddec02da0c",
"order_id":"55584tty848rt",
"customer_id":"2250768000000",
"extra":{
"otp":"7374"
},
"signature":"d7d6d76bd12bfd24dytu6u6c803be455d81cfe792f00cd8892c26ce7cf5a05beebb9c80843e"
}
B2C
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| XOF 300.00 | XOF 500.00 | XOF 2 000 000.00 |
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| XOF 5.00 | XOF 1.00 | XOF 550000.00 |
| c2b minimum | b2c minimum | c2b maximum transaction limit | b2c maximum transaction limit |
|---|---|---|---|
| XOF 10.00 | XOF 10.00 | XOF 1000000.00 | XOF 1000000.00 |
| c2b minimum | b2c minimum | c2b maximum transaction limit | b2c maximum transaction limit |
|---|---|---|---|
| XOF 100.00 | XOF 500.00 | XOF 2000000.00 | XOF 2000000.00 |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 2087 | Airtel | |
| 2088 | TNM |
265000000000 - This is the format of the phone number you have to send in the payment requests.
For C2B payments, the flow is standard, no need to pass extra parameters For B2C payments, you should send a customer full name in the payment requests. Parameter extra->customer_name. Please see the example in the API Methods section.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| MWK 50.00 | MWK 50.00 | MWK 750000.00 |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 2311, 706, 9122, 9143, 9231 | BankTransfer | |
| 2312, 9230 | BankTransfer OPay | |
| 707, 9123 | Bank Card |
Bank Transfer / Pay Attitude / OPay / Palmpay / Card payment C2B (deposit) scenario:
OPay payment B2C (withdrawal) scenario:
Bank Transfer B2C (withdrawal) scenario:
B2C Bank Transfer request example:
{
"merchant_id":"e0fecd91fcb24f348048193b3fb34875ba3722b4",
"order_id":"0900000001",
"customer_id":"16280954971628095497",
"amount":"100.00",
"currency":"NGN",
"provider_id":5026,
"extra":{
"customer_name":"Name Lastname",
"customer_email": "Name@domen.com",
"bank_code":"000001"
},
"signature":"d7d6d76b0e22c6f9d369fa6c24f107053d12bfd24d3b154f2deb6676bf179c123134e1f20879c803be455d81cfe792f00cd8892c26ce7cf5a05beebb9c80843e"
}
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| NGN 100.00 | NGN 100.00 | NGN 400000.00 |
In the synchronized response, you will get the bank payment details that need to be share to the user. This is listed in the "extra" part
{
"order_id": "90900000001",
"transaction_id": "",
"transaction_ref": "",
"status": 1,
"result": {
"code": 0,
"message": "OK"
},
"provider_result": {
"code": -8888,
"message": ""
},
"service_id": 1,
"service_version": "1.03/1.14|1.0/2.0|1.0/1.0|1.01/1.0|1.01/2.0||1.02/1.27",
"service_date_time": "2024-04-20 01:08:42.797957",
"extra": {
"transfer_amount": 100,
"account_name": "Test Ltd / Test Limited",
"account_number": "4000000000",
"bank_name": "Premium Trust Bank"
},
"confirm_type": 0
}
For other provider_id in the case of bank transfers, a payment page implementation is required
C2B:
B2C:
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| NGN 100.00 | NGN 100.00 | NGN 100 000 000 .00 |
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| NGN 100.00 | NGN 100.00 | NGN 10000000.00 |
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| NGN 100.00 | NGN 100.00 | NGN 10000000.00 |
| c2b minimum | c2b maximum transaction limit |
|---|---|
| NGN 100.00 | NGN 200 000.00 |
| c2b minimum | b2c minimum | c2b maximum | b2c maximum |
|---|---|---|---|
| NGN 1.00 | NGN 1.00 | no limit | NGN 100000000.00 |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 2313 | Vodafon | |
| 2314 | Orange | |
| 2315 | Etisalat |
22898200000 - This is the format of the phone number you have to send in the payment requests.
Customer initiates the payment on Merchant side
Merchant sends request to the platform (POST payment_c2b) with parameters extra->customer_name and extra->return_url
Merchant gets the status of the operation (POST status) and gets extra parameters from the response extra->customer_redirect
Merchant redirects the customer to the page from the customer_redirect url
Customer submit form on provider payment page
Customer gets push from operator and confirm the operation
Merchant gets a callback (or requests the status) with the final state of the operation
Customer initiates the payment on Merchant side
Merchant sends request to the platform (POST payment_b2c)
Customer receives funds to his mobile number
Merchant gets a callback (or requests the status) with the final state of the operation
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| EGP 350.00 | EGP 350.00 | EGP 15000.00 |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 2354, 2398, 9203 | Orange Money | |
| 2355, 2401, 9205 | Wave | |
| 2356, 2399 | Free Money | |
| 2400 | E Money |
221000000000 - This is the format of the phone number you have to send in the payment requests.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| XOF 100.00 | XOF 100.00 | XOF 500000.00 |
Note: deposits and withdrawals are made in multiples of 5.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| XOF 200.00 | XOF 200.00 | XOF 1 000 000.00 |
Note: deposits and withdrawals are made in multiples of 5.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| XOF 200.00 | XOF 200.00 | XOF 1 000 000.00 |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 2353 | Bank Transfer |
27000000000 - This is the format of the phone number you have to send in the payment requests.
| Provider ID | Provider Name | Notes |
|---|---|---|
| 2361 | Orange Money |
232000000000 - This is the format of the phone number you have to send in the payment requests.
| Provider ID | Provider Name | Notes |
|---|---|---|
| 2351 | Airtel | |
| 2352 | MTN |
250000000000 - This is the format of the phone number you have to send in the payment requests.
For C2B payments you should send a customer full name and customer email in the payment requests. Parameters extra->customer_name and extra->customer_email. Please see the example in the API Methods section.
You can get the link in the parameter extra->customer_redirect in the response of the status method. After receiving the link, you should redirect the customer to this page to confirm the transaction using OTP code.
For B2C payments you should send a customer full name in the payment requests. Parameter extra->customer_name. Please see the example in the API Methods section.
For 2351, 2352:
| c2b minimum | b2c minimum | Maximum transaction limit | Daily cumulative limit for b2c |
|---|---|---|---|
| RWF 100.00 | RWF 100.00 | RWF 10000000 | RWF 10000000 |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 2109, 2111, 2308, 2323, 2339, 2403 | YAS (exTigo) | Check provider id with your manager |
| 2110, 2112, 2307, 2322, 2340 | Vodacom | Check provider id with your manager |
| 2108, 2113, 2309, 2338, 2404 | HaloPesa | Check provider id with your manager |
| 2107, 2114, 2310, 2337, 2402 | Airtel | Check provider id with your manager |
| 2405 | Bank Transfer | Check provider id with your manager |
255000000000 - This is the format of the phone number you have to send in the payment requests.
For C2B payments, you should send a customer full name and customer email in the payment requests. Parameters extra->customer_name and extra->customer_email. Please see the example in the API Methods section.
For C2B payments the flow is standard.
For B2C payments, you should send a customer full name in the payment requests. Parameter **extra->customer_name**. Please see the example in the API Methods section.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| TZS 1000.00 | TZS 1000.00 | TZS 5000000.00 |
You should set account number as customer_id and send customer full name and bank BIC("Bank Identifier Code", ask your bank) in the payment request. Parameters **extra->customer_name** and **extra->bic**. Please see the example in the API Methods section.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| TZS 1000.00 | TZS 7500.00 | TZS 3000000.00 |
You should send a customer document type and document number in the payment requests. Parameters extra->customer_doc_type and extra->customer_doc_number. The customer_doc_type parameter can have one of the following values: * intl_passport - for International Passport * driving_license - for Driving License * national_id - for National ID
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| TZS 1000.00 | TZS 7500.00 | TZS 3000000.00 |
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| TZS 1000.00 | TZS 7500.00 (2000 TZS for 391-394) | TZS 3000000.00 |
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| TZS 100.00 | TZS 100.00 | TZS 3000000.00 |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 2357, 2358 | MOOV Money | |
| 2359, 2360 | TOGOCOM |
228000000000 - This is the format of the phone number you have to send in the payment requests.
ID 2357 For C2B and B2C payments you should send a customer full name in the payment requests. Parameters extra->customer_name. Please see the example in the API Methods section.
ID 2358 For C2B payments you should send a customer full name and customer email in the payment requests. Parameters extra->customer_name and extra->customer_email. Please see the example in the API Methods section. For B2C payments you should send a customer full name in the payment requests. Parameters extra->customer_name. Please see the example in the API Methods section.
ID 2359
For 2357
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| XOF 200.00 | XOF 500.00 | XOF 1000000.00 |
For 2358
| c2b minimum | b2c minimum | Maximum transaction limit | Maximum per day |
|---|---|---|---|
| XOF 5.00 | XOF 5.00 | XOF 1000000.00 | XOF 200k / 2m with KYC |
For 2359
| c2b minimum | b2c minimum | c2b maximum | b2c maximum | Maximum per day |
|---|---|---|---|---|
| XOF 100.00 | XOF 100.00 | XOF 1000000.00 | XOF 500000.00 | XOF 200k / 2m with KYC |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 2105, 808 | Airtel | |
| 2106, 809 | MTN |
256709000000 - This is the format of the phone number you have to send in the payment requests.
For C2B payments you should send a customer full name and customer email in the payment requests. Parameters extra->customer_name and extra->customer_email. Please see the example in the API Methods section.
You can get the link in the parameter extra->customer_redirect in the response of the status method. After receiving the link, you should redirect the customer to this page to confirm the transaction using OTP code.
For B2C payments you should send a customer full name in the payment requests. Parameter extra->customer_name. Please see the example in the API Methods section.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| UGX 500.00 | UGX 900.00 | UGX 4000000.00 |
C2B:
B2C:
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| UGX 500.00 | UGX 500.00 | UGX 5 000 000.00 |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 2118, 2332, 2370 | Airtel | |
| 2119, 2371 | MTN | |
| 2372 | Zamtel |
260000000000 - This is the format of the phone number you have to send in the payment requests.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| ZMW 1.00 | ZMW 1.00 | ZMW 20000.00 |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 701, 2391 | Airtel | |
| 700, 9125 | MTN | |
| 2390, 2392, 2393, 798 | Mpesa |
254000000000 - This is the format of the phone number you have to send in the payment requests.
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| KES 1.00 | KES 250.00 | KES 150000.00 |
| c2b minimum | b2c minimum | c2b maximum | b2c maximum |
|---|---|---|---|
| KES 10.00 | KES 10.00 | KES 250000.00 | KES 250000.00 |
| c2b Minimum | b2c Minimum | c2b Maximum | b2c Maximum |
|---|---|---|---|
| KES 10.00 | KES 10.00 | KES 10000.00 | KES 8500.00 |
| c2b Minimum | b2c Minimum | c2b Maximum | b2c Maximum |
|---|---|---|---|
| KES 10.00 | KES 80.00 | KES 250000.00 | KES 250000.00 |
| Provider ID | Provider Name | Notes |
|---|---|---|
| 705, 981 | Airtel | |
| 704, 980, 9127 | MTN | |
| 982 | Vodafone |
233000000000 - This is the format of the phone number you have to send in the payment requests.
| c2b Minimum | b2c Minimum | c2b Maximum | b2c Maximum |
|---|---|---|---|
| 10.00 | 10.00 | 1000.00 | 1000.00 |
For 980, 981, 982:
C2B
B2C
For 980:
| c2b minimum | b2c minimum | Maximum transaction limit |
|---|---|---|
| GHS 1.00 | GHS 1.00 | GHS 2000.00 |
For 981:
| c2b Minimum | b2c Minimum | c2b Maximum | b2c Maximum |
|---|---|---|---|
| GHS 100 | GHS 10 | no limit | GHS 25 000 |
For 982:
| c2b Minimum | b2c Minimum | c2b Maximum | b2c Maximum |
|---|---|---|---|
| GHS 100 | GHS 10 | GHS 25 000 | GHS 25 000 |
| public_id required | string Example: f54ec96649be11ebb3780242ac130002 Merchant public ID |
Parameters to initiate a customer to the merchant payment
| merchant_id required | string (merchantIdDef) Unique Merchant ID received during the merchant registration |
| customer_id required | string (customerIdDef) Customer ID (usually mobile phone number of the customer) |
| order_id required | string (orderIdDef) The unique value is generated by the transaction initiator for each Operation. Max length is 128 symbols. Allowed symbols: [a-z], [A-Z], [0-9], “_” (underscore character), “-” (hyphen), “:” (colon), “.” (dot). For example, GUID or TIMESTAMP can be used as an order_id. This parameter provides API idempotency. It means that requests with identical nonce from the same transaction initiator will have identical responses and The corresponding operation won’t be repeated. |
| amount required | string Amount to pay, should be in format with two digits after point |
| currency required | string (currencyDef) Currency code in ISO 4217 format from the list of availabe currencies |
| country | |
| callback_url | string URL to notify the merchant via callback. Recommended |
| provider_id required | |
| signature required | string (signatureDef) Merchant’s request and callback have to be signed to verify sent data. To generate the signature all sent parameters are included in the order they were sent. The parameter signature should be excluded, of course. Example can be found here |
{- "merchant_id": "e0fecd91fcb24f348048193b3fb34875ba3722b4",
- "customer_id": "0900000001",
- "order_id": "16280954971628095497",
- "amount": "100.00",
- "currency": "KES",
- "country": "KE",
- "provider_id": 14,
- "signature": "d7d6d76b0e22c6f9d369fa6c24f107053d12bfd24d3b154f2deb6676bf179c123134e1f20879c803be455d81cfe792f00cd8892c26ce7cf5a05beebb9c80843e"
}{- "order_id": "16280954971628095497",
- "transaction_id": "732007046722",
- "transaction_ref": "MP.33234.342.CP33",
- "status": 2,
- "result": {
- "code": 0,
- "message": "OK"
}, - "provider_result": {
- "code": 0,
- "message": "OK"
}, - "service_id": 1,
- "service_version": 11.1,
- "service_date_time": "2020-11-25 10:08:32.832969"
}{- "merchant_id": "e0fecd91fcb24f348048193b3fb34875ba3722b4",
- "operation_type": 17,
- "customer_id": "0900000001",
- "amount": 100,
- "order_id": "16280954971628095497",
- "transaction_id": "1234567",
- "transaction_ref": "QR555RQ",
- "status": 2,
- "provider_id": 14,
- "destination_id": "",
- "result": {
- "code": 0,
- "message": "OK"
}, - "signature": "d7d6d76b0e22c6f9d369fa6c24f107053d12bfd24d3b154f2deb6676bf179c123134e1f20879c803be455d81cfe792f00cd8892c26ce7cf5a05beebb9c80843e"
}Cashless payment from the merchant to the customer. If the confirm_type response parameter is a non-zero merchant, send the second payment_b2c request with confirmation data according to the section Confirmation Types.
| public_id required | string Example: f54ec96649be11ebb3780242ac130002 Merchant public ID |
Parameters to initiate the merchant to the customer payment
| merchant_id required | string (merchantIdDef) Unique Merchant ID received during the merchant registration |
| customer_id required | string (customerIdDef) Customer ID (usually mobile phone number of the customer) |
| order_id required | string (orderIdDef) The unique value is generated by the transaction initiator for each Operation. Max length is 128 symbols. Allowed symbols: [a-z], [A-Z], [0-9], “_” (underscore character), “-” (hyphen), “:” (colon), “.” (dot). For example, GUID or TIMESTAMP can be used as an order_id. This parameter provides API idempotency. It means that requests with identical nonce from the same transaction initiator will have identical responses and The corresponding operation won’t be repeated. |
| amount required | string Amount to pay, with two digits after point |
| currency required | string (currencyDef) Currency code in ISO 4217 format from the list of availabe currencies |
| country | |
| callback_url | string URL to notify the merchant via callback |
| provider_id required | |
| signature required | string (signatureDef) Merchant’s request and callback have to be signed to verify sent data. To generate the signature all sent parameters are included in the order they were sent. The parameter signature should be excluded, of course. Example can be found here |
{- "merchant_id": "e0fecd91fcb24f348048193b3fb34875ba3722b4",
- "customer_id": "0900000001",
- "order_id": "16280954971628095497",
- "amount": "100.00",
- "currency": "KES",
- "country": "KE",
- "provider_id": 14,
- "signature": "d7d6d76b0e22c6f9d369fa6c24f107053d12bfd24d3b154f2deb6676bf179c123134e1f20879c803be455d81cfe792f00cd8892c26ce7cf5a05beebb9c80843e"
}{- "order_id": "16280954971628095497",
- "transaction_id": "532007056722",
- "transaction_ref": "",
- "status": 2,
- "result": {
- "code": 0,
- "message": "OK"
}, - "provider_result": {
- "code": 0,
- "message": "OK"
}, - "service_id": 11,
- "service_version": 11.1,
- "service_date_time": "2020-11-25 10:08:32.832969",
- "confirm_type": 0
}| public_id required | string Example: f54ec96649be11ebb3780242ac130002 Merchant public ID |
Get the status of the performed transaction
| merchant_id required | string (merchantIdDef) Unique Merchant ID received during the merchant registration |
| order_id required | string (orderIdDef) The unique value is generated by the transaction initiator for each Operation. Max length is 128 symbols. Allowed symbols: [a-z], [A-Z], [0-9], “_” (underscore character), “-” (hyphen), “:” (colon), “.” (dot). For example, GUID or TIMESTAMP can be used as an order_id. This parameter provides API idempotency. It means that requests with identical nonce from the same transaction initiator will have identical responses and The corresponding operation won’t be repeated. |
| signature required | string (signatureDef) Merchant’s request and callback have to be signed to verify sent data. To generate the signature all sent parameters are included in the order they were sent. The parameter signature should be excluded, of course. Example can be found here |
{- "merchant_id": "e0fecd91fcb24f348048193b3fb34875ba3722b4",
- "order_id": "16280954971628095497",
- "signature": "d7d6d76b0e22c6f9d369fa6c24f107053d12bfd24d3b154f2deb6676bf179c123134e1f20879c803be455d81cfe792f00cd8892c26ce7cf5a05beebb9c80843e"
}{- "order_id": "16280954971628095497",
- "transaction_id": "732007046722",
- "transaction_ref": "MP.33234.342.CP33",
- "status": 2,
- "result": {
- "code": 0,
- "message": "OK"
}, - "provider_result": {
- "code": 0,
- "message": "OK"
}, - "service_id": 1,
- "service_version": 11.1,
- "service_date_time": "2020-11-25 10:08:32.832969"
}