Request a payment (beta)
curl --request POST \
--url https://api.kemypay.com/v1/mobile-money/collections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"service": "019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47",
"amount": "1000",
"currency": "XAF",
"phone_number": "237670000000",
"reference": "order-2026-10-29-0001",
"country": "CMR",
"operator": "MTN_CMR",
"description": "Afroyamo Premium",
"metadata": {
"user_id": "42"
},
"webhook_url": "<string>",
"callback_url": "<string>"
}
'import requests
url = "https://api.kemypay.com/v1/mobile-money/collections"
payload = {
"service": "019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47",
"amount": "1000",
"currency": "XAF",
"phone_number": "237670000000",
"reference": "order-2026-10-29-0001",
"country": "CMR",
"operator": "MTN_CMR",
"description": "Afroyamo Premium",
"metadata": { "user_id": "42" },
"webhook_url": "<string>",
"callback_url": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
service: '019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47',
amount: '1000',
currency: 'XAF',
phone_number: '237670000000',
reference: 'order-2026-10-29-0001',
country: 'CMR',
operator: 'MTN_CMR',
description: 'Afroyamo Premium',
metadata: {user_id: '42'},
webhook_url: '<string>',
callback_url: '<string>'
})
};
fetch('https://api.kemypay.com/v1/mobile-money/collections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kemypay.com/v1/mobile-money/collections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'service' => '019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47',
'amount' => '1000',
'currency' => 'XAF',
'phone_number' => '237670000000',
'reference' => 'order-2026-10-29-0001',
'country' => 'CMR',
'operator' => 'MTN_CMR',
'description' => 'Afroyamo Premium',
'metadata' => [
'user_id' => '42'
],
'webhook_url' => '<string>',
'callback_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kemypay.com/v1/mobile-money/collections"
payload := strings.NewReader("{\n \"service\": \"019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47\",\n \"amount\": \"1000\",\n \"currency\": \"XAF\",\n \"phone_number\": \"237670000000\",\n \"reference\": \"order-2026-10-29-0001\",\n \"country\": \"CMR\",\n \"operator\": \"MTN_CMR\",\n \"description\": \"Afroyamo Premium\",\n \"metadata\": {\n \"user_id\": \"42\"\n },\n \"webhook_url\": \"<string>\",\n \"callback_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kemypay.com/v1/mobile-money/collections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"service\": \"019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47\",\n \"amount\": \"1000\",\n \"currency\": \"XAF\",\n \"phone_number\": \"237670000000\",\n \"reference\": \"order-2026-10-29-0001\",\n \"country\": \"CMR\",\n \"operator\": \"MTN_CMR\",\n \"description\": \"Afroyamo Premium\",\n \"metadata\": {\n \"user_id\": \"42\"\n },\n \"webhook_url\": \"<string>\",\n \"callback_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kemypay.com/v1/mobile-money/collections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"service\": \"019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47\",\n \"amount\": \"1000\",\n \"currency\": \"XAF\",\n \"phone_number\": \"237670000000\",\n \"reference\": \"order-2026-10-29-0001\",\n \"country\": \"CMR\",\n \"operator\": \"MTN_CMR\",\n \"description\": \"Afroyamo Premium\",\n \"metadata\": {\n \"user_id\": \"42\"\n },\n \"webhook_url\": \"<string>\",\n \"callback_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"code": "019a9c41-7e2d-4b8f-a1c3-5d6e7f8a9b0c",
"reference": "order-2026-10-29-0001",
"service_code": "019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47",
"status": "processing",
"country": "CMR",
"operator": "MTN_CMR",
"phone_number": "237670000000",
"currency": "XAF",
"value": "1000.00",
"amount": "1033.00",
"fee": "33.00",
"fee_bearer": "customer",
"net_amount": "1000.00",
"description": "Afroyamo Premium",
"metadata": {
"user_id": "42"
},
"failure_code": null,
"failure_message": null,
"operator_transaction_id": null,
"callback_url": "https://afroyamo.com/payment/done",
"created_at": "2026-10-29T10:00:00+00:00",
"completed_at": null
},
"meta": {
"request_id": "a4f8e2c1b3d97056",
"timestamp": "2026-10-29T10:00:00+00:00",
"mode": "live"
}
}{
"success": true,
"data": {
"code": "019a9c41-7e2d-4b8f-a1c3-5d6e7f8a9b0c",
"reference": "order-2026-10-29-0001",
"service_code": "019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47",
"status": "processing",
"country": "CMR",
"operator": "MTN_CMR",
"phone_number": "237670000000",
"currency": "XAF",
"value": "1000.00",
"amount": "1033.00",
"fee": "33.00",
"fee_bearer": "customer",
"net_amount": "1000.00",
"description": "Afroyamo Premium",
"metadata": {
"user_id": "42"
},
"failure_code": null,
"failure_message": null,
"operator_transaction_id": null,
"callback_url": "https://afroyamo.com/payment/done",
"created_at": "2026-10-29T10:00:00+00:00",
"completed_at": null
},
"meta": {
"request_id": "a4f8e2c1b3d97056",
"timestamp": "2026-10-29T10:00:00+00:00",
"mode": "live"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "The service is pending_review: it cannot collect payments in live mode.",
"details": {
"service_status": "pending_review"
}
},
"meta": {
"request_id": "a4f8e2c1b3d97056",
"timestamp": "2026-10-29T10:00:00+00:00",
"mode": "live"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Some fields of the payment are missing or invalid.",
"details": {
"phone_number": "Required: the mobile money number with the country code, digits only, for example 237670000000."
}
},
"meta": {
"request_id": "a4f8e2c1b3d97056",
"timestamp": "2026-10-29T10:00:00+00:00",
"mode": "live"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Some fields of the payment are missing or invalid.",
"details": {
"phone_number": "Required: the mobile money number with the country code, digits only, for example 237670000000."
}
},
"meta": {
"request_id": "a4f8e2c1b3d97056",
"timestamp": "2026-10-29T10:00:00+00:00",
"mode": "live"
}
}{
"success": false,
"error": {
"code": "OPERATION_FAILED",
"message": "ORANGE_CMR is temporarily unavailable for collections. Offer another operator or try again later.",
"details": {
"failure_code": "operator_unavailable"
}
},
"meta": {
"request_id": "a4f8e2c1b3d97056",
"timestamp": "2026-10-29T10:00:00+00:00",
"mode": "live"
}
}Collections
Request a payment (beta)
Asks your customer to pay from their mobile money account: they receive a prompt on their phone and confirm
with their PIN. The result arrives by webhook (mobile_money.collection.completed or .failed).
referenceis your unique reference. Sending the same request again returns the same payment with200: your customer is never charged twice. The same reference with another service, amount or phone number is refused.webhook_urlandcallback_urlsent here take priority over those of the service.- Returns
201with statusprocessing(orpendingif the operator did not answer yet: we check it for you). - In test mode the result is immediate (see Test mode).
POST
/
mobile-money
/
collections
Request a payment (beta)
curl --request POST \
--url https://api.kemypay.com/v1/mobile-money/collections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"service": "019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47",
"amount": "1000",
"currency": "XAF",
"phone_number": "237670000000",
"reference": "order-2026-10-29-0001",
"country": "CMR",
"operator": "MTN_CMR",
"description": "Afroyamo Premium",
"metadata": {
"user_id": "42"
},
"webhook_url": "<string>",
"callback_url": "<string>"
}
'import requests
url = "https://api.kemypay.com/v1/mobile-money/collections"
payload = {
"service": "019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47",
"amount": "1000",
"currency": "XAF",
"phone_number": "237670000000",
"reference": "order-2026-10-29-0001",
"country": "CMR",
"operator": "MTN_CMR",
"description": "Afroyamo Premium",
"metadata": { "user_id": "42" },
"webhook_url": "<string>",
"callback_url": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
service: '019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47',
amount: '1000',
currency: 'XAF',
phone_number: '237670000000',
reference: 'order-2026-10-29-0001',
country: 'CMR',
operator: 'MTN_CMR',
description: 'Afroyamo Premium',
metadata: {user_id: '42'},
webhook_url: '<string>',
callback_url: '<string>'
})
};
fetch('https://api.kemypay.com/v1/mobile-money/collections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kemypay.com/v1/mobile-money/collections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'service' => '019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47',
'amount' => '1000',
'currency' => 'XAF',
'phone_number' => '237670000000',
'reference' => 'order-2026-10-29-0001',
'country' => 'CMR',
'operator' => 'MTN_CMR',
'description' => 'Afroyamo Premium',
'metadata' => [
'user_id' => '42'
],
'webhook_url' => '<string>',
'callback_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kemypay.com/v1/mobile-money/collections"
payload := strings.NewReader("{\n \"service\": \"019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47\",\n \"amount\": \"1000\",\n \"currency\": \"XAF\",\n \"phone_number\": \"237670000000\",\n \"reference\": \"order-2026-10-29-0001\",\n \"country\": \"CMR\",\n \"operator\": \"MTN_CMR\",\n \"description\": \"Afroyamo Premium\",\n \"metadata\": {\n \"user_id\": \"42\"\n },\n \"webhook_url\": \"<string>\",\n \"callback_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kemypay.com/v1/mobile-money/collections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"service\": \"019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47\",\n \"amount\": \"1000\",\n \"currency\": \"XAF\",\n \"phone_number\": \"237670000000\",\n \"reference\": \"order-2026-10-29-0001\",\n \"country\": \"CMR\",\n \"operator\": \"MTN_CMR\",\n \"description\": \"Afroyamo Premium\",\n \"metadata\": {\n \"user_id\": \"42\"\n },\n \"webhook_url\": \"<string>\",\n \"callback_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kemypay.com/v1/mobile-money/collections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"service\": \"019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47\",\n \"amount\": \"1000\",\n \"currency\": \"XAF\",\n \"phone_number\": \"237670000000\",\n \"reference\": \"order-2026-10-29-0001\",\n \"country\": \"CMR\",\n \"operator\": \"MTN_CMR\",\n \"description\": \"Afroyamo Premium\",\n \"metadata\": {\n \"user_id\": \"42\"\n },\n \"webhook_url\": \"<string>\",\n \"callback_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"code": "019a9c41-7e2d-4b8f-a1c3-5d6e7f8a9b0c",
"reference": "order-2026-10-29-0001",
"service_code": "019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47",
"status": "processing",
"country": "CMR",
"operator": "MTN_CMR",
"phone_number": "237670000000",
"currency": "XAF",
"value": "1000.00",
"amount": "1033.00",
"fee": "33.00",
"fee_bearer": "customer",
"net_amount": "1000.00",
"description": "Afroyamo Premium",
"metadata": {
"user_id": "42"
},
"failure_code": null,
"failure_message": null,
"operator_transaction_id": null,
"callback_url": "https://afroyamo.com/payment/done",
"created_at": "2026-10-29T10:00:00+00:00",
"completed_at": null
},
"meta": {
"request_id": "a4f8e2c1b3d97056",
"timestamp": "2026-10-29T10:00:00+00:00",
"mode": "live"
}
}{
"success": true,
"data": {
"code": "019a9c41-7e2d-4b8f-a1c3-5d6e7f8a9b0c",
"reference": "order-2026-10-29-0001",
"service_code": "019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47",
"status": "processing",
"country": "CMR",
"operator": "MTN_CMR",
"phone_number": "237670000000",
"currency": "XAF",
"value": "1000.00",
"amount": "1033.00",
"fee": "33.00",
"fee_bearer": "customer",
"net_amount": "1000.00",
"description": "Afroyamo Premium",
"metadata": {
"user_id": "42"
},
"failure_code": null,
"failure_message": null,
"operator_transaction_id": null,
"callback_url": "https://afroyamo.com/payment/done",
"created_at": "2026-10-29T10:00:00+00:00",
"completed_at": null
},
"meta": {
"request_id": "a4f8e2c1b3d97056",
"timestamp": "2026-10-29T10:00:00+00:00",
"mode": "live"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "The service is pending_review: it cannot collect payments in live mode.",
"details": {
"service_status": "pending_review"
}
},
"meta": {
"request_id": "a4f8e2c1b3d97056",
"timestamp": "2026-10-29T10:00:00+00:00",
"mode": "live"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Some fields of the payment are missing or invalid.",
"details": {
"phone_number": "Required: the mobile money number with the country code, digits only, for example 237670000000."
}
},
"meta": {
"request_id": "a4f8e2c1b3d97056",
"timestamp": "2026-10-29T10:00:00+00:00",
"mode": "live"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Some fields of the payment are missing or invalid.",
"details": {
"phone_number": "Required: the mobile money number with the country code, digits only, for example 237670000000."
}
},
"meta": {
"request_id": "a4f8e2c1b3d97056",
"timestamp": "2026-10-29T10:00:00+00:00",
"mode": "live"
}
}{
"success": false,
"error": {
"code": "OPERATION_FAILED",
"message": "ORANGE_CMR is temporarily unavailable for collections. Offer another operator or try again later.",
"details": {
"failure_code": "operator_unavailable"
}
},
"meta": {
"request_id": "a4f8e2c1b3d97056",
"timestamp": "2026-10-29T10:00:00+00:00",
"mode": "live"
}
}Authorizations
Your secret API key: sk_live_… (real money) or sk_test_… (test mode).
Body
application/json
The code of the service that collects.
Example:
"019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47"
The value of the goods, as a string. Respect the decimals of the operator.
Example:
"1000"
Example:
"XAF"
Mobile money number with the country code. Spaces, dashes and + are removed.
Example:
"237670000000"
Your own unique reference (1 to 100 letters, digits, . _ : -). Makes the call safe to retry.
Example:
"order-2026-10-29-0001"
Optional check. Refused if the operator is in another country.
Example:
"CMR"
Operator code (MTN_CMR). Optional — guessed from the phone number when missing.
Example:
"MTN_CMR"
Default: the setting of the service.
Available options:
merchant, customer Shown to your customer on the payment prompt. 4 to 22 letters, digits or spaces.
Example:
"Afroyamo Premium"
Up to 10 keys with text values. Returned in the webhooks.
Show child attributes
Show child attributes
Example:
{ "user_id": "42" }
https. Takes priority over the webhook_url of the service for this payment.
Takes priority over the callback_url of the service for this payment.