Mobile Money REST API, and Nodejs Library documentation
Chipdeals-momo-api is a Mobile Money API that allows you to build a quick, simple and excellent payment experience in your web and native app. This is the official Documentation for http requests
You can request payment and send money to any mobile money account
No requirement
You can use any tools that allows you to perform http requests. Like VSCode REST Client extention
I will be using curl, so I hope you have your terminal opened.
Make your first request with your API Key (Get apikey here)
curl --request POST 'https://apis.chipdeals.me/momo/requestpayment?apikey=test_FOdigzgSopV8GZggZa89' \
--header 'Content-Type: application/json' \
--data-raw '{
"senderFirstName": "Willi Gate",
"senderLastName": "EVERICH",
"senderPhoneNumber": "22951945229",
"amount": 10,
"currency": "XOF"
}'curl --request POST 'https://apis.chipdeals.me/momo/deposit?apikey=test_FOdigzgSopV8GZggZa89' \
--header 'Content-Type: application/json' \
--data-raw '{
"recipientPhoneNumber": "22952038945",
"amount": 10,
"currency": "XOF"
}'Quick check possible responses with sandbox tests
You need to specify an apikey in any call made to our API.
You specify you apikey with the query parametter apikey like in the folowing sample
curl 'https://chipdealsApiUrl?apikey=YOUR_API_KEY_HERE'For example to request 2000 XOF from the +22951010591 Mobile Money wallet, the following code can be used
curl --request POST 'https://apis.chipdeals.me/momo/requestpayment?apikey=test_FOdigzgSopV8GZggZa89' \
--header 'Content-Type: application/json' \
--data-raw '{
"senderFirstName": "Jean",
"senderLastName": "EVERICH",
"senderPhoneNumber": "22951945229",
"amount": 2000,
"currency": "XOF"
}'Here are collection model of response you will get after collection request
Collect with a webhook to get response as soon as the payment is processed.
curl --request POST 'https://apis.chipdeals.me/momo/requestpayment?apikey=test_FOdigzgSopV8GZggZa89' \
--header 'Content-Type: application/json' \
--data-raw '{
"senderFirstName": "Jean",
"senderLastName": "EVERICH",
"senderPhoneNumber": "22951945229",
"amount": 2000,
"currency": "XOF",
"webhookUrl": "https://mydomain/collection-status"
}'You can also send 2000 XOF to the +22951010591 Mobile Money wallet, with the following code
curl --request POST 'https://apis.chipdeals.me/momo/deposit?apikey=test_FOdigzgSopV8GZggZa89' \
--header 'Content-Type: application/json' \
--data-raw '{
"recipientPhoneNumber": "22952038945",
"amount": 2000,
"currency": "XOF"
}'Here are disbursement model of response you will get after disbursement request
Disburse with a webhook to get response as soon as the deposit is processed.
curl --request POST 'https://apis.chipdeals.me/momo/deposit?apikey=test_FOdigzgSopV8GZggZa89' \
--header 'Content-Type: application/json' \
--data-raw '{
"recipientPhoneNumber": "22952038945",
"amount": 2000,
"currency": "XOF",
"webhookUrl": "https://mydomain/collection-status"
}'Get status of a transaction with reference dd1e2d17-5c21-4964-b58d-198fd2aac150
curl --request GET 'https://apis.chipdeals.me/momo/status/39022f7a-abd1-468f-a682-a6e2024d65b0?apikey=test_FOdigzgSopV8GZggZa89'Get your Chipdeals account's balance
curl --request GET 'https://apis.chipdeals.me/momo/balance?apikey=test_FOdigzgSopV8GZggZa89'
Balance sample:
{
"success": true,
"message": "",
"balance": [
{
"amount": 2000,
"currency": "XOF"
},
{
"amount": 1045,
"currency": "XAF"
},
]
} {
"success": true, //REQUIRED. Status of the request processing. If true, that means there is no probleme for the request
"message": "", //REQUIRED. Processing message. If there is no text that means that there where no probleme for the request. If it contain a text, it specify the state of the request.
"errorCode": "code" //OPTIONAL. This parametter is added only when there is an error in the request. Is is so added only when success parameter contain false. It contain a specific code relative to the error that occured.
// Other parametters specific to the request
}Collection
{
"success": true, //status of the request processing
"message": "", //message of the request processing
"payment": {
"reference": "b8f9aeb4-ca07-4438-b9ce-aa975a39d15d", //reference of the transaction in our system
"senderPhoneNumber": "22951945229", //Phone number of the money sender
"senderCountryCode": "BJ", //Country code of the money sender
"senderOperator": "MTN", //Operator of the money sender
"senderFirstName": "Jean", //Firstname of the money sender
"senderLastName": "EVERICH", //Lastname of the money sender
"originalCurrency": "XOF", //Currency of payment you specified in your request
"currency": "XOF", //Local currency of the sender phone number
"status": "pending", //Status of the transaction (pending || success || error)
"statusMessage": "pending", //Message explaining what is exactly hapennig for the transaction
"statusMessageCode": 202, //Specific code of the exact state of the transaction
"startTimestampInSecond": 1655968250, //Timestamp in second of the moment when you initiated the transaction
"endTimestampInSecond": 0, //Timestamp in second of the moment when a tranaction is finished
"amount": 10, //Amount in local currency that the sender will pay
"originalAmount": 10 //Amount you specified the user should pay in your request
}
}Disbursement
{
"success": true, //status of the request processing
"message": "", //message of the request processing
"deposit": {
"reference": 9d621c8f-5a8e-4f88-ad24-984fb47a8ce8//reference of the transaction in our system
"recipientPhoneNumber": "22951945229", //Phone number of the money recipient
"recipientOperator": "MTN", //Operator of the money recipient
"recipientCountryCode": "BJ", //Country code of the money recipient
"originalCurrency": "XOF", //Currency of deposit you specified in your request
"currency": "XOF", //Local currency of the sender phone number
"status": "pending", //Status of the transaction (pending || success || error)
"statusMessage": "pending", //Message explaining what is exactly hapennig for the transaction
"statusMessageCode": 202, //Specific code of the exact state of the transaction
"startTimestampInSecond": 1655968725, //Timestamp in second of the moment when you initiated the transaction
"endTimestampInSecond": 0, //Timestamp in second of the moment when a tranaction is finished
"amount": 2000, //Amount in local currency that the recipient will receive
"originalAmount": 200 //Amount you specified the user should receive in your request
}
}Status of collection
{
"success": true, //status of the request processing
"message": "", //message of the request processing
"transaction": {
"reference": "b8f9aeb4-ca07-4438-b9ce-aa975a39d15d", //reference of the transaction in our system
"senderPhoneNumber": "22951945229", //Phone number of the money sender
"senderCountryCode": "BJ", //Country code of the money sender
"senderOperator": "MTN", //Operator of the money sender
"senderFirstName": "Jean", //Firstname of the money sender
"senderLastName": "EVERICH", //Lastname of the money sender
"originalCurrency": "XOF", //Currency of payment you specified in your request
"currency": "XOF", //Local currency of the sender phone number
"status": "success", //Message explaining what is exactly hapennig for the transaction
"statusMessage": "Successfully processed transaction",
"statusMessageCode": 200, //Specific code of the exact state of the transaction
"startTimestampInSecond": 1655968250, //Timestamp in second of the moment when you initiated the transaction
"endTimestampInSecond": 1655968350, //Timestamp in second of the moment when a tranaction is finished
"amount": 10, //Amount in local currency that the sender will pay
"originalAmount": 10 //Amount you specified the user should pay in your request
"transactionType": "payment" //type of the transaction (payment || deposit)
}
}Status of disbursement
{
"success": true, //status of the request processing
"message": "", //message of the request processing
"transaction": {
"reference": 9d621c8f-5a8e-4f88-ad24-984fb47a8ce8//reference of the transaction in our system
"recipientPhoneNumber": "22951945229", //Phone number of the money recipient
"recipientOperator": "MTN", //Operator of the money recipient
"recipientCountryCode": "BJ", //Country code of the money recipient
"originalCurrency": "XOF", //Currency of deposit you specified in your request
"currency": "XOF", //Local currency of the sender phone number
"status": "success", //Message explaining what is exactly hapennig for the transaction
"statusMessage": "Successfully processed transaction",
"statusMessageCode": 200, //Specific code of the exact state of the transaction
"startTimestampInSecond": 1655968725, //Timestamp in second of the moment when you initiated the transaction
"endTimestampInSecond": 1655968825, //Timestamp in second of the moment when a tranaction is finished
"amount": 2000, //Amount in local currency that the recipient will receive
"originalAmount": 200 //Amount you specified the user should receive in your request
"transactionType": "deposit" //type of the transaction (payment || deposit)
}
}balance
{
"success": true, //status of the request processing
"message": "", //message of the request processing
"balances": [ //array of all balances by currency
{
"amount": 0, //amount
"currency": "XOF" //balance
}
]
}These are the possible values of the property errorCode
| Code | message |
|---|---|
| 400-000 | Endpoint not available |
| 400-100 | Parameter senderFirstName not found in the request |
| 400-101 | Parameter senderFirstName contain invalid data |
| 400-102 | Parameter senderLastName not found in the request |
| 400-103 | Parameter senderLastName contain invalid data |
| 400-104 | Parameter senderPhoneNumber not found in the request |
| 400-105 | Parameter senderPhoneNumber contain invalid data |
| 400-106 | Parameter amount not found in the request |
| 400-107 | Parameter amount contain invalid data |
| 400-110 | Parameter recipientPhoneNumber not found in the request |
| 400-111 | Parameter recipientPhoneNumber contain invalid data |
| 400-112 | Parameter senderPhoneNumber sent have bad operator |
| 400-113 | Parameter senderPhoneNumber sent have bad operator |
| 400-114 | Parameter senderPhoneNumber contains invalid data |
| 400-115 | Parameter senderPhoneNumber contains invalid data |
| 400-116 | Currency you enter in the request is not supported |
| 400-117 | Parameter currency not found in the request |
| 400-118 | Parameter currency contains invalid data |
| 401-100 | Incorrect api key in the request |
| 404-100 | No transaction found with the reference in the request |
| 403-100 | Not enough money in your balance for a deposit |
| 500-000 | Sorry an error occured on the server. try again. |
| 500-001 | Sorry an error occured when converting currencies. try again. |
Webhooks are an important part of your payment integration. They allow us to notify you about events that happen on your account, such as a successful payment or a failed transaction.
A webhook URL is an endpoint on your server where you can receive notifications about such events. When an event occurs, we'll make a POST request to that endpoint, with a JSON body containing the details about the event, including the type of event and the data associated with it.
All webhook payloads follow the same basic structure:
- an
eventfield describing the type of event - a
dataobject. The contents of this object will vary depending on the event, but typically it will contain details of the event, including:- a
referencecontaining the ID of the transaction - a
statusdescribing the status of the transaction. possible values aresuccess,pendingorerror - a
statusMessageCode, containing a specific code that identify an exact state of the transaction. See allstatusMessageCode - a
statusMessage, cantaining an human undertandable descrption of the exact state of the transaction - transaction details
- a
Here are some sample webhook payloads for transfers and payments
Creating a webhook endpoint on your server is the same as writing any other API endpoint, but there are a few important details to note:
Verifying webhook signatures When enabling webhooks, you have the option to set a secret hash. Since webhook URLs are publicly accessible, the secret hash allows you to verify that incoming requests are from Chipdeals. You can specify any value as your secret hash, but we recommend something random. We also recommend to store it as an environment variable on your server.
If you specify a secret hash, we'll include it in our request to your webhook URL, in a header called verif-hash. In the webhook endpoint, check if the verif-hash header is present and that it matches the secret hash you set. If the header is missing, or the value doesn't match, you can discard the request, as it isn't from Chipdeals.
Responding to webhook requests
To acknowledge receipt of a webhook, your endpoint must return a 200 HTTP status code. Any other response codes, including 3xx codes, will be treated as a failure. We don't care about the response body or headers.
Be sure to enable webhook retries on your dashboard. If we don't get a 200 status code (for example, if your server is unreachable), we'll retry the webhook call every 90 minutes for the next 36 hours.
{
"event": "collection.stateChanged",
"data": {
"reference": "dd1e2d17-5c21-4964-b58d-198fd2aac150",
"status": "success",
"statusMessageCode": 200,
"statusMessage": "transaction successfully processed",
"senderPhoneNumber": "22951010591", //Phonenumeber you speciy in your collection request
"senderFirstName": "Jean", //User firstname you specified in your collect request
"senderLastName": "EVERICH", //User lastname you specified in your collect request
"currency": "XOF", //Currency of the transaction.
"amount": 2000, //Amount of the transaction
"senderOperator": "MTN", // Mobile Money wallet operator
"startTimestampInSecond": 1638087167, // Timestamp in second of whe you init the transaction
"endTimestampInSecond": 1638087167 // Timestamp in second of when the transaction is finished
}
}{
"event": "deposit.stateChanged",
"data": {
"reference": "dd1e2d17-5c21-4964-b58d-198fd2aac150",
"status": "success",
"statusMessageCode": 200,
"statusMessage": "success",
"recipientPhoneNumber": "22951010591", //Phone number you specify in your deposit request
"currency": "XOF", //Currency of the transaction.
"amount": 2000, //Amount of the transaction
"senderOperator": "MTN", // Mobile Money wallet operator
"startTimestampInSecond": 1638087167, // Timestamp in second of whe you init the transaction
"endTimestampInSecond": 1638087167 //Timestamp in second of when the transaction is finished
}
}You specify the phoneNumber of a collection with parametter senderPhoneNumber: sting in your http request
And for a disbursement you specify phoneNumber with parametter recipientPhoneNumber: sting in your request
Those parametters are locking for a string containing the phone number of the money sender for collection and the money recipient for disbursement.
The PhoneNumber should respect this format:
XXXOOOOOOOO
where the three X represent the country phone préfix (229 | 237 for example), and the O are the phone number in the country. The number of O can change with the country but the prefix should be 3.
You specify the currency of a transaction with the parammeter currency: string
The currency should be a string of 3 character.
If you add a currency that is not the currency localy used in the country of the phone number of the transaction, we will convert the amount of the transaction into local currency.
Our conversion rate evoluate like the market.
You specify the amount of a transaction with the parametter amount: number
This parametter should be a number.
We will check if the currency that you specify for the transaction is the local currency of the phone number's country and then we will convert the amount into local currency before performing the transaction with the customer
You respectively specify firstName and lastName with properties senderFirstName: string and senderLastName
Those parametters are required to perform secured collection request.
Disbursement doesn't need them.
If senderFirstName and senderLastName are not specified in collection request, you will get an error as response
Values and meaning of the property statusMessageCode contained in transactionData Object
| Code | Relative Status | Meaning |
|---|---|---|
| 200 | ✔️ -- success | Transaction successful |
| 201 | 🕟 -- pending | Data in validation |
| 202 | 🕟 -- pending | Transaction pending |
| 203 | 🕟 -- pending | Data are validated, server is working |
| 204 | 🕟 -- pending | Waiting for ussd push validation |
| 400 | ❌ -- error | Incorrect data enter in the request |
| 401 | ❌ -- error | Parameters not complete |
| 402 | ❌ -- error | Payment PhoneNumber is not correct |
| 403 | ❌ -- error | Deposit PhoneNumber is not correct |
| 404 | ❌ -- error | Timeout in USSD PUSH/ Cancel in USSD PUSH |
| 406 | ❌ -- error | Payment phoneNumber got is not for mobile money wallet |
| 460 | ❌ -- error | Payer’s payment account balance is low |
| 461 | ❌ -- error | An error occured while paying |
| 462 | ❌ -- error | This kind of transaction is not supported yet, processor not found |
| 5XX | ⛔️ -- error | An unknow error occured on the api |
You can use your test apikey or all users test apikey : test_FOdigzgSopV8GZggZa89 to make sandbox requsts.
All valid phone number you used in sandbox will send you valid responses as it was the live mode.
For exemple, if you use the phone number 22951010581 you will get a response with status message code 201 (what means pending see more here). Some seconds laters, you will get status messages codes 202, 203 and 200 (200 means success).
It is the same thing for others phone number with a small exception to allow errors case handling by implementor.
| Sandbox Phone number | -> final status message code |
|---|---|
| 22951010402 | 402 |
| 22951010403 | 403 |
| 22951010404 | 404 |
| 22951010460 | 460 |
| 22951010461 | 461 |
| 22951010462 | 462 |
| Any other valid | 200 |
For Live apiKey and Live Responses requests Contact us
When you are making a collection request, you have posibility to specify or not the payer's fistname and lastname.
By not specifying firstName and lastName, you can make quick test.
But when firstName and lastName are not specified your collection request is not secured.
And you are alowed to perform at most 3 unsecured collection resquest per day. More request will be just blocked.
You cannot perform unsecured collection request for more than 500 XOF.
Call us or write us to get your apikey and start getting payment
E-mail: [email protected] Website: https://chipdeals.me Phone: +22990630401 Whatsapp: +22990630401
Copyright (C) 2022 Chipdeals Inc - https://chipdeals.me