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
https://chimoney.io/api/v0.1/send
Send Chimoney

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.
1
[
2
{
3
valueInUSD: 1,
4
5
twitter: "",
6
},
7
{
8
valueInUSD: 1,
9
twitter: "@TWITTERUSERNAME",
10
},
11
]
Copied!

Example requests

JavaScript - Fetch

1
var myHeaders = new Headers();
2
myHeaders.append("Content-Type", "application/json");
3
myHeaders.append("X-API-Key", "API_KEY_FROM_DEV_PORTAL");
4
​
5
var raw = JSON.stringify({
6
description: "",
7
chimoney: [
8
{
9
valueInUSD: 1,
10
email: "email_to_send_to",
11
twitter: "",
12
},
13
{
14
valueInUSD: 1,
15
twitter: "twtter_username_to_send_to",
16
},
17
],
18
});
19
​
20
var requestOptions = {
21
method: 'POST',
22
headers: myHeaders,
23
body: raw,
24
redirect: 'follow'
25
};
26
​
27
fetch("https://chimoney.io/api/v0.1/send", requestOptions)
28
.then(response => response.json())
29
.then(result => console.log(result))
30
.catch(error => console.log('error', error));
Copied!

cURL

1
curl --location --request POST 'https://chimoney.io/api/v0.1/send' \
2
--header 'X-API-Key: API_KEY_FROM_DEV_PORTAL' \
3
--data-raw '{
4
"description": "",
5
"chimoney": [
6
{
7
"valueInUSD": 37,
8
"email": "email_to_send_to",
9
"twitter": ""
10
}
11
]
12
}'
Copied!

PHP - cURL

1
<?php
2
​
3
$curl = curl_init();
4
​
5
curl_setopt_array($curl, array(
6
CURLOPT_URL => 'https://chimoney.io/api/v0.1/send',
7
CURLOPT_RETURNTRANSFER => true,
8
CURLOPT_ENCODING => '',
9
CURLOPT_MAXREDIRS => 10,
10
CURLOPT_TIMEOUT => 0,
11
CURLOPT_FOLLOWLOCATION => true,
12
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13
CURLOPT_CUSTOMREQUEST => 'POST',
14
CURLOPT_POSTFIELDS =>'{
15
"description": "",
16
"chimoney": [
17
{
18
"valueInUSD": 37,
19
"email": "email_to_send_to",
20
"twitter": ""
21
}
22
]
23
}',
24
CURLOPT_HTTPHEADER => array(
25
'X-API-Key: API_KEY_FROM_DEV_PORTAL'
26
),
27
));
28
​
29
$response = curl_exec($curl);
30
​
31
curl_close($curl);
32
echo $response;
33
​
Copied!

More Languages

Chimoney API V0.1
Chimoney API V0.1
​
post
https://chimoney.io/api/v0.1/payouts/airtime
Payout Airtime in bulk

Airtime object

The airtime object contains information about the airtime to send
1
{
2
"airtimes": [
3
{
4
"countryToSend": "Nigeria",
5
"phoneNumber": "+255700000000",
6
"valueInUSD": 1
7
},
8
{
9
"countryToSend": "Nigeria",
10
"phoneNumber": "+234700000000",
11
"valueInUSD": 1
12
}
13
]
14
}
Copied!

Example Requests

Javascript - Fetch

1
var myHeaders = new Headers();
2
myHeaders.append("X-API-Key", "API_KEY_FROM_DEV_PORTAL");
3
​
4
var raw = "{\n \"description\": \"\",\n \"chimoney\": [\n {\n \"valueInUSD\": 37,\n \"email\": \"email_to_send_to\",\n \"twitter\": \"\"\n }\n ]\n}";
5
​
6
var requestOptions = {
7
method: 'POST',
8
headers: myHeaders,
9
body: raw,
10
redirect: 'follow'
11
};
12
​
13
fetch("https://chimoney.io/api/v0.1/send", requestOptions)
14
.then(response => response.text())
15
.then(result => console.log(result))
16
.catch(error => console.log('error', error));
Copied!

cURL

1
curl --location --request POST 'https://chimoney.io/api/v0.1/send' \
2
--header 'X-API-Key: API_KEY_FROM_DEV_PORTAL' \
3
--data-raw '{
4
"description": "",
5
"chimoney": [
6
{
7
"valueInUSD": 37,
8
"email": "email_to_send_to",
9
"twitter": ""
10
}
11
]
12
}'
Copied!

