This section describes how to collect payments from web applications or websites. The general flow is as follow: ![\"Paylink](\"https://mycoolpay.s3.amazonaws.com/api-docs/Paylink+Sequence.png\")
![\"My-CoolPay%20merchant%20dashboard\"](\"https://mycoolpay.s3.amazonaws.com/api-docs/Merchant+Dashboard.jpg\")
\n\n\n\nMy-CoolPay Merchant API is the easiest and most secure way to effortlessly accept payments from your customers on your websites and mobile applications. It has several integrated payment methods (Orange Money, MTN Mobile Money, VISA, Mastercard, My-CoolPay...) and offers you a unified view for a better follow-up of your activity.
\n
Une ancienne version de cette documentation est disponible en français, elle n'a pas été mise à jour depuis le 14/10/2021. Il est possible qu'elle soit obsolète à l'heure actuelle. Si vous souhaitez néanmoins l'utiliser, elle est disponible au format PDF à l'adresse ci-dessous.My-CoolPay_API_Documentation_FR_2021-10-14.pdf
\n\nBefore you can integrate My-CoolPay Merchant API into your website or application, you must:
\n
Once this has been done, you will see two API keys appear in the application details: a public key and a private key (to be kept secret).
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"French version 🇫🇷","slug":"french-version"},{"content":"Requirements","slug":"requirements"}],"owner":"17178321","collectionId":"c6d229f2-5c12-43a7-85d3-2c687425e2fe","publishedId":"UV5ZCx8f","public":true,"customColor":{"top-bar":"EDEDED","right-sidebar":"001B2B","highlight":"00578A"},"publishDate":"2021-10-21T16:49:59.000Z"},"item":[{"name":"1. Web APIs","item":[{"name":"Paylink","id":"e610fa62-3e27-400f-b012-a60091201ef0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"transaction_amount\": \"number\",\r\n \"transaction_currency\": \"string\",\r\n \"transaction_reason\": \"string\",\r\n \"app_transaction_ref\": \"string\",\r\n \"customer_phone_number\": \"string\",\r\n \"customer_name\": \"string\",\r\n \"customer_email\": \"string\",\r\n \"customer_lang\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my-coolpay.com/api/{public_key}/paylink","description":"\n\nPaylink API allows you to generate a single-use payment link. You will need to redirect the user to the URL received in the response so that he can make his payment. The payment process will be entirely managed by My-CoolPay.
\n
\n\n📝 Note: You have the possibility to pass parameters in the URL, as many as you want, as long as the size (length) of the parameters does not exceed 255 characters. At the end of the payment, these parameters will be inserted in the URL to which the customer will be redirected (success, cancellation or failure).
\n
In this case, the URL will look like:https://my-coolpay.com/api/{public_key}/paylink?param1=val1¶m2=val2…
\n\n","_postman_id":"c59ff2b8-8899-4f18-83b7-8e16e68c74a2"},{"name":"2. Mobile APIs","item":[{"name":"Payin","id":"66c6881a-1cb9-4532-b47a-c1d09a3f2741","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"transaction_amount\": \"number\",\r\n \"transaction_currency\": \"string\",\r\n \"transaction_reason\": \"string\",\r\n \"app_transaction_ref\": \"string\",\r\n \"customer_phone_number\": \"string\",\r\n \"customer_name\": \"string\",\r\n \"customer_email\": \"string\",\r\n \"customer_lang\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my-coolpay.com/api/{public_key}/payin","description":"This section describes how to collect payments from web applications or websites. The general flow is as follow:
\n
\n\nPayin API allows you to initialize synchronous payment. You will need to entirely manage payment flow.
\n
\n\nFor some security reasons, My-CoolPay may want to authenticate the phone number which is going to pay (this means you received {action: \"REQUIRE_OTP\"} in Payin response). OTP API allows you to authenticate customer's phone number.
\n
\n\n","_postman_id":"2e8ee2c4-5bb7-4700-92b6-17bf6cdea9f9"},{"name":"3. Payout APIs","item":[{"name":"Payout","id":"5c202ba5-c602-4106-9347-c055ba8fdf17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-PRIVATE-KEY","value":"{private_key}","type":"text","description":"This section describes how to collect payments from mobile or desktop applications. The general flow is as follow:
\n
Your application private key
\n"}],"body":{"mode":"raw","raw":"{\r\n \"transaction_amount\": \"number\",\r\n \"transaction_currency\": \"string\",\r\n \"transaction_reason\": \"string\",\r\n \"transaction_operator\": \"string\",\r\n \"app_transaction_ref\": \"string\",\r\n \"customer_phone_number\": \"string\",\r\n \"customer_name\": \"string\",\r\n \"customer_email\": \"string\",\r\n \"customer_lang\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my-coolpay.com/api/{public_key}/payout","description":"\n\nPayout API allows you to transfer money from your My-CoolPay account to MTN MoMo account, Orange Money account or another My-CoolPay account.
\n
\n\n","urlObject":{"protocol":"https","path":["api","{public_key}","payout"],"host":["my-coolpay","com"],"query":[],"variable":[]}},"response":[{"id":"8c2c576c-a533-4a91-8884-fc94bce57eb8","name":"Payout","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-PRIVATE-KEY","value":"{private_key}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"transaction_amount\": 500,\r\n \"transaction_currency\": \"XAF\",\r\n \"transaction_reason\": \"Customer refund\",\r\n \"transaction_operator\": \"CM_OM\",\r\n \"app_transaction_ref\": \"refund_123\",\r\n \"customer_phone_number\": \"699009900\",\r\n \"customer_name\": \"Bob MARLEY\",\r\n \"customer_email\": \"bob@mail.com\",\r\n \"customer_lang\": \"en\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my-coolpay.com/api/{public_key}/payout"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"message\": \"Successful transaction !\",\r\n \"transaction_ref\": \"17178321-c6d229f2-5c12-43a7-85d3-2c687425e2fe\"\r\n}"},{"id":"dd4c961c-bd91-4ed1-8522-2f8398211946","name":"Payout in progress","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-PRIVATE-KEY","value":"{private_key}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"transaction_amount\": 500,\r\n \"transaction_currency\": \"XAF\",\r\n \"transaction_reason\": \"Customer refund\",\r\n \"transaction_operator\": \"CM_OM\",\r\n \"app_transaction_ref\": \"refund_123\",\r\n \"customer_phone_number\": \"699009900\",\r\n \"customer_name\": \"Bob MARLEY\",\r\n \"customer_email\": \"bob@mail.com\",\r\n \"customer_lang\": \"en\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my-coolpay.com/api/{public_key}/payout"},"status":"Accepted","code":202,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"message\": \"Transaction in progress...\",\r\n \"transaction_ref\": \"17178321-c6d229f2-5c12-43a7-85d3-2c687425e2fe\"\r\n}"}],"_postman_id":"5c202ba5-c602-4106-9347-c055ba8fdf17"}],"id":"3fb215c1-3b89-4907-a929-568b24ab9768","description":"📝 Note: To make a withdrawal to a My-CoolPay wallet, you must provide one of the following properties: customer_phone_number, customer_username, customer_email
\n
\n\n","_postman_id":"3fb215c1-3b89-4907-a929-568b24ab9768"},{"name":"4. Status check APIs","item":[{"name":"Check status","id":"4c0bcbae-66a2-4312-8124-feb6d986d296","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://my-coolpay.com/api/{public_key}/checkStatus/{transaction_ref}","description":"This section describes how to transfer money from your My-CoolPay account to other operators. The general flow is as follow:
\n
\n\n","urlObject":{"protocol":"https","path":["api","{public_key}","checkStatus","{transaction_ref}"],"host":["my-coolpay","com"],"query":[],"variable":[]}},"response":[{"id":"724c673d-d4af-4482-95f8-86897741396c","name":"Check status","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://my-coolpay.com/api/{public_key}/checkStatus/18ac6335-2bdd-4b95-944e-ef029c49c5b5"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"app_transaction_ref\": \"order_123\",\r\n \"operator_transaction_ref\": \"MP200618.1634.A34527\",\r\n \"transaction_ref\": \"18ac6335-2bdd-4b95-944e-ef029c49c5b5\",\r\n \"transaction_type\": \"PAYIN\",\r\n \"transaction_amount\": 100,\r\n \"transaction_fees\": 2,\r\n \"transaction_currency\": \"XAF\",\r\n \"transaction_operator\": \"CM_OM\",\r\n \"transaction_status\": \"PENDING\",\r\n \"transaction_reason\": \"Bic pen\",\r\n \"transaction_message\": null,\r\n \"customer_phone_number\": \"699009900\"\r\n}"}],"_postman_id":"4c0bcbae-66a2-4312-8124-feb6d986d296"},{"name":"Check status (Legacy)","id":"13cec29a-0de2-4f91-9d87-6b060f69a7b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"transaction_ref\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my-coolpay.com/api/{public_key}/checkStatus","description":"Check status API allows you to check the status of a transaction by providing its reference.
\n
\n\n","urlObject":{"protocol":"https","path":["api","{public_key}","checkStatus"],"host":["my-coolpay","com"],"query":[],"variable":[]}},"response":[{"id":"8a34060e-64c3-4293-b180-261be7a70f4b","name":"Check status (Legacy)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"transaction_ref\": \"18ac6335-2bdd-4b95-944e-ef029c49c5b5\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://my-coolpay.com/api/{public_key}/checkStatus"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"See response in Check status API above"}],"_postman_id":"13cec29a-0de2-4f91-9d87-6b060f69a7b6"}],"id":"6db93261-46bc-4037-aceb-1c63e991e5c2","description":"This is the legacy (old) version of Check status API. It's now deprecated, if you are new to our API, use GET version instead.
\n
\n\n","_postman_id":"6db93261-46bc-4037-aceb-1c63e991e5c2"},{"name":"5. Balance APIs","item":[{"name":"Balance","id":"95bae9d4-30a6-413b-9f27-b15b7dfe12b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"X-PRIVATE-KEY","value":"{private_key}","description":"For some reasons, you may want to programmatically check the status of a transaction. This section describe how you can perform that.
\n
Your application private key
\n","type":"text"}],"url":"https://my-coolpay.com/api/{public_key}/balance","description":"\n\n","urlObject":{"protocol":"https","path":["api","{public_key}","balance"],"host":["my-coolpay","com"],"query":[],"variable":[]}},"response":[{"id":"13d2df43-3aee-4f1a-ae0c-253a86d86ab9","name":"Check status","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"X-PRIVATE-KEY","value":"{private_key}","type":"text"}],"url":"https://my-coolpay.com/api/{public_key}/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"balance\": 500\n}"}],"_postman_id":"95bae9d4-30a6-413b-9f27-b15b7dfe12b1"}],"id":"405370d2-fac1-4e4c-b194-faf5efd3514a","_postman_id":"405370d2-fac1-4e4c-b194-faf5efd3514a","description":""},{"name":"6. Callback handling (Webhook)","item":[],"id":"7399ce2a-0056-48b8-8f42-581abeae3e84","description":"Balance API allows you to retrieve the balance of your application.
\n
\n\nAfter each transaction, My-CoolPay notifies your system by making a POST request to the callback URL of your application with the following body:
\n
![\"Payin](\"https://mycoolpay.s3.amazonaws.com/api-docs/Payin+Sequence.png\")
![\"Payout](\"https://mycoolpay.s3.amazonaws.com/api-docs/Payout+Sequence.png\")
{\n \"application\": \"{public_key}\",\n \"app_transaction_ref\": \"order_123\",\n \"operator_transaction_ref\": \"MP200618.1634.A34527\",\n \"transaction_ref\": \"18ac6335-2bdd-4b95-944e-ef029c49c5b5\",\n \"transaction_type\": \"PAYIN\",\n \"transaction_amount\": 100,\n \"transaction_fees\": 2,\n \"transaction_currency\": \"XAF\",\n \"transaction_operator\": \"CM_OM\",\n \"transaction_status\": \"SUCCESS\",\n \"transaction_reason\": \"Bic pen\",\n \"transaction_message\": \"Your transaction has been successfully completed\",\n \"customer_phone_number\": \"699009900\",\n \"signature\": \"d41d8cd98f00b204e9800998ecf8427e\"\n}\n\nsignature = md5(\n transaction_ref\n + transaction_type\n + transaction_amount\n + transaction_currency\n + transaction_operator\n + private_key\n)\n// Sign + means string concatenation.\n// Numbers should be converted to strings without non significant zeros.\n\n\n\n","_postman_id":"7399ce2a-0056-48b8-8f42-581abeae3e84"},{"name":"7. Security 🔐","item":[],"id":"0c4cf5ed-f0c6-4dea-bd2e-0b4a3dd03687","description":"📝 Note that, for a given transaction, My-CoolPay will send a callback only once. There is no possible retry in case of failure. If for some reason your system didn’t receive callback for a transaction, you can check its status by using Check status API.
\n
🔒 Public key: This key is the one that identifies your application on My-CoolPay, it is public and you won't run any security risk by exposing it.
\n🔑 Private key: This key is to be kept secret, avoid leaving it lying around in the versioning if you are using a VCS (like Git or Mercurial). It is used by My-CoolPay to sign your callback requests and by you as a password during API withdrawals.
\n\n\n⚠️ Warning: If you become aware that your keys have been compromised or are being used illegally, generate new keys from your My-CoolPay merchant area.
\n
It is highly recommended (or even mandatory) to install an SSL certificate on your server so that data exchanges with it are secure. My-CoolPay won’t send payment notifications (callback) to neither an unsecured address, nor localhost.
\nIn order to reduce the risk of attack, it is also recommended to choose a complex callback URL (difficult to remember or imagine).e.g. https://mywebsite.com/callback/jkdKo0Lp8lsdfjk4j0HJhskfak93d
Before you can use Payout APIs, you must first send the IP addresses of your servers to My-CoolPay by email (support@my-coolpay.com). You can provide up to three (03) addresses. Any payout request coming from a server other than those you have specified will be automatically rejected.
\n\n\n📝 Note: However, during your API integration period, you can ask support to temporarily disable this firewall so that you can perform tests.
\n
Before processing a callback request, it is essential to verify its origin and its integrity.
The checks to be done are the following (in order):
If all the above checks give a positive result, then the request is authentic, respond with \"OK\". Otherwise respond with \"KO\".
\n","_postman_id":"0c4cf5ed-f0c6-4dea-bd2e-0b4a3dd03687"},{"name":"8. Sandbox (testing)","item":[],"id":"26f0f198-8104-48f6-9a30-1acdfd81f1bc","description":"\n\n","_postman_id":"26f0f198-8104-48f6-9a30-1acdfd81f1bc"},{"name":"More assistance","item":[],"id":"2950919d-aa97-4817-a3b0-0fde320bdc48","description":"💔 We do not yet have a complete test environment. We are still working to provide one soon. Stay tuned. Nevertheless, you can use the following keys to test Web APIs, Mobile APIs and Status check APIs.
\n
ℹ️ If you need further information or assistance, our teams are available at support@my-coolpay.com. You can also get help from the developer community 💬
\n","_postman_id":"2950919d-aa97-4817-a3b0-0fde320bdc48"},{"name":"Contributors","item":[],"id":"6d1159ce-d25f-495a-9eba-98cf8faf79e8","description":"\n","_postman_id":"6d1159ce-d25f-495a-9eba-98cf8faf79e8"}],"event":[{"listen":"prerequest","script":{"id":"113102fb-76be-4363-85b8-27344eeb07ff","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5e1ac83a-58c6-4992-90bd-eda6d07afd25","type":"text/javascript","exec":[""]}}]}