v0.1

You can integrate Chimoney to your app and directly send a flexible gift or spicify if you want to send crypto, airtime, mobile money and other perks to your users.

🚨🚨🚨 See all endpoint and full API Docs on Postman.

🚨🚨🚨

post
Send Chimoney

https://chimoney.io/api/v0.1/send
Send Chimoney to one or more users from your app. The user decides how to spend the Chimoney. They can redeem any supported Crypto, Airtime/Mobile data, Gift card, Mobile money and other assets.
Request
Response
Request
Headers
X-API-Key
required
string
API key from the Developer portal
Body Parameters
chimoney
required
array
Array of `chimoney` to send. Receiver email OR twitter @username is required for each
description
optional
string
Description of the request
Response
200: OK
{ status: "success", data: {
paymentLink: "https://chimoney.io/pay?issueID=...",
}}
500: Internal Server Error
{ status: "error", error: "Error..."}

Chimoney object

The chimoney Array is a an array containing all the objects to send. Must have email OR twitter.

If email AND twitter are provided, email will be used.

[
{
valueInUSD: 1,
twitter: "",
},
{
valueInUSD: 1,
twitter: "@TWITTERUSERNAME",
},
]

Example requests

JavaScript - Fetch

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("X-API-Key", "API_KEY_FROM_DEV_PORTAL");
var raw = JSON.stringify({
description: "",
chimoney: [
{
valueInUSD: 1,
email: "email_to_send_to",
twitter: "",
},
{
valueInUSD: 1,
twitter: "twtter_username_to_send_to",
},
],
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://chimoney.io/api/v0.1/send", requestOptions)
.then(response => response.json())
.then(result => console.log(result))
.catch(error => console.log('error', error));

cURL

curl --location --request POST 'https://chimoney.io/api/v0.1/send' \
--header 'X-API-Key: API_KEY_FROM_DEV_PORTAL' \
--data-raw '{
"description": "",
"chimoney": [
{
"valueInUSD": 37,
"email": "email_to_send_to",
"twitter": ""
}
]
}'

PHP - cURL

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://chimoney.io/api/v0.1/send',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"description": "",
"chimoney": [
{
"valueInUSD": 37,
"email": "email_to_send_to",
"twitter": ""
}
]
}',
CURLOPT_HTTPHEADER => array(
'X-API-Key: API_KEY_FROM_DEV_PORTAL'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

More Languages

post
Payout Airtime in bulk

https://chimoney.io/api/v0.1/payouts/airtime
Sends airtime from Chimoney wallet to N number of users in multiple countries. Works best when you already know the phone number and country of the receiver.
Request
Response
Request
Path Parameters
airtimes
required
array
Array of `airtime` objects to send
Headers
X-API-Key
required
string
API Key from the Developer portal
Response
200: OK

Airtime object

The airtime object contains information about the airtime to send

{
"airtimes": [
{
"countryToSend": "Nigeria",
"phoneNumber": "+255700000000",
"valueInUSD": 1
},
{
"countryToSend": "Nigeria",
"phoneNumber": "+234700000000",
"valueInUSD": 1
}
]
}

Example Requests

Javascript - Fetch

var myHeaders = new Headers();
myHeaders.append("X-API-Key", "API_KEY_FROM_DEV_PORTAL");
var raw = "{\n \"description\": \"\",\n \"chimoney\": [\n {\n \"valueInUSD\": 37,\n \"email\": \"email_to_send_to\",\n \"twitter\": \"\"\n }\n ]\n}";
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://chimoney.io/api/v0.1/send", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));

cURL

curl --location --request POST 'https://chimoney.io/api/v0.1/send' \
--header 'X-API-Key: API_KEY_FROM_DEV_PORTAL' \
--data-raw '{
"description": "",
"chimoney": [
{
"valueInUSD": 37,
"email": "email_to_send_to",
"twitter": ""
}
]
}'

PHP - cURL

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://chimoney.io/api/v0.1/send',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"description": "",
"chimoney": [
{
"valueInUSD": 37,
"email": "email_to_send_to",
"twitter": ""
}
]
}',
CURLOPT_HTTPHEADER => array(
'X-API-Key: API_KEY_FROM_DEV_PORTAL'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

More Languages

post
Payout Mobile Money in bulk

https://chimoney.io/api/v0.1/payouts/mobile-money
Send mobile money to N number of users in multiple countries. Works best when you know the phone number, country and mobile network of the user. Use the /info/mobile-money-codes endpoint to get the momoCode
Request
Response
Request
Path Parameters
momos
required
array
An array of mobile money objects
Headers
X-API-KEY
required
string
API key from developer portal
Response
200: OK

Mobile Money (Momo) object

The momo object contains information about the mobile money to send. Get the momoCode from using the /info/mobile-money-codes endpoint.

{
countryToSend: "Ghana",
phoneNumber: "+23300000000",
valueInUSD: 20,
reference: "",
momoCode: "MTN",
}

Example Requests

Javascript - Fetch

var myHeaders = new Headers();
myHeaders.append("X-API-KEY", "API_KEY_FROM_DEV_PORTAL");
var raw = "{\n \"momos\": [\n {\n \"countryToSend\": \"Ghana\",\n \"phoneNumber\": \"+23300000000\",\n \"valueInUSD\": 1,\n \"reference\": \"\",\n \"momoCode\": \"MTN\"\n }\n ]\n}";
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://chimoney.io/api/v0.1/payouts/mobile-money", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));

cURL

curl --location --request POST 'https://chimoney.io/api/v0.1/payouts/mobile-money' \
--header 'X-API-KEY: API_KEY_FROM_DEV_PORTAL' \
--data-raw '{
"momos": [
{
"countryToSend": "Ghana",
"phoneNumber": "+23300000000",
"valueInUSD": 1,
"reference": "",
"momoCode": "MTN"
}
]
}'

PHP - cURL

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://chimoney.io/api/v0.1/payouts/mobile-money',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"momos": [
{
"countryToSend": "Ghana",
"phoneNumber": "+23300000000",
"valueInUSD": 1,
"reference": "",
"momoCode": "MTN"
}
]
}',
CURLOPT_HTTPHEADER => array(
'X-API-KEY: API_KEY_FROM_DEV_PORTAL'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

More Languages