PHP - cURL

1
<?php
2
​
3
$curl = curl_init();
4
​
5
curl_setopt_array($curl, array(
6
CURLOPT_URL => 'https://chimoney.io/api/v0.1/send',
7
CURLOPT_RETURNTRANSFER => true,
8
CURLOPT_ENCODING => '',
9
CURLOPT_MAXREDIRS => 10,
10
CURLOPT_TIMEOUT => 0,
11
CURLOPT_FOLLOWLOCATION => true,
12
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13
CURLOPT_CUSTOMREQUEST => 'POST',
14
CURLOPT_POSTFIELDS =>'{
15
"description": "",
16
"chimoney": [
17
{
18
"valueInUSD": 37,
19
"email": "email_to_send_to",
20
"twitter": ""
21
}
22
]
23
}',
24
CURLOPT_HTTPHEADER => array(
25
'X-API-Key: API_KEY_FROM_DEV_PORTAL'
26
),
27
));
28
​
29
$response = curl_exec($curl);
30
​
31
curl_close($curl);
32
echo $response;
33
​
Copied!

More Languages

Chimoney API V0.1
Chimoney API V0.1
​
post
https://chimoney.io/api/v0.1/payouts/mobile-money
Payout Mobile Money in bulk

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.
1
{
2
countryToSend: "Ghana",
3
phoneNumber: "+23300000000",
4
valueInUSD: 20,
5
reference: "",
6
momoCode: "MTN",
7
}
Copied!

Example Requests

Javascript - Fetch
1
var myHeaders = new Headers();
2
myHeaders.append("X-API-KEY", "API_KEY_FROM_DEV_PORTAL");
3
​
4
var raw = "{\n \"momos\": [\n {\n \"countryToSend\": \"Ghana\",\n \"phoneNumber\": \"+23300000000\",\n \"valueInUSD\": 1,\n \"reference\": \"\",\n \"momoCode\": \"MTN\"\n }\n ]\n}";
5
​
6
var requestOptions = {
7
method: 'POST',
8
headers: myHeaders,
9
body: raw,
10
redirect: 'follow'
11
};
12
​
13
fetch("https://chimoney.io/api/v0.1/payouts/mobile-money", requestOptions)
14
.then(response => response.text())
15
.then(result => console.log(result))
16
.catch(error => console.log('error', error));
Copied!
cURL
1
curl --location --request POST 'https://chimoney.io/api/v0.1/payouts/mobile-money' \
2
--header 'X-API-KEY: API_KEY_FROM_DEV_PORTAL' \
3
--data-raw '{
4
"momos": [
5
{
6
"countryToSend": "Ghana",
7
"phoneNumber": "+23300000000",
8
"valueInUSD": 1,
9
"reference": "",
10
"momoCode": "MTN"
11
}
12
]
13
}'
Copied!
PHP - cURL
1
<?php
2
​
3
$curl = curl_init();
4
​
5
curl_setopt_array($curl, array(
6
CURLOPT_URL => 'https://chimoney.io/api/v0.1/payouts/mobile-money',
7
CURLOPT_RETURNTRANSFER => true,
8
CURLOPT_ENCODING => '',
9
CURLOPT_MAXREDIRS => 10,
10
CURLOPT_TIMEOUT => 0,
11
CURLOPT_FOLLOWLOCATION => true,
12
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13
CURLOPT_CUSTOMREQUEST => 'POST',
14
CURLOPT_POSTFIELDS =>'{
15
"momos": [
16
{
17
"countryToSend": "Ghana",
18
"phoneNumber": "+23300000000",
19
"valueInUSD": 1,
20
"reference": "",
21
"momoCode": "MTN"
22
}
23
]
24
}',
25
CURLOPT_HTTPHEADER => array(
26
'X-API-KEY: API_KEY_FROM_DEV_PORTAL'
27
),
28
));
29
​
30
$response = curl_exec($curl);
31
​
32
curl_close($curl);
33
echo $response;
34
​
Copied!
More Languages
Chimoney API V0.1
Chimoney API V0.1
​
Last modified 7mo ago