Powerful, easy-to-integrate APIs to accept mobile money and bank payments on your website or mobile app.
\nYou must complete the following steps :
\nBarkaPay Uses a pair of keys to handle authentication. Both must be set in the headers :
\nYou can generate a key pair by creating and API or SCI app in the API integration section from your BarkaPay Merchant Area.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Before you can use this API","slug":"before-you-can-use-this-api"},{"content":"Authentication","slug":"authentication"}],"owner":"17495291","collectionId":"9e000661-fd42-4538-8bd3-7bc368ef5449","publishedId":"2s9YsDjuoj","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"212121","highlight":"0A01D3"},"publishDate":"2023-12-30T18:04:34.000Z"},"item":[{"name":"Auth, API Status, User infos","item":[{"name":"PING (TEST YOUR AUTH)","event":[{"listen":"test","script":{"id":"5938f777-8457-4e0c-a5b8-f0d23e9bb0c9","exec":[""],"type":"text/javascript"}}],"id":"1a410b0c-77f0-4762-abd4-e0e91a8410f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{your_api_key}}","type":"text","description":"(Required) Your API Key
\n"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.barkapay.com/api/client/ping","description":"This endpoint sends an HTTP GET request to retrieve a ping response from the client API.
\nThe response will have a status code of 200 and a content type of application/json. The response body will contain a message indicating the status of the ping request.
\nmessage: A string indicating the status of the ping request. Example: \"Success\"{\n \"message\": \"Success\"\n}\n\nExample response body:
\n{\n \"status\": \"401\",\n \"error\": \"Invalid or disabled API credentials\"\n}\n\n(Required) Your API Key
\n"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.barkapay.com/api/client/operators-availability","description":"This endpoint retrieves the status of available services for the client.
\nGET https://api.barkapay.com/api/client/status\n\nstatus (integer): The HTTP status code of the response.message (string): A message regarding the status of the API.available_services (object): An object containing the availability of different services.transfers (object): An object containing the availability of transfer services.mobile (boolean): Indicates whether mobile transfers are available.crypto (boolean): Indicates whether crypto transfers are available.electro (boolean): Indicates whether electro transfers are available.payments (object): An object containing the availability of payment services.mobile (boolean): Indicates whether mobile payments are available.crypto (boolean): Indicates whether crypto payments are available.electro (boolean): Indicates whether electro payments are available.coder_note (string): Additional note from the coder.{\n \"status\": 200,\n \"message\": \"The API is up and running.\",\n \"available_services\": {\n \"transfers\": {\n \"mobile\": true,\n \"crypto\": false,\n \"electro\": false\n },\n \"payments\": {\n \"mobile\": true,\n \"crypto\": false,\n \"electro\": false\n }\n },\n \"coder_note\": \"Ambition is priceless.\"\n}\n\n(Required) Your API Key
\n"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.barkapay.com/api/client/user-and-api-app-info","description":"This endpoint makes an HTTP GET request to retrieve some merchant's information.
\nThe response will contain the following fields:
\nstatus (integer): The status of the user data retrieval.user-data (object): An object containing the user's data including:name (string): The name of the user.public_id (integer): The public ID of the user.status (integer): The status of the user : 0 means the merchant were suspended.{\n \"status\": 200,\n \"user\": {\n \"name\": \"Store Name\",\n \"public_id\": 0000100000100,\n \"status\": \"ENABLED\"\n },\n \"api_app_details\": {\n \"name\": \"App name\",\n \"description\": \"Short app description.\",\n \"label\": \"App label\",\n \"allowed_services\": \"both\", // payment, transfer, both\n \"allowed_countries\": [\n \"BFA\",\n \"CIV\",\n \"SEN\"\n ],\n \"allow_notifications\": \"ENABLED\",\n \"notification_url\": \"Secured notification url\",\n \"can_perform_transfers\": true,\n \"app_type\": \"api\"\n }\n}\n\nThis endpoint retrieves the operator information for the client from the BarkaPay API. The response contains the status of the request and detailed information about the operator, including whether OTP (One-Time Password) is required, payment instructions, payment delay, minimum and maximum payment amounts.
\nThe response will be in JSON format with the following structure:
\nThis set of methods allow you to test authentication, check available services, and retrieve information of the current merchant.
\n","_postman_id":"ec4803eb-8467-4e3c-bb12-367b3e386878"},{"name":"PAYMENT","item":[{"name":"API PAYMENT","id":"3cdb99ad-508b-4393-b746-aaf7eef8316d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"{{your_api_key}}","type":"text","description":"(Required) Your API Key
\n"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret
\n"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"sender_country","value":"BFA","description":"3 digits country name code : See supported operators per country.
\n","type":"text"},{"key":"operator","value":"MOOV","type":"text","description":"The operator. See supported operators per country.
\n"},{"key":"sender_phonenumber","value":"72929595","description":"Valid phonenumber : must match operator an country.
\n","type":"text"},{"key":"amount","value":"200","type":"text","description":"Must be between 100 and 1000000 CFA. The maximum is depending on the operator.
\n"},{"key":"order_id","value":"23839488238","type":"text","description":"Your product/service order ID.
\n"},{"key":"order_id_unicity","value":"0","type":"text","description":"Boolean. When true, we make sure there is not and existing order with same order_id. Disabled by default.
\n"},{"key":"callback_url","value":"https://www.myshopname.com/callbacks/barkapay","type":"text","description":"The IPN URL. If not specified, the API App Notification will be used by default.
\n"},{"key":"order_data","value":"{\"shop\": \"IsaShop\",\"product-id\": \"239230jd9230ej0\"}","type":"text","description":"Additionnal data : anything you will need back in the IPN.
\n"},{"key":"otp","value":"23235","description":"OTP : is required with some operators (Ex: Orange Money BFA).
\n","type":"text"}]},"url":"https://api.barkapay.com/api/client/payment/mobile/api","description":"Creates payment. With this method, your customer will be able to complete the payment without leaving your website.
\nThe following parameters are required in the request payload:
\nsender_country (text): 3 digits country name code (check supported operators per country)
operator (text): The operator (check supported operators per country in OPERATOR INFOS)
sender_phonenumber (text): Valid phone number that must match the operator and country
amount (text): check operator's payment infos for min_amount & max_amount (OPERATOR INFOS)
order_id (text): Your product/service order ID
order_id_unicity (text): Boolean. When true, ensures there is no existing order with the same order_id. Disabled by default.
callback_url (text): The IPN URL. If not specified, the API App Notification will be used by default.
order_data (text): Additional data that you will need back in the IPN. Often referred as metat_data.
otp (text): OTP required with some operators (e.g., Orange Money BFA) (check OPERATOR INFOS)
The response to this request will have a status code of 201 and a content type of application/json. The response body will contain the following fields:
\nstatus (number): Indicates the status of the transaction.
message (string): Any additional message related to the transaction status.
data.public_id (string): Public ID of the transaction.
data.amount (number): The amount involved in the transaction.
data.sender_phonenumber (string): Sender's phone number.
data.sender_country (string): Sender's country.
data.status (number): Status of the transaction.
data.order_id (string): Order ID associated with the transaction.
data.agent (object): Additional information about the agent involved in the transaction, if available.
(Required) Your API Key
\n"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret
\n"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"sender_country","value":"BFA","description":"3 digits country name code : See supported operators per country.
\n","type":"text"},{"key":"operator","value":"MOOV","type":"text","description":"The operator. See supported operators per country.
\n"},{"key":"sender_phonenumber","value":"72929595","description":"Valid phonenumber : must match operator an country.
\n","type":"text"},{"key":"amount","value":"200","type":"text","description":"Must be between 100 and 1000000 CFA. The maximum is depending on the operator.
\n"},{"key":"order_id","value":"23839488238","type":"text","description":"Your product/service order ID.
\n"},{"key":"order_id_unicity","value":"0","type":"text","description":"Boolean. When true, we make sure there is not and existing order with same order_id. Disabled by default.
\n"},{"key":"callback_url","value":"https://www.myshopname.com/callbacks/barkapay","type":"text","description":"The IPN URL. If not specified, the API App Notification will be used by default.
\n"},{"key":"order_data","value":"{\"shop\": \"IsaShop\",\"product-id\": \"239230jd9230ej0\"}","type":"text","description":"Additionnal data : anything you will need back in the IPN.
\n"},{"key":"otp","value":"23235","description":"OTP : is required with some operators (Ex: Orange Money BFA).
\n","type":"text"}]},"url":"https://api.barkapay.com/api/client/payment/mobile/api","description":"Creates payment. With this method, your customer will be able to complete the payment without leaving your website.
\nThe following parameters are required in the request payload:
\nsender_country (text): 3 digits country name code (check supported operators per country)
operator (text): The operator (check supported operators per country in OPERATOR INFOS)
sender_phonenumber (text): Valid phone number that must match the operator and country
amount (text): check operator's payment infos for min_amount & max_amount (OPERATOR INFOS)
order_id (text): Your product/service order ID
order_id_unicity (text): Boolean. When true, ensures there is no existing order with the same order_id. Disabled by default.
callback_url (text): The IPN URL. If not specified, the API App Notification will be used by default.
order_data (text): Additional data that you will need back in the IPN. Often referred as metat_data.
otp (text): OTP required with some operators (e.g., Orange Money BFA) (check OPERATOR INFOS)
The response to this request will have a status code of 201 and a content type of application/json. The response body will contain the following fields:
\nstatus (number): Indicates the status of the transaction.
message (string): Any additional message related to the transaction status.
data.public_id (string): Public ID of the transaction.
data.amount (number): The amount involved in the transaction.
data.sender_phonenumber (string): Sender's phone number.
data.sender_country (string): Sender's country.
data.status (number): Status of the transaction.
data.order_id (string): Order ID associated with the transaction.
data.agent (object): Additional information about the agent involved in the transaction, if available.
(Required) Your API Key
\n"},{"key":"X-Api-Secret","value":"{{your_sci_secret}}","type":"text","description":"(Required) Your API Secret
\n"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"set_amount","value":"fixed","description":"(Required). Must be in : fixed, floating, interval.
\n","type":"text"},{"key":"amount","value":"500","type":"text","description":"(Required) when set_amount is fixed. Check operator's payment infos for min & max. Default min : 100.
\n"},{"key":"order_id","value":"348bd829213ds","type":"text","description":"(Required)Your product/service order ID.
\n"},{"key":"order_id_unicity","value":"1","type":"text","description":"Boolean. When true, we make sure there is not and existing order with same order_id. Disabled by default.
\n"},{"key":"callback_url","value":"https://www.yourdomain.extension/callbacks/barkapay","type":"text","description":"The IPN URL. If not specified, the API App Notification will be used by default.
\n","disabled":true},{"key":"order_data","value":"{\"shop\": \"IsaShop\",\"product-id\": \"239230jd9230ej0\"}","type":"text","description":"Additionnal data : anything you will need back in the IPN.
\n","disabled":true},{"key":"amount_interval","value":"[50000,75000]","type":"text","description":"(Required if set_amount is \"interval\") : String.
\n","disabled":true},{"key":"period","value":"5000","type":"text","description":"The validity period of the link in secondes. Default is 300s (5 minutes).
\n","disabled":true},{"key":"notify_payer","value":"1","description":"1 or 0. If activated, we will send and payment notification the the \"payer_notification_email\". Your customer we could pay by clicking the Pay Now button in the mail.
\n","type":"text"},{"key":"payer_notification_email","value":"customername@domain.com","description":"Email, required if notify_payer = 1. The email of the payer.
\n","type":"text"},{"key":"title","value":"Air force One","type":"text","description":"Title of the product/service.
\n","disabled":true},{"key":"description","value":"Nike Air Force 1s are iconic basketball shoes introduced in 1982, known for their durability and classic style, widely popular in streetwear.","type":"text","description":"Description of the product/service.
\n","disabled":true},{"key":"pay_url","value":"https://www.yourdomain.extension/return-after-successful-payment","description":"The URL your user will be redirect in case of successful payment.
\n","type":"text","disabled":true},{"key":"no_pay_url","value":"https://www.yourdomain.extension/return-after-failed-payment","description":"The URL your user will be redirect in case of failed payment.
\n","type":"text","disabled":true}]},"url":"https://api.barkapay.com/api/client/payment/mobile/web/create","description":"Creates a payment link. With this method, the customer is required to follow the generated url to complete the payment.
\nset_amount (text, Required): Must be in: fixed, floating, interval.amount (text, Required): When set_amount is fixed. Check operator's payment infos for min & max.order_id (text, Required): Your product/service order ID.status (number): 0 if successful.message (string): Additional information message.link (string): Link related to the payment.data (object): Information about the payment including public_id, amount, status, order_id, and more.order_id_unicity (text, Optional): Boolean. When true, we make sure there is not an existing order with the same order_id. Disabled by default.pay_url (Optional) : When it is not set, the pay_url set for the involved SCI App will be used by default.no_pay_url (Optional) : When it is not set, the pay_url set for the involved SCI App will be used by default.notify_payer (text, Optional): 1 or 0. If activated, a payment notification will be sent to the payer_notification_email. The customer could pay by clicking the Pay Now button in the mail.payer_notification_email (text, Optional): Email, required if notify_payer = 1. The email of the payer.(Required) Your API Key
\n"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret
\n"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"url":"https://api.barkapay.com/api/client/payment/:public_id","description":"Get the actual information about the payment. You need to provide the \"public_id\" of the payment in the request.
\nThe response will contain an array of objects, each representing a payment with attributes such as public_id, amount, sender_phonenumber, sender_country, status, order_id, txid, order_data, coder_note, reason, created_at, and agent.
\nThe examples of responses for this request include details such as public_id, amount, sender_phonenumber, sender_country, status, order_id, txid, order_data, coder_note, reason, created_at, and agent for each payment.
\nThe status indicates the payment status, where 0 represents pending, 1 represents successful, and -1 represents failed. The order_data field contains additional information about the order in JSON format.
\nPlease note that the actual values for these attributes will vary for each payment.
\n","urlObject":{"protocol":"https","path":["api","client","payment",":public_id"],"host":["api","barkapay","com"],"query":[],"variable":[{"type":"any","value":"","key":"public_id"}]}},"response":[{"id":"62496f94-e8da-4c18-9bbf-00e9a73c0ad9","name":"PENDING PAYMENT","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{your_api_key}}","type":"text","description":"(Required) Your API Key"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"url":"{{api_url}}/client/payment/d275a941-e1f8-4c6d-9ddb-99765fc3b10d"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 01 Feb 2024 20:45:08 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Powered-By","value":"PHP/8.2.15"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"public_id\": \"d275a941-e1f8-4c6d-9ddb-99765fc3b10d\",\n \"amount\": 200,\n \"sender_phonenumber\": \"72929595\",\n \"sender_country\": \"BFA\",\n \"status\": 0,\n \"order_id\": \"23839488238\",\n \"txid\": null,\n \"order_data\": \"{\\\"shop\\\": \\\"IsaShop\\\",\\\"product-id\\\": \\\"239230jd9230ej0\\\"}\",\n \"coder_note\": \"Ambition is priceless.\",\n \"reason\": null,\n \"created_at\": \"2024-02-01T20:42:24.394000Z\",\n \"agent\": null\n }\n]"},{"id":"456d8310-b0a0-4a56-984a-17e9b3020cb0","name":"SUCCESS PAYMENT","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{your_api_key}}","type":"text","description":"(Required) Your API Key"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"url":"{{api_url}}/client/payment/a117879e-ebf3-4f25-9c56-cce7dda24d68"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 01 Feb 2024 20:46:25 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Powered-By","value":"PHP/8.2.15"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"public_id\": \"a117879e-ebf3-4f25-9c56-cce7dda24d68\",\n \"amount\": 23460,\n \"sender_phonenumber\": \"70187358\",\n \"sender_country\": \"BFA\",\n \"status\": 1,\n \"order_id\": \"c1d66d7e1198d\",\n \"txid\": \"CHKTRANS240201.1615.B15593\",\n \"order_data\": null,\n \"coder_note\": \"Ambition is priceless.\",\n \"reason\": \"Successfully received payment.\",\n \"created_at\": \"2024-02-01T16:10:20.088000Z\",\n \"agent\": null\n }\n]"},{"id":"21ca1aa1-fd10-4783-9c6b-9e5cb518f458","name":"FAILED PAYMENT","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{your_api_key}}","type":"text","description":"(Required) Your API Key"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"url":"{{api_url}}/client/payment/59793533-8cb2-410a-8a39-4a2afa0c2e7e"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 01 Feb 2024 20:47:41 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Powered-By","value":"PHP/8.2.15"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"public_id\": \"59793533-8cb2-410a-8a39-4a2afa0c2e7e\",\n \"amount\": 1010,\n \"sender_phonenumber\": \"72929595\",\n \"sender_country\": \"BFA\",\n \"status\": -1,\n \"order_id\": \"3ea21aac0dd2d\",\n \"txid\": null,\n \"order_data\": null,\n \"coder_note\": \"Ambition is priceless.\",\n \"reason\": \"No payment.\",\n \"created_at\": \"2023-06-22T23:04:22.710000Z\",\n \"agent\": null\n }\n]"}],"_postman_id":"2657e1f0-b886-475a-a9ee-1e9214092eee"},{"name":"FILTER","id":"a3da9abd-c786-40c0-940b-aa9e7d0b144f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{your_api_key}}","type":"text","description":"(Required) Your API Key
\n"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret
\n"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"url":"https://api.barkapay.com/api/client/payment/?sender_country=BFA&operator=MOOV&sender_phonenumber=72929595&status=1&date_1=2024-01-01&date_2=2024-01-31&order_id=23839488238","description":"This endpoint retrieves payment details based on specified filters such as sender country, operator, sender phone number, status, date range, and order ID.
\nThe response contains an array of payment objects with attributes like public ID, amount, sender phone number, sender country, status, order ID, transaction ID, order data, coder note, reason, creation timestamp, type, currency, operator, address, and origin source.
\nsender_country (string): The country of the sender.operator (string): The operator involved in the transaction.sender_phonenumber (string): The phone number of the sender.status (integer): The status of the transaction.date_1 (string): The start date of the date range.date_2 (string): The end date of the date range.order_id (string): The unique ID associated with the order.The response will be an array of payment objects, each containing the following attributes:
\npublic_id (string): The public ID of the transaction.amount (integer): The amount of the transaction.sender_phonenumber (string): The phone number of the sender.sender_country (string): The country of the sender.status (integer): The status of the transaction.order_id (string): The unique ID associated with the order.txid (string): The transaction ID.order_data (string): Additional data related to the order.coder_note (string): Additional note from the coder.reason (string): Reason for the transaction.created_at (string): The timestamp of the transaction creation.type (string): The type of transaction.currency (string): The currency used in the transaction.operator (string): The operator involved in the transaction.address (string): The address associated with the transaction.origin_source (integer): The source of origin for the transaction.The country
\n","type":"text/plain"},"key":"sender_country","value":"BFA"},{"description":{"content":"The operator : must be supported in the selected country
\n","type":"text/plain"},"key":"operator","value":"MOOV"},{"description":{"content":"The sender phone number
\n","type":"text/plain"},"key":"sender_phonenumber","value":"72929595"},{"description":{"content":"The status : 0, 1, -1.
\n","type":"text/plain"},"key":"status","value":"1"},{"description":{"content":"Start date.
\n","type":"text/plain"},"key":"date_1","value":"2024-01-01"},{"description":{"content":"End date.
\n","type":"text/plain"},"key":"date_2","value":"2024-01-31"},{"description":{"content":"The order_id
\n","type":"text/plain"},"key":"order_id","value":"23839488238"}],"variable":[]}},"response":[{"id":"fc65ffcf-376b-4680-85fe-237e8680d7a7","name":"STANDARD FILTER","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{your_api_key}}","type":"text","description":"(Required) Your API Key"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"url":{"raw":"{{api_url}}/client/payment/?sender_country=CIV&operator=CORIS&sender_phonenumber=72929595&status=1&date_1=2024-01-01&date_2=2024-01-31&order_id=23839488238","host":["{{api_url}}"],"path":["client","payment",""],"query":[{"key":"sender_country","value":"CIV","description":"The country"},{"key":"operator","value":"CORIS","description":"The operator : must be supported in the selected country"},{"key":"sender_phonenumber","value":"72929595"},{"key":"status","value":"1","description":"The status : 0, 1, -1."},{"key":"date_1","value":"2024-01-01","description":"Start date."},{"key":"date_2","value":"2024-01-31","description":"End date."},{"key":"order_id","value":"23839488238","description":"The order_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 01 Feb 2024 21:00:18 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Powered-By","value":"PHP/8.2.15"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"public_id\": \"f736d4b5-ea47-4244-b209-83371047a058\",\n \"amount\": 200,\n \"sender_phonenumber\": \"72929595\",\n \"sender_country\": \"BFA\",\n \"status\": 1,\n \"order_id\": \"23839488238\",\n \"txid\": \"CHKTRANS240124.1257.C15593\",\n \"order_data\": \"{\\\"category\\\": \\\"mobile\\\",\\\"type\\\": \\\"main_bfa\\\",\\\"user_id\\\": \\\"6467571b952726d40405d003\\\",\\\"country\\\": \\\"BFA\\\",\\\"balance\\\": 0}\",\n \"coder_note\": \"Ambition is priceless.\",\n \"reason\": \"Successfully received payment.\",\n \"created_at\": \"2024-01-24T12:29:25.410000Z\",\n \"type\": \"mobile\",\n \"currency\": null,\n \"operator\": \"MOOV\",\n \"address\": null,\n \"origin_source\": 1\n },\n {\n \"public_id\": \"2193e086-46dd-4a3c-be51-e191adf40a9b\",\n \"amount\": 200,\n \"sender_phonenumber\": \"72929595\",\n \"sender_country\": \"BFA\",\n \"status\": 1,\n \"order_id\": \"23839488238\",\n \"txid\": \"CHKTRANS240124.1340.B17072\",\n \"order_data\": \"{\\\"category\\\": \\\"mobile\\\",\\\"type\\\": \\\"main_bfa\\\",\\\"user_id\\\": \\\"6467571b952726d40405d003\\\",\\\"country\\\": \\\"BFA\\\",\\\"balance\\\": 0}\",\n \"coder_note\": \"Ambition is priceless.\",\n \"reason\": \"Successfully received payment.\",\n \"created_at\": \"2024-01-24T13:34:38.218000Z\",\n \"type\": \"mobile\",\n \"currency\": null,\n \"operator\": \"MOOV\",\n \"address\": null,\n \"origin_source\": 1\n }\n]"}],"_postman_id":"a3da9abd-c786-40c0-940b-aa9e7d0b144f"}],"id":"15f53298-2607-4c12-b5c2-4aab0f7d7400","description":"BarkaPay enables your online business, whether through websites or mobile applications, to accept payments seamlessly.
By integrating our API, you offer customers the flexibility to choose their preferred payment methods, tailored to the most popular options within their country.
This single integration bridges your business with the global market, expanding your reach worldwide with ease and efficiency.
BarkaPay offers two payment integration approaches:
\nAPI Payment : you handle all the payment process on your frontend app. You receive Instant Payment Notifications (IPN) for each successful payment.
\nSCI Payment : you generate a payment link for your customers. Upon clicking this link, customers are directed to BarkaPay's shopping cart interface, where the payment process is managed on your behalf. You will receive Instant Payment Notifications (IPN) and email notifications for each transaction.
\nIf uncertain about the best approach for your needs, BarkaPay provides support at support@barkapay.com to guide you through the decision-making process.
\n","_postman_id":"15f53298-2607-4c12-b5c2-4aab0f7d7400"},{"name":"TRANSFER","item":[{"name":"REQUEST","id":"f16d473c-912e-49d2-b61b-1e315d95713f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"{{your_api_key}}","type":"text","description":"(Required) Your API Key
\n"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret
\n"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"receiver_country","value":"BFA","description":"(Required) 03 digits country name code
\n","type":"text"},{"key":"receiver_phonenumber","value":"72929595","description":"(Required) valid phonenumber : must match operator an country.
\n","type":"text"},{"key":"operator","value":"MOOV","type":"text","description":"(Required) the operator. See OPERATORS INFOS
\n"},{"key":"amount","value":"100","type":"text","description":"(Required) see OPERATORS INFOS
\n"},{"key":"order_id","value":"{{your_order_id}}","type":"text","description":"(Required) your product's order_id
\n"},{"key":"order_id_unicity","value":"1","type":"text","description":"default : 0, by default, we don't check the order_id_uniticy
\n","disabled":true},{"key":"callback_url","value":"{{your_callback_url}}","type":"text","description":"Nullable : if null, we use the defined callback URL in you API app configs. Must be an valid & secured URL.
\n"},{"key":"order_data","value":"{\"order_data\":\"no-data\"}","type":"text","description":"Anything you may need to process the callback properly.
\n"},{"key":"ignore_double_spend_risk","value":"","description":"This ignores double spend protection. The feature is activated by default. Values : 1 (to ignore), 0 (same with not defined, enabled).
\n","type":"text","disabled":true}]},"url":"https://api.barkapay.com/api/client/transfer/request/mobile","description":"This endpoint is used to initiate a transfer request to a mobile number.
\nreceiver_country (text): 3 digits country name codereceiver_phonenumber (text): Valid phone number that must match the operator and countryoperator (text)amount (text)note (text, optional): Nullableorder_id (text)callback_url (text)order_data (text)ignore_double_spend_risk (text): This parameter ignores double spend protection. Values: 1 (to ignore), 0 (to enable)status (number): Indicates the status of the requestmessage (string): Additional information about the requestdata (object): Contains details of the transfer requestpublic_id (string): Public identifier for the requestamount (number): Amount of the transferreceiver_phonenumber (string): Receiver's phone numberreceiver_country (string): Receiver's countryoperator (string): Operator for the transferstatus (number): Status of the transferorder_id (string): Identifier for the orderapp_label (string): Label for the application{\n \"status\": 201,\n \"message\": \"Transfer request created successfully.\",\n \"data\": {\n \"public_id\": \"c6e16250-395e-47ab-920a-6f23ae141067\",\n \"amount\": 1000,\n \"receiver_phonenumber\": \"72929595\",\n \"receiver_country\": \"BFA\",\n \"operator\": \"MOOV\",\n \"status\": 0,\n \"order_id\": \"iweidiewd743kwedk\",\n \"app_label\": \"BRKCHG\"\n }\n}\n\n(Required) Your API Key
\n"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret
\n"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"url":"https://api.barkapay.com/api/client/transfer/{{your_order_public_id}}","description":"This HTTP GET request retrieves transfer details for a specific order identified by its public ID. The response will be in JSON format and will include details such as the public ID, amount, receiver's phone number, receiver's country, status, order ID, transaction ID, order data, coder's note, reason, creation timestamp, transfer type, currency, operator, and address.
\nExample response:
\n[\n {\n \"public_id\": \"c6e16250-395e-47ab-920a-6f23ae141067\",\n \"amount\": 1000,\n \"receiver_phonenumber\": \"72929595\",\n \"receiver_country\": \"BFA\",\n \"status\": 1,\n \"order_id\": \"iweidiewd743kwedk\",\n \"txid\": \"WCASH240216.0755.B00058\",\n \"order_data\": \"{\\\"order_data\\\":\\\"no-data\\\"}\",\n \"coder_note\": \"Ambition is priceless.\",\n \"reason\": \"Successfully sent.\",\n \"created_at\": \"2024-02-16T07:55:34.570000Z\",\n \"type\": \"mobile\",\n \"currency\": null,\n \"operator\": \"MOOV\",\n \"address\": null\n }\n]\n\n(Required) Your API Key
\n"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret
\n"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"url":"https://api.barkapay.com/api/client/transfer/?receiver_country=BFA&receiver_phonenumber=72929595&operator=MOOV&date_1=2024-02-16&date_2=2024-06-16&order_id={{your_order_id}}&status=1","description":"This HTTP GET request retrieves transfer details for a client based on specified parameters. The request URL is https://api.barkapay.com/api/client/transfer/, and it accepts query parameters such as receiver_country, receiver_phonenumber, operator, date_1, date_2, order_id, and status.
\nreceiver_country (string): The country of the receiver.receiver_phonenumber (string): The phone number of the receiver.operator (string): The operator involved in the transfer.date_1 (string): The start date for the transfer.date_2 (string): The end date for the transfer.order_id (string): The unique identifier for the order.status (integer): The status of the transfer.The response will be in JSON format with an array of transfer details objects. Each object contains the following properties:
\npublic_id (string): The public identifier for the transfer.amount (number): The transfer amount.receiver_phonenumber (string): The receiver's phone number.receiver_country (string): The receiver's country.status (integer): The status of the transfer.order_id (string): The unique identifier for the order.txid (string): The transaction ID.order_data (string): Data related to the order.coder_note (string): Additional notes from the coder.reason (string): Reason for the transfer.created_at (string): The creation date of the transfer.type (string): The type of transfer.currency (string): The currency used in the transfer.operator (string): The operator involved in the transfer.address (string): The address related to the transfer.origin_source (integer): The source of origin for the transfer.[\n {\n \"public_id\": \"c6e16250-395e-47ab-920a-6f23ae141067\",\n \"amount\": 1000,\n \"receiver_phonenumber\": \"72929595\",\n \"receiver_country\": \"BFA\",\n \"status\": 1,\n \"order_id\": \"iweidiewd743kwedk\",\n \"txid\": \"WCASH240216.0755.B00058\",\n \"order_data\": \"{\\\"order_data\\\":\\\"no-data\\\"}\",\n \"coder_note\": \"Ambition is priceless.\",\n \"reason\": \"Successfully sent.\",\n \"created_at\": \"2024-02-16T07:55:34.570000Z\",\n \"type\": \"mobile\",\n \"currency\": null,\n \"operator\": \"MOOV\",\n \"address\": null,\n \"origin_source\": 1\n }\n]\n\nBarkaPay allows businesses (like crypto exchangers) to send money via mobile money to their customers.
\nThree routes are available:
\nCreate a transfer: transfers are automatically executed after creation. You receive a notification email, and an IPN if these are correctly configured.
\nFinder: allows you to retrieve the details of a transaction by its public_id.
\nFilter: allows you to retrieve the details of transfers according to certain criteria
\n(Required) Your API Key
\n"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret
\n"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"url":"https://api.barkapay.com/api/client/accounts","description":"This endpoint makes an HTTP GET request to retrieve client account information from the Barkapay API. The response will be in JSON format with a status code of 200. An example response for this request is as follows:
\n{\n \"status\": 200,\n \"message\": \"Successfully browsed accounts.\",\n \"balances\": {\n \"mobile\": {\n \"BFA\": [\n {\n \"label\": \"main\",\n \"balance\": 2586\n },\n {\n \"label\": \"api\",\n \"balance\": 841513\n }\n ]\n }\n }\n}\n\nThe \"status\" key indicates the status of the request, \"message\" provides any additional information, and \"balances\" contains the account balance information for the client's mobile account. Further details about the \"label\" and \"balance\" within the \"BFA\" array can be obtained from the response.
\n","urlObject":{"protocol":"https","path":["api","client","accounts"],"host":["api","barkapay","com"],"query":[],"variable":[]}},"response":[{"id":"47778af9-e932-4203-9411-3f1637bb433d","name":"INDEX","originalRequest":{"method":"GET","header":[{"key":"X-Api-Key","value":"{{your_api_key}}","type":"text","description":"(Required) Your API Key"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"url":"{{api_url}}/client/accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 16 Feb 2024 08:56:17 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Powered-By","value":"PHP/8.2.16"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Upgrade","value":"h2,h2c"},{"key":"Connection","value":"Upgrade, Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Successfully browsed accounts.\",\n \"balances\": {\n \"mobile\": {\n \"BFA\": [\n {\n \"label\": \"main\",\n \"balance\": 2586\n },\n {\n \"label\": \"api\",\n \"balance\": 841513\n }\n ]\n }\n }\n}"}],"_postman_id":"41ab11e1-6912-4447-8051-4f20a8802da2"},{"name":"STATEMENT","id":"b130076f-5567-4503-a843-ad2e2b2482a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"{{your_api_key}}","type":"text","description":"(Required) Your API Secret
\n"},{"key":"X-Api-Secret","value":"{{your_api_secret}}","type":"text","description":"(Required) Your API Secret
\n"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Language","value":"fr","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"type","value":"mobile","description":"account type : mobile, crypto, electro, bank
\n","type":"text"},{"key":"name","value":"BFA","description":"account name
\n","type":"text"},{"key":"label","value":"main","description":"main or api
\n","type":"text"}]},"url":"https://api.barkapay.com/api/client/accounts/statement","description":"This API endpoint is used to add a client account statement.
\ntype (text): account type - mobile, crypto, electro, bankname (text): account namelabel (text): main or apiUpon a successful execution, the API returns a status code of 200 with a JSON response containing the following fields:
\nstatus (number): 0message (string): Empty messageaccount_info (object)type (string): Account typename (string): Account namelabel (string): Labelbalance (number): Account balancestatement (array)type (string): Statement typeamount (number): Statement amountprevious_balance (number): Previous balancenew_balance (number): New balancepublic_id (string): Public IDorigin (string): Statement origin{\n \"status\": 0,\n \"message\": \"\",\n \"account_info\": {\n \"type\": \"\",\n \"name\": \"\",\n \"label\": \"\",\n \"balance\": 0,\n \"statement\": [\n {\n \"type\": \"\",\n \"amount\": 0,\n \"previous_balance\": 0,\n \"new_balance\": 0,\n \"public_id\": \"\",\n \"origin\": \"\"\n }\n ]\n }\n}\n\nThese routes allow you to browse your account information: available accounts, balances, account statements.
\n","_postman_id":"30a8fa8c-6c1b-4a64-a2ee-32eb57cd137e"},{"name":"INSTANT PAYMENT NOTIFICATION","item":[],"id":"befcd7a3-9d3c-49c4-b7d1-717ace004288","description":"After processing a transaction, the system sends you an instant notification. You can configure 1 reception URL per application (API or SCI).
\n{\n \"public_id\": \"cd47b5eb-7ea3-45de-b15b-dca18ac871e9\",\n \"amount\": 10200,\n \"sender_phonenumber\": \"70656188\",\n \"sender_country\": \"BFA\",\n \"status\": 1,\n \"order_id\": \"41b7388e4ab38\",\n \"txid\": \"WMRCH240404.1349.F06808\",\n \"order_data\": null,\n \"coder_note\": \"Ambition is priceless.\",\n \"reason\": \"Successfully received payment.\",\n \"type\": \"payment\",\n \"hash\": \"d20de5598d1d92645ce2c76d6996f799d06d9b123769cf33e5ee1f71229f1d2f1d6bcd62c24e65f9b48c458988c952d7bd89ccd8e2fbec67c91d9c5ce0dca477\"\n}\n\n{\n \"public_id\": \"e506c8c2-dc58-4dd3-b6f5-add3bd39ef99\",\n \"amount\": 12573,\n \"receiver_phonenumber\": \"70763259\",\n \"receiver_country\": \"BFA\",\n \"status\": 1,\n \"order_id\": \"99b643bf0560a\",\n \"txid\": \"WCASH240404.1353.B01783\",\n \"order_data\": null,\n \"coder_note\": \"Ambition is priceless.\",\n \"reason\": \"Successfully sent.\",\n \"type\": \"transfer\",\n \"hash\": \"e9d17c26477625e2e90beee51cad7b78d9d864cbd9f983111327fc15d4d73246138f3997b7d15ca0fc783d40b1deffb44808194433c5b54b4989eefb5bda7353\"\n}\n\nBarkaPay allows you to verify the source of the IPN, allowing you to increase the security of your transactions:
\nA secret key is automatically generated when creating an API or SCI application. You can find it at https://barkapay.com/dashboard/api-apps/api/overview or https://barkapay.com/dashboard/api-apps/sci/overview.
\nA hash is generated and sent to the IPN under the \"hash\" key. To verify the authenticity of the data received, generate a hash and compare it to the one received in the IPN.
\nHere's how to generate the hash:
\n// Replace YOUR_IPN_ENCRYPTION_KEY with your actual IPN encryption key\n$ipnEncryptionKey = \"YOUR_IPN_ENCRYPTION_KEY\"; \n$hashedIpnEncryptionKey = hash('sha256', $ipnEncryptionKey);\n$transactionData = [\n 'public_id', \n 'amount', \n 'sender_phonenumber', \n 'sender_country', \n 'status', \n 'order_id', \n 'txid'\n];\n// Creating a hash sentence by concatenating transaction data and the hashed IPN key\n$hashSentence = \"13:\" . implode(\":\", $transactionData) . \":\" . $hashedIpnEncryptionKey . \":13\";\n// Generating the final hash using SHA-512\n$hash = hash('sha512', $hashSentence);\n\n// Define your IPN encryption key\n$ipnEncryptionKey = \"YOUR_IPN_ENCRYPTION_KEY\";\n$hashedIpnEncryptionKey = hash('sha256', $ipnEncryptionKey);\n// Simulate actual transaction data\n$transactionData = [\n 'e506c8c2-dc58-4dd3-b6f5-add3bd39ef99', // public_id\n '12573', // amount\n '70763259', // receiver_phonenumber\n 'BFA', // receiver_country\n '1', // status\n '99b643bf0560a', // order_id\n 'WCASH240404.1353.B01783' // txid\n];\n// Create a hash sentence by concatenating the transaction data and the hashed IPN key\n$hashSentence = \"13:\" . implode(\":\", $transactionData) . \":\" . $hashedIpnEncryptionKey . \":13\";\n// Generate the final hash using SHA-512\n$hash = hash('sha512', $hashBrbSentence);\n\n