{"info":{"_postman_id":"18e3b052-ec42-4050-91f3-06229fd79179","name":"Unified-API Developer Labs","description":"

Our API offers our partners a more smarter and seamless way to integrate, collect and process payment transactions. We offers a wide range of payment channels including digital Wallet payments, Qr (EcobankPay), Cards, Account transactions and more. Please visit our Online Portal for more informative details

Unified-API Developer Labs allow developers to test previews of our Payment API features. The endpoints, documentation, and resources for Labs will be updated as we incorporate more alternate and excited payment/channels from our innovative software team.

Postman collection for Unified-API Developer Labs

This is a Postman collection for the developer previews in Unified API- Developer Labs.

For more details, read the Ecobank Unified Developer Labs documentation.

Remember: The endpoints we release in Labs will be previews and are likely to change before they are released broadly, so we encourage you to take that into consideration as you build.

END TO END INTEGRATION STEPS.

1- Register for Sandbox Access: Register by filling all required details to be given access details to our sandbox. Remember the username and password you will be giving will be required for authentication during the request for Go live access.

2- Email confirmation:
You will receive an email confirmation upon successful registration during the sandbox access request. This email will contain the following:

UserID: This will be required for the token generation request.
\n
Password: This will be required for the token generation request.
\n
Lab key: This will be required to generate the secureHash as a parameter.
\n
Documentation link: This will take you to our service documentation where you will find all relevant details.
\n
Test case file: You will need to populate it based on your actual result on the sandbox testing. This document will have to be uploaded as part of the request for go live process.
\n

3- Sandbox Integration: Build your logic based on the sandbox services and requirements. At this stage you will be expected to do the following:

a- Token generation: Generate a token using the Token generation endpoint under the collection section, by passing the userId and password which would have been sent to you via email when registering for the sandbox access.
\n
b- Hashing algorithm: This needs to be tested in isolation under the sandbox, the endpoint can be found under the collection Hashing Service , full details on how to do the computation available under the said collection.
\n
c- Sending the request: Before sending the request ensure you had appended the generated token stated in the section a of this documentation on the authorisation of parameter of your JSON request, and also ensure the default origin is included in the header side of your request (developer.ecobank.com).
PS ---- For the purpose of testing on the sandbox you are not expected to change the body of your json request but only to make use of the predefined data.
\n

4- Complete the test case document: the test cases document received after the successful registration for the sandbox access needs to be completed based on the actual result of the test conducted on the sandbox. This will be required for upload during the request for go live phase.

5- Request for Go live: Go back to our developer's portal and click on Register for Go live. You will be required to login with the credentials that you chose during the registration for sandbox access phase. Once successfully authenticated you will be required to complete all basic KYC information and finally upload the the completed test case document and submit for review and approval.

6- Review & Approval: At this point we will receive your request for Go live and will contact you accordingly for any addition details or information to get you going on our production platform.

Quick install

Just click the Run in Postman button. You're all set!

Environment

This collection includes a environment variables that are needed to authenticate each request. You will need to add values to each variable.

Collections

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
`user_id`	Your userId
`lab_key`	Your Lab key
`secret`	Your secret
`access_token`	Your access token

To find these values:

Open your Developer dashboard.
\n
Head over the Register tab.
\n
Enter the required information and click register.
\n
You credentials will be sent via email.
\n
Copy the values into each variable.
\n

To add these values to your Postman environment:

Select the ⚙️ icon next to the Unified-API Developer Labs environment name.
\n
Click Unified-API Developer Labs.
\n
For each variable, add the values from your app dashboard in the Current value column.
\n
When you're done adding all values, click Update.
\n

Postman will set up your requests to be authenticated using OAuth 2.0 (Bearer token) authentication.

Get help

If you need help, ask a question in the Labs community forums.

Submit feedback

Your ideas matter! Help us develop the next generation of the Unified-API Developer Labs by sharing your feedback.

We know the best future version of our API will come from creating it together with the people who use it most.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Postman collection for Unified-API Developer Labs","slug":"postman-collection-for-unified-api-developer-labs"}],"owner":"9576712","collectionId":"18e3b052-ec42-4050-91f3-06229fd79179","publishedId":"2s7YtWCtNX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-09-19T14:38:00.000Z"},"item":[{"name":"Access Token","item":[{"name":"Token Generation (Bearer)","id":"f14f8635-4e64-4c61-a230-466cd4d4b5ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n","type":"text"},{"key":"Accept","type":"text","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n"},{"key":"Origin","value":"developer.ecobank.com","type":"text","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"iamaunifieddev103\",\n \"password\": \"$2a$10$Wmame.Lh1FJDCB4JJIxtx.3SZT0dP2XlQWgj9Q5UAGcDLpB0yRYCC\"\n}"},"url":"https://developer.ecobank.com/corporateapi/user/token","description":"

Generates token for merchant authentication and authorization.

\n","urlObject":{"path":["corporateapi","user","token"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"a2f418fb-049b-4d5c-a45d-fe6e9e09c2df","name":"Token Generation (Bearer Authoriztion)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Origin","value":"developer.ecobank.com","type":"text"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"iamaunifieddev103\",\n \"password\": \"$2a$10$Wmame.Lh1FJDCB4JJIxtx.3SZT0dP2XlQWgj9Q5UAGcDLpB0yRYCC\"\n}"},"url":"https://developer.ecobank.com/corporateapi/user/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Oct 2019 11:12:46 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, OPTIONS, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"username\": \"developer1@unifiedworks.com\",\n \"token\": \"eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJzYWRhcmt3YWhAZWNvYmFuay5jb20iLCJleHAiOjE1NzIwMDkxNjcsImlhdCI6MTU3MjAwMTk2NywiaXNzIjoiY29tLmVjb2JhbmsuY29ycG9yYXRlYXBpIiwianRpIjoiIn0.Ccen_tAlRRgeH07bABCtl4eZbYPerlwJUS_o8dJLopE_ncqTpFvoBr42nMrvI4Ol5JaI9HgbaQ9tbxZdyKYn0pYJ7nCjztVJd91pal2Sb-2VoaJvwaDkDIw8i502ZqBAMv6FIln6QAM4DeKrpaLnRcrqzwiYzZNqfBJKHWw9P8rqhhEzRe_kYuCn7tlMSSB3DbFyH698KyMBy_-7sqyEc4LIVSCjjWkhGTSNLV1Ret1VBSbuDVYQan4OiAB_P-UH480ZrCXh0UbZWgP1c6idxoyEwCb4LqPjmm53HDbn-yCWGyoZxAYZWfahRu0mO64i_S5zM3Gu9KswaqEEyEwb0w\"\n}"}],"_postman_id":"f14f8635-4e64-4c61-a230-466cd4d4b5ec"}],"id":"ba757442-5958-4f07-af43-2490a83b3ac5","_postman_id":"ba757442-5958-4f07-af43-2490a83b3ac5","description":""},{"name":"Collections","item":[{"name":"Card Payment","id":"b3dac31c-6d26-4a11-95ff-1baf479c416a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

The HTTP Authorization request header contains the credentials to authenticate a user agent with a server, usually after the server has responded with a 401 Unauthorized status and the WWW-Authenticate header.

\n"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n"},{"key":"Accept","value":"application/json","type":"text","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n"},{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paymentDetails\": {\n \"requestId\": \"0550342516521\",\n \"productCode\": \"2310\",\n \"amount\": \"30\",\n \"currency\": \"USD\",\n \"locale\": \"en_AU\",\n \"orderInfo\": \"b5f7f321d-9a4e-4c5c-a948-ab7642f43ce4\",\n \"returnUrl\": \"https://www.ecobank.com/unified\"\n },\n \"merchantDetails\": {\n \"accessCode\": \"31ba5746e7603385bc5c28c45710a4ec\",\n \"merchantID\": \"AE681FE1-FDB3-4477-B8A1-7553FE2099D7\",\n \"secureSecret\": \"38edcc440faa4637916b2fbdf4a5e02fbf807d9cce0e4404af741befe611cdf422a986eec5854660af42d06bd1c50f4d19ef35324bad47d7b9113f6daf5789cacd463bfa925d4bf3a93ca8cab15563cda375e428e4e740d290633fd6fce09e0bbb0fbfadb14147e0af91993266dfd0b6bc520aac868e49aca923cd332cc9a1a8\"\n },\n \"secureHash\": \"1be4bf59f4917a306005fd8178b8ae9ac385b832a94b15c7a87945cf374edab099e9735379833a01053c33f0edae94ebd0ffa8beb5680871e78c3b7630582331\"\n}"},"url":"https://developer.ecobank.com/corporateapi/merchant/Signature","description":"

This call allows merchants to receive payments via debit and credit cards from customers.

\n","urlObject":{"path":["corporateapi","merchant","Signature"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"95f623c0-4d98-4f2c-b8ed-f503b3b64ad5","name":"Card Payment","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"The HTTP Authorization request header contains the credentials to authenticate a user agent with a server, usually after the server has responded with a 401 Unauthorized status and the WWW-Authenticate header."},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is."},{"key":"Accept","value":"application/json","type":"text","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand."},{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests. ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paymentDetails\": {\n \"requestId\": \"0550342511\",\n \"productCode\":\"2310\",\n \"amount\": \"10\",\n \"currency\": \"USD\",\n \"locale\": \"en_AU\",\n \"orderInfo\": \"b5f7f31d-9a4e-4c5c-a948-ab7642f8ece4\",\n \"returnUrl\": \"https://www.ecobank.com/unified\"\n },\n \"merchantDetails\": {\n \"accessCode\": \"31a95cc023dd35b88d4cad5e7f08fd9b\",\n \"merchantID\": \"902412B0-39DA-494A-9BDB-89DE3C10D38B\",\n \"secureSecret\": \"8c6509c21928433887afdacab29de9c55089cfad14304567a22544828e427e04c622a7010d7c4b5ab078f493b1be55de9637979a782d45b996ffe57dc41c2e9881b69b9141e142ea9329689de14b96ca0c4e6b9a5de043169b92e8a7fe6f2da2f4660b8fb19148beb4fdb6d909008a85225d5bf743a0477abed94ad73423f51d\"\n },\n \"secureHash\":\"1be4bf59f4917a306005fd8178b8ae9ac385b832a94b15c7a87945cf374edab099e9735379833a01053c33f0edae94ebd0ffa8beb5680871e78c3b7630582331\"\n}"},"url":"https://developer.ecobank.com/corporateapi/merchant/Signature"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Wed, 03 Nov 2021 18:31:39 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": \"BwZdR8Y2JtiCEfi/EkFWIQsKDhIjqe02OIt8SXbLJ7M=&2021-11-03T12:30:55Z\",\n \"response_timestamp\": \"2021-11-03T18:31:39.508\"\n}"}],"_postman_id":"b3dac31c-6d26-4a11-95ff-1baf479c416a"},{"name":"Merchant Category Code (MCC) ","id":"1477d818-bc34-4a04-96d1-e04ffccfb185","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

\n"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n"},{"key":"Accept","value":"application/json","type":"text","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n"},{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"123344\",\n \"affiliateCode\": \"EGH\",\n \"requestToken\": \"/4mZF42iofzo7BDu0YtbwY6swLwk46Z91xItybhYwQGFpaZNOpsznL/9fca5LkeV\",\n \"sourceCode\": \"ECOBANK_QR_API\",\n \"sourceChannelId\": \"KANZAN\",\n \"requestType\": \"CREATE_MERCHANT\"\n}"},"url":"https://developer.ecobank.com/corporateapi/merchant/getmcc","description":"

The endpoint allows the merchant to identify itself to the industry it belongs to. The Mcc code would be needed during merchant terminal creation.

\n","urlObject":{"path":["corporateapi","merchant","getmcc"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"b0ece334-fdea-48ac-9aaf-220036478110","name":"Merchant Category Code (MCC)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Origin","value":"developer.ecobank.com","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"123344\",\n \"affiliateCode\": \"EGH\",\n \"requestToken\": \"/4mZF42iofzo7BDu0YtbwY6swLwk46Z91xItybhYwQGFpaZNOpsznL/9fca5LkeV\",\n \"sourceCode\": \"ECOBANK_QR_API\",\n \"sourceChannelId\": \"KANZAN\",\n \"requestType\": \"CREATE_MERCHANT\"\n}"},"url":"https://developer.ecobank.com/corporateapi/merchant/getmcc"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Nov 2019 09:57:27 GMT"},{"key":"Content-Length","value":"49523"},{"key":"Content-Type","value":"application/json;charset=ISO-8859-1"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"headerRequest\": {\n \"requestId\": \"123344\",\n \"affiliateCode\": \"EGH\",\n \"requestToken\": \"/4mZF42iofzo7BDu0YtbwY6swLwk46Z91xItybhYwQGFpaZNOpsznL/9fca5LkeV\",\n \"sourceCode\": \"ECOBANK_QR_API\",\n \"sourceChannelId\": \"KANZAN\",\n \"requestType\": \"CREATE_MERCHANT\"\n },\n \"mcc\": [\n {\n \"mcc\": \"3354\",\n \"mccName\": \"Action Auto Rental\"\n },\n {\n \"mcc\": \"3441\",\n \"mccName\": \"Advantage Rent-A-Car\"\n },\n {\n \"mcc\": \"3420\",\n \"mccName\": \"Ansa International\"\n }\n ]\n}"}],"_postman_id":"1477d818-bc34-4a04-96d1-e04ffccfb185"},{"name":"Merchant Qr Creation","id":"4438a924-80a8-4650-8d85-4dff4e7a1b0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

\n"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n"},{"key":"Accept","value":"application/json","type":"text","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n"},{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"headerRequest\": {\r\n \"requestId\": \"\",\r\n \"affiliateCode\": \"EGH\",\r\n \"requestToken\": \"/4mZF42iofzo7BDu0YtbwY6swLwk46Z91xItybhYwQGFpaZNOpsznL/9fca5LkeV\",\r\n \"sourceCode\": \"ECOBANK_QR_API\",\r\n \"sourceChannelId\": \"KANZAN\",\r\n \"requestType\":\"CREATE_MERCHANT\"\r\n },\r\n \"merchantAddress\": \"123ERT\",\r\n \"merchantName\":\"UNIFIED SHOPPING CENTER\",\r\n \"accountNumber\": \"02002233444\",\r\n \"terminalName\": \"UNIFIED KIDS SHOPPING ARCADE\",\r\n \"mobileNumber\": \"0245293945\",\r\n \"email\": \"freemanst@gmail.com\",\r\n \"area\": \"Ridge\",\r\n \"city\": \"Ridge\",\r\n \"referralCode\": \"123456\",\r\n \"mcc\": \"0000\",\r\n \"dynamicQr\":\"Y\",\r\n \"callBackUrl\":\"http://koala.php\",\r\n \"secure_hash\":\"7f137705f4caa39dd691e771403430dd23d27aa53cefcb97217927312e77847bca6b8764f487ce5d1f6520fd7227e4d4c470c5d1e7455822c8ee95b10a0e9855\"\r\n}"},"url":"https://developer.ecobank.com/corporateapi/merchant/createqr","description":"

This endpoint allows merchants to register and be assigned a terminal to recieve Qr payments.

\n","urlObject":{"path":["corporateapi","merchant","createqr"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"0c28e861-3013-4922-93f3-7f82130060ba","name":"Merchant Qr Creation","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Origin","value":"developer.ecobank.com","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"headerRequest\": {\r\n \"requestId\": \"\",\r\n \"affiliateCode\": \"EGH\",\r\n \"requestToken\": \"/4mZF42iofzo7BDu0YtbwY6swLwk46Z91xItybhYwQGFpaZNOpsznL/9fca5LkeV\",\r\n \"sourceCode\": \"ECOBANK_QR_API\",\r\n \"sourceChannelId\": \"KANZAN\",\r\n \"requestType\":\"CREATE_MERCHANT\"\r\n },\r\n \"merchantAddress\": \"123ERT\",\r\n \"merchantName\":\"UNIFIED SHOPPING CENTER\",\r\n \"accountNumber\": \"02002233444\",\r\n \"terminalName\": \"UNIFIED KIDS SHOPPING ARCADE\",\r\n \"mobileNumber\": \"0245293945\",\r\n \"email\": \"freemanst@gmail.com\",\r\n \"area\": \"Ridge\",\r\n \"city\": \"Ridge\",\r\n \"referralCode\": \"123456\",\r\n \"mcc\": \"0000\",\r\n \"dynamicQr\":\"Y\",\r\n \"callBackUrl\":\"http://koala.php\",\r\n \"secure_hash\":\"7f137705f4caa39dd691e771403430dd23d27aa53cefcb97217927312e77847bca6b8764f487ce5d1f6520fd7227e4d4c470c5d1e7455822c8ee95b10a0e9855\"\r\n}"},"url":"https://developer.ecobank.com/corporateapi/merchant/createqr"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 15 Nov 2019 09:35:03 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": {\n \"headerResponse\": {\n \"affiliateCode\": \"EGH\",\n \"requestId\": \"\",\n \"responseCode\": \"000\",\n \"responseMessage\": \"Success\",\n \"sourceCode\": \"ECOBANK_QR_API\"\n },\n \"merchantCode\": \"603043343\",\n \"qrCodeBase64\": \"iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAAIyUlEQVR42u3dQW7jMBBEUd3/0pkrBIimu6r1PpCdA9sy+bQgKD4/klTS4xJIApYkAUsSsCQJWJIELEnAkiRgSRKwJAFLkoAlScCSBCxJApYkAUsSsCQJWJIELEnAkiRgSRKwJAFLkoAlScCSBCxJApYkAUsSsCQJWJKAJUnAkiRgSQKWJAFLkoAlCViSBKxff6jnifn77eebeN3We6S/79ZnmbhWSeMeWMACFrCABSxgAQtYwAIWsIAFLGABC1jAAtYhsBrfdwK2rcmQDlv6DeTyuAcWsIAFLGABC1jAAhawgAUsYAELWMACFrCAVQpW0upf42fZmnBJeG4BfeU3BxawgAUsYAELWMACFrCABSxgAQtYwAIWsIAFrLitNEmrk43Xbwunt39fYAELWMACFrCABSxgAQtYwAIWsIAFLGABC1jAAtZHt6okrZQmjVNgAQtYwAIWsIAFLGABC1jAAhawgAUsYAELWMCqBSv9fdMH9Nv/u4V20ncz7oEFLGABC1jAAhawgAUsPxywgAUsYAELWMACVgVYTn72ui++zsnPwAKW1wELWMDyOq8DFrCA5XXAAhawgOV1wAKWAld9kgZ00jOtkrZACVjAAhawgCVgAQtYwAIWsIAlYAELWMACVsWEm5hIb3+3t/+3EcDLJ0knnWBtlRBYwAIWsIAFLGABC1jAAhawgAUsYAELWMAC1qnnFjUeapH+vhMANq4S2poDLGABC1jAAhawgAUsYAELWMACFrCABSxgfRCsv1zordWrK1ta0p8ZlT6G3ICBBSxgAQtYwAIWsIAFLGABC1jAAhawgAUsYJ3HaWtVZQvFrW0aSaudSeNg6/O14wQsYAELWMACFrCABSxgAQtYwAIWsIAFLGABKwCxLRSTVpG2VjuTnvGUfp2TbgLAAhawgAUsYAELWMACFrCABSxgAQtYwAIWsI6DlbRlZOv7TnzmxvdNRyzphnkRNmABC1jAAhawgAUsYAELWMACFrCABSxgAQtY/3FANw4Ok3rmd9uamOljoz1gAQtYwAIWsIAFLGABC1jAAhawgAUsYAELWOUDdWJ1Mh3Fif9N34p0eVXZKiGwgAUsYAELWMACFrCABSxgAQtYwAIWsIB1HKyJi3rlUItGeLcmSNLzyZLGGrCABSxgAQtYwAIWsIAFLGABC1jAAhawgAWs42BtnZg8MRDStx1d+SwTN8LGk58nPguwgOWzAAtYwAIWsIAFLGABC1jAAhawfBZgAaugpNOWk1bSkk6w3vot3/6NJt4j/fRwYAELWMACFrCABSxgAQtYwAIWsIAFLGABC1jHwUpaQUnapuG5WXdOPW58LhqwgAUsYAELWMACFrCABSxgAQtYwAIWsIAFrAKwGk9+Tlpx+9q12vo9klZyL+IELGABC1jAAhawgAUsYAHLtQIWsIAFLGABC1gHVwm3Vg4nJs3WSlUSElfG30WcgAUsYAELWMACFrCABSxgAQtYwAIWsIAFLGAN/8BXXjfxv1urdUkobk30pOvn5GdgAQtYwAIWsIAFLGABC1jAAhawgAUsYAELWKe2r2yhMzHRtzC+ciPcGs9NAQtYwAIWsIAFLGABC1jAAhawgAUsYAELWMAaRsyzmzqvVePK69bN58vPyAIWsIAFLGABC1jAAhawgAUsYAELWMACFrCANbwKl75qljSwGg/YSN8mZIURWMACFrCABSxgAQtYwAIWsIAFLGABC1jAAtYpsLZ+zK3VxCQU01dUL99ogAUsYAELWMACFrCABSxgAQtYwAIWsIAFLGAB69RKSxIwjSulV7a+XD5xGljAAhawgAUsYAELWMACFrCABSxgAQtYwALWIbC2tks0blVJnzTpE6nx5pN00jWwgAUsYAELWMACFrCABSxgAQtYwAIWsIAFrAKwtiZw4xaPxoMLLl/Ty9uEgAUsYAELWMACFrCABSxgAQtYwAIWsIAFLGAVgLU1QZK2jKR/ty0QvjIxE29SwAIWsIAFLGABC1jAAhawgAUsYAELWMACFrBKwUo63ffyidPp2z4at6U0HqACLGABC1jAAhawgAUsYAELWMACFrCABSxgAes4WOmTsBHtCShtd3rWrrPnYQELWMACFrCABSxgAQtYwAIWsIAFLGABC1jAWp1I6YM8/XUTE2nrJpD0v1s3dGABC1jAAhawgAUsYAELWMACFrCABSxgAQtYx8GaGKjpz8hqXEnbgnxrHFzZAgUsYAELWMACFrCABSxgAQtYwAIWsIAFLGAB6zhYSVtu0k8BblwNS1/tTIJ36zMDC1jAAhawgAUsYAELWMACFrCABSxgAQtYwCoFK+k5Q1sTbmvwbgHduK0n6fptjTVgAQtYwAIWsIAFLGABC1jAAhawgAUsYAELWAVgxV+0I4Mt/ZTipJWvpK0vSSvDwAIWsIAFLGABC1jAAhawgAUsYAELWMACFrAKwLqyApW0Wpf+PVyXn0+v/gELWMACFrCABSxgAQtYwDIxXRdgAQtYwAIWsIbBSn/fxsMRtn6Py88nS7p+7c++AhawgAUsYAELWMACFrCABSxgAQtYwAIWsIA1DEf66bnpiCWBkH6YxpXToB1CASxgAQtYwAIWsIAFLGABC1jAAhawgAUsYAErDqykQy0ar0v6ylfSyc9fec4VsIAFLGABC1jAAhawgAUsYAELWMACFrCABSxgRZxM3bjlJukQj/QbA9iABSxgAQtYwAIWsIAFLGABC1jAAhawgAUsYI2B1Qhl+mrY1onT6bAlfd8r8w1YwAIWsIAFLGABC1jAAhawgAUsYAELWMAC1iJYV54zlD7hGrdzpG+lcfIzsIAFLGABC1jAAhawgAUsYAELWMACFrCABSxJApYkAUsSsCQJWJIELEnAkiRgSRKwJAFLkoAlScCSBCxJApYkAUsSsCQJWJIELEnAkiRgSRKwJAFLkoAlCViSBCxJApYkYEkSsCQJWJKAJUnAkiRgSQKWJAFLkoAlCViSBCxJApakW/0DmADZ39s8QusAAAAASUVORK5CYII=\",\n \"terminalId\": \"32631648\",\n \"terminalName\": \"UNIFIED KIDS SHOPPING ARCADE\",\n \"secretKey\": \"JG)kVCFPy*\"\n },\n \"response_timestamp\": \"2019-11-15T09:35:06.045\"\n}"}],"_postman_id":"4438a924-80a8-4650-8d85-4dff4e7a1b0e"},{"name":"Dynamic Qr Payment","id":"7c13b95e-5683-4854-b49a-9ce2a1c89a0f","protocolProfileBehavior":{"tlsDisabledProtocols":["TLSv1_2"],"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"

\n"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n"},{"key":"Accept","value":"application/json","type":"text","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n"},{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ec_terminal_id\": \"20207038\",\n \"ec_transaction_id\": \"we2209\",\n \"ec_amount\": 200,\n \"ec_charges\": \"0\",\n \"ec_fees_type\": \"P\",\n \"ec_ccy\": \"KES\",\n \"ec_payment_method\": \"QR\",\n \"ec_customer_id\": \"OK1337/09\",\n \"ec_customer_name\": \"DAVID AMUQUANDOH\",\n \"ec_mobile_no\": \"233260516997\",\n \"ec_email\": \"DAVYTHIT@GMAIL.COM\",\n \"ec_payment_description\": \"PAYMENT FOR JUMIA SHOPPING\",\n \"ec_product_code\": \"AEW23FSSS\",\n \"ec_product_name\": \"ONLINE SHOPPING 1212\",\n \"ec_transaction_date\": \"bnbbn\",\n \"ec_affiliate\": \"qwe123QE\",\n \"ec_country_code\": \"123\",\n \"secure_hash\": \"7f137705f4caa39dd691e771403430dd23d27aa53cefcb97217927312e77847bca6b8764f487ce5d1f6520fd7227e4d4c470c5d1e7455822c8ee95b10a0e9855\"\n}\n "},"url":"https://developer.ecobank.com/corporateapi/merchant/qr","description":"

Call to generate EcobankPay Dynamic Qr

\n","urlObject":{"path":["corporateapi","merchant","qr"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"9d17d06a-ad7a-40fa-ba5c-25409e836382","name":"Dynamic Qr Payment","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests. ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ec_terminal_id\": \"72528845\",\n \"ec_transaction_id\": \"we009\",\n \"ec_amount\": 200,\n \"ec_charges\": \"0\",\n \"ec_fees_type\": \"P\",\n \"ec_ccy\": \"KES\",\n \"ec_payment_method\": \"QR\",\n \"ec_customer_id\": \"OK1337/09\",\n \"ec_customer_name\": \"DAVID AMUQUANDOH\",\n \"ec_mobile_no\": \"233260516997\",\n \"ec_email\": \"DAVYTHIT@GMAIL.COM\",\n \"ec_payment_description\": \"PAYMENT FOR JUMIA SHOPPING\",\n \"ec_product_code\": \"AEW23FSSS\",\n \"ec_product_name\": \"ONLINE SHOPPING 1212\",\n \"ec_transaction_date\": \"bnbbn\",\n \"ec_affiliate\": \"qwe123QE\",\n \"ec_country_code\": \"123\",\n \"secure_hash\": \"7f137705f4caa39dd691e771403430dd23d27aa53cefcb97217927312e77847bca6b8764f487ce5d1f6520fd7227e4d4c470c5d1e7455822c8ee95b10a0e9855\"\n}"},"url":"https://developer.ecobank.com/corporateapi/merchant/qr"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Oct 2019 12:33:39 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, OPTIONS, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_error\": \"\",\n \"response_status\": \"success\",\n \"response_content\": {\n \"dynamicQRBase64\": \"iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAAI2ElEQVR42u3dUa7bOBREQe9/08kWAoTi7b6sA8yfXmxLZGkAQuLvjySV9HMKJAFLkoAlCViSBCxJApYkYEkSsCQJWJKAJUnAkiRgSQKWJAFLkoAlCViSBCxJApYkYEkSsCQJWJKAJUnAkiRgSQKWJAFLkoAlCViSBCxJwJIkYEkSsCQBS5KAJUnAkgQsSQLWP3+p3y/mv9O/439+7+nPmLpGjeMqaRykj3tgAQtYwAIWsIAFLGABC1jAAhawgAUsYAELWAVgJX3ulgGT9Lmnz1US5FvGPbCABSxgAQtYwAIWsIAFLGABC1jAAhawgAWs5WBNDfIbE/PGuUrHaQrAqTG0ZdwDC1jAAhawgAUsYAELWMACFrCABSxgAQtYwALWJ5/r/GUBfeMaJY0/YAELWMACFrCABSxgAQtYwAIWsIAFLGABC1jAqr1w6Y/1pK/CnT7Pm68RsIBlMgALWMACFrCABSxgAQtYwAIWsIAFLGAB6xOwkqC8sWLUiF36b0sak96HBSxgAQtYwAIWsIAFLGABC1jAAhawgAUsYAHr2glsnMCOc9wXNzg7PwMLWI4DFrCA5TjHAQtYwHIcsIAFLBPJccAC1vqSVg5v3BiSVqWmQLhxjQQsYAELWMACFrCABSxgAQtYwBKwgAUsYAHrk8mfNNjS30GVPtHT34eVNDamjgMWsIAFLGABC1jAAhawgAUsYAELWMACFrCAtXyVsHHSJL3fKP1xk6nflrRBSfrYABawgAUsYAELWMACFrCABSxgAQtYwAIWsIC1HKypAZ2+OULj+5c27+J9+txvhAhYwAIWsIAFLGABC1jAAhawgAUsYAELWMAC1kKcbqzwJO0gnP6Yy9R4aUQHWMACFrCABSxgAQtYwAIWsIAFLGABC1jAAhawPpmYjY9pNG7KcPrf24Js0o0QWMACFrCABSxgAQtYwAIWsIAFLGABC1jAAhawRjG5MVC3TJAbSEyBtQUTYAELWMACFrCABSxgAQtYwAIWsIAFLGABC1jAGh28U4MofVJPbUyR/t6xqWu+ZUMMYAELWMACFrCABSxgAQtYwAIWsIAFLGABC1iLcDr9t1OreumDN31FNf1xohtjw87PwAIWsIAFLGABC1jAAhawgAUsYAELWMAC1oNgNQ7o9MExhfFrQN/AfeNjOMACFrCABSxgAQtYwAIWsIAFLGABC1jAAhawLgMzNbBuTLgtxzWe+/S/TbrRAAtYwAIWsIAFLGABC1jAAhawgAUsYAELWMAqAGtq8Dau4N24MSTtBp2EU9KO2FNjCFjAAhawgAUsYAELWMACFrCABSxgAQtYwAJWKVivPSKT/s6jpPOcBEfSe9GABSxgAQtYwAIWsIAFLGABC1jAAhawgAUsYAErblA2rtw07tTcCGX6+AMWsIAFLGABC1jAAhawgAUsYAELWMACFrCABaxPJvrmnYYbV5vSN2qY+n5JN29gAQtYwAIWsIAFLGABC1jAAhawgAUsYAELWIvAatyAoXHFLQmEJKCnbpjpj2MBC1jAAhawgAUsYAELWMACFrCABSxgAQtYwCoFawrA9H9vy2MujatmW3a6bkcMWMACFrCABSxgAQtYwAIWsIAFLGABC1jAAtaH6DTuPvzad0lCNumRoPTVYmABC1jAAhawgAUsYAELWMACFrCABSxgAQtYVglHV2mSNgvYvOp4A44b3znpJu99WMACFrCABSxgAQtYwAIWsIAFLGABC1jAAtZysJLev3T639vyuVvwnLoRJr3HrOp/PoAFLGABC1jAAhawgAUsYAELWMACFrCABSxg3V3dmHokY8sqYdL1nULxtfEHLGABC1jAAhawgAUsYAELWMACFrCABSxgAcsqYcUqYfrqVdJmBpsfkUm6oQMLWMACFrCABSxgAQtYwAIWsIAFLGABC1jAAlbFhJsagDfO1ZaJNAXvFLLehwUsYAELWMACFrCABSxgAQtYwAIWsIAFLGABaxS7KRCSBvTpz5iaSFtWE7fclIEFLGABC1jAAhawgAUsYAELWMACFrCABSxgFaAzNdis3MzdGE5/xpaNQl5BDFjAAhawgAUsYAELWMACFrCABSxgAQtYwALWwom0ZZfipAmc9LdTN6nT4zlp/AELWMACFrCABSxgAQtYwAIWsIAFLGABC1jAKoBoajOIpM0qklaR0le+tly3G/MIWMACFrCABSxgAQtYwAIWsIAFLGABC1jAAtZysE5fpKkB3Xheks5p4w7bxiSwgAUsYAELWMACFrCABSxgAcuYBJbBASxgAaticiU9NpO0ocON35b0KEgSTlO7S0+dF2ABC1jAAhawgAUsYAELWMACFrCABSxgAQtYBWAlPbqRvto0hWzju8PS381lYwpgAQtYwAIWsIAFLGABC1jAAhawgAUsYAELWE82tdNw+rugGtFJ+n43bkjAAhawgAUsYAELWMACFrCABSxgAQtYwAIWsB4Eq3Hyp8PRiGLS+7AaH+/yaA6wgAUsYAELWMACFrCABSxgAQtYwAIWsIAFrNETnf6eps3nJQnjLe//2rgxBbCABSxgAcvEBBawgAUsYAELWMACFrCABSxgBVyQpBW8xom0+TvfQLbxES1gAQtYwAIWsIAFLGABC1jAAhawgAUsYAELWMCqfWdU487ASQM/6fem70LdHrCABSxgAQtYwAIWsIAFLGABC1jAAhawgAWsR8C68f1Of0bj5gjpG0403ghtQgEsYAELWMACFrCABSxgAQtYwAIWsIAFLGABq2K1qfG4dNg2/47T38UqIbCABSxgAQtYwPI7gAUsYAELWMACFrCABSxg/fcATNr52epQ50pu+jh9GTFgAQtYwAIWsIAFLGABC1jAAhawgAUsYAELWJIELEnAkiRgSRKwJAFLkoAlScCSBCxJApYkAUsSsCQJWJIELEnAkiRgSRKwJAFLkoAlScCSBCxJApYkAUsSsCQJWJKA5RRIApYkAUsSsCQJWJIELEnAkiRgSRKwJAFLkoAlScCSBCxJSugvOU+u/Fp1rqQAAAAASUVORK5CYII=\",\n \"dynamicQR\": \"00020101021202134729202421897041553263210106426952045416530340454032005802KE5912IPAY LIMITED6007NAIROBI62250308725288450509ECDYwe009630488BF\",\n \"successURL\": \"https://dev-ci-pda.gutotal.com/pda/masterpass/api/call-callback\",\n \"failedURL\": \"http://demo.albouritech.com/ecopaydemo/callback\",\n \"responseCode\": \"000\",\n \"responseMessage\": \"Success\",\n \"transactionAmount\": \"200\",\n \"transactionDescription\": \"PAYMENT FOR JUMIA SHOPPING\"\n },\n \"response_info\": \"Request was successful\",\n \"response_time\": \"25-10-2019 13:33:39\"\n}"}],"_postman_id":"7c13b95e-5683-4854-b49a-9ce2a1c89a0f"},{"name":"AddQR Terminal","id":"8b524a83-f8d3-4d2b-a5eb-6fbc6095afa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"12142WER312\",\n \"affiliateCode\": \"EGH\",\n \"merchantCode\": \"834781258\",\n \"terminalMobileNo\": \"0237321956\",\n \"terminalName\": \"EGH Ghana PLC\",\n \"terminalEmail\": \"afuam@gamil.com\",\n \"productCode\": \"100321\",\n \"secureHash\": \"7eba5d132a171ceced6989b7da216deed09d6a74937db0d9ba56df206641311ee551e2373898f675f8924bcd81b941d74b652049bcc25babfdb6ce5cb0f584b1\"\n\n}\n","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/createaddQr","description":"

This endpoint allows merchants to add additional QR terminal to the same merchant account to receive payments.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	Sample Value
requestId	Alphanumeric	15	M	This field identifies the request ID provisioned for the merchant	e.g ECO21341245
affiliateCode	String	3	M	Affiliate code of which the account and client has been maintained	(3 letters) e.g., EGH
merchantCode	Alphanumeric	15	M	Terminal code assigned to the merchant prior going live	e.g., 834781258
terminalMobileNo	Numeric	15	M	Terminal mobile number assigned to client’s profile	e.g., 0237321956
terminalName	String	50	M	This parameter depicts the name that has been created for merchant	e.g. EGH Ghana PLC)
terminalEmail	Alphanumeric	M	15	Email address created for client	afuam@gamil.com
productCode	Alphanumeric	M	10	Terminal code assigned to the merchant prior going live Max 10 characters	(e.g. 100321)
secureHash	Alphanumeric	M	128	Click on link to get details on how to generate secureHash. Link	128 length characters

","urlObject":{"path":["corporateapi","merchant","createaddQr"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"1a54f938-e780-42cb-af7e-ac366ba7b382","name":"AddQR Terminal","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.","type":"text"},{"key":"Accept","value":"application/json","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.","type":"text"},{"key":"Content-Type","value":"application/json","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"12142WER312\",\n \"affiliateCode\": \"EGH\",\n \"merchantCode\": \"834781258\",\n \"terminalMobileNo\": \"0237321956\",\n \"terminalName\": \"EGH Ghana PLC\",\n \"terminalEmail\": \"afuam@gamil.com\",\n \"productCode\": \"100321\",\n \"secureHash\": \"7eba5d132a171ceced6989b7da216deed09d6a74937db0d9ba56df206641311ee551e2373898f675f8924bcd81b941d74b652049bcc25babfdb6ce5cb0f584b1\"\n\n}\n","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/createaddQr"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Mon, 26 Sep 2022 17:29:42 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": {\n \"merchantId\": \"834781258\",\n \"qrBase64String\": \"iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAAJgElEQVR42u3dW27bQBBEUe1/08kaDE1X14zOBfJlQ5Yo8jBovj7/JOmSPhaBJGBJErAkAUuSgCVJwJIELEkCliQBSxKwJAlYkgQsScCSJGBJErAkAUuSgCVJwJIELEkCliQBSxKwJAlYkgQsScCSJGBJErAkAUuSgCUJWJIELEkCliRgSRKwJAlYkoAlScCSJGBJApYkAUuSgCUJWJIELEl6GKzP5xP999f3c/r3//r5Ty/f0593+vW3l/f030uv38ACFrCABSxgAQtYwAIWsIAFLGABa2aD2t5g2zb424H+dvmmN+j08m3bfoAFLGABC1jAAhawgAUsYAELWMAC1swKOz003QZpe+iefv3tHdL072+v38ACFrCABSxgAQtYwAIWsIAFLGAB6w6wtk/US7+/9PI+PbRuO8jQtryBBSxgAQtYwAIWsIAFLGABC1jAAtZvDN23N9jbT8xsA//b10sflAAWsIAFLGABC1jAAhawgAUsYAELWHeCld5g2z7v9oml20PstiH/bes3sIAFLGABC1jAAhawgAUsYAELWMCaWeDpIa+f+3nTiaEeQgEsG4yfAwtYwPJzPwcWsIDl58ACliYAnR7y33YDv9sOopw+CCBgAQtYwAKWgAUsYAELWMAClt4EKz1Uv23omX6Q6vaDW9MP/bhth/YamMACFrCABSxgAQtYwAIWsIAFLGD9ytC77YZnbStk24Ngp3dA6e8zfZDkNcCABSxgAQtYwAIWsIAFLGABC1jAehWobwFovyFb2wq+fUO89gfNTr9/Q3dgAQtYwAIWsIAFLGABC1jAAhawOsFKf6G3b4CvfZ72E3NPL4/T7xdYwAIWsIAFLGABC1jAAhawgAUsYHUO3beHmOkb7G2feNm2PLdP7ExfTG3oDixgAQtYwAIWsIAFLGABC1jAAtYdQ/i2IX77xdnbgLRfnNx2EGf6+wQWsIAFLGABC1jAAhawgAUsYAELWGdWuNcesrB9Q7zbVvj2i62n1+9fC1jAAhawgAUsYAELWMACFrCABaxXwNoe8t+2Ab12ImUalPT6dNv2AixgAQtYwAIWsIAFLGABC1jAAhawdk7kax+ypi+OTb9+enmnD6Jsvz6wgAUsYAELWMACFrCABSxgAQtYwNoZgrcPnduGqLdt0L92g8DXHuwLLGABC1jAAhawgAUsYAELWMAC1qtgpW+gd/r9pG8g1/bQi/T3e9v3P/35rv8PCrCABSxgAQtYwAIWsIAFLGABC1iPgtV+YuP2Cr29AW4P/dPr3/YOD1jAAhawgAUsYAELWMACFrCABSxg7YCVPrExDdo22O0ndt520GL7H7CABSxgAQtYwAIWsIAFLGABC1jAugO07ddvf9Bp2w0M2z5P+vWmtw9gAQtYwAIWsIAFLGABC1jAAhawgNUJ2DRA6dc//X7ahvLpHUA7eNs7NGABC1jAAhawgAUsYAELWMACFrCAlRnapk8MnF7h2kDcBnT7oIQhObCABSxgAQtYwAIWsIAFLGABC1jAahjStg090+//9ot1p3co7f+ABSxgAQtYwAIWsIAFLGABC1jAAtadYE0DcXoD2l4+bSd6bgM3vX60rf/AAhawgAUsYAELWMACFrCABSxgASsDRvvPp5fP6d8/PdTeftBp+kGxp9//a0ABC1jAAhawgAUsYAELWMACFrCA9SpY3/7+9N9vG5K2D/XbLxZvXx+ABSxgAQtYwAIWsIAFLGABC1jAAtYdYJ0eum5ffNr2kIm25bF9cfuvXUwOLGABC1jAAhawgAUsYAELWMACFrA6N9jpoej2iYG3bfDTyzc9FL/9IA6wgAUsYAELWMACFrCABSxgAQtYwMps8O1D/WnQ0zuUth1U2/rV9iBZYAELWMACFrCABSxgAQtYwAIWsIDVAdj2kPw2cLfBSd9QsW2HAyxgAQtYwAIWsIAFLGABC1jAAhaw7gApvQG8NiRue/Dq9vvZPpG17SAKsIAFLGABC1jAAhawgAUsYAELWMDKDNnTX/Drr99+8fD00LntIRjTyxdYwAIWsIAFLGABC1jAAhawgAUsYHWANb1CbT+49eceUlB2sXkaLA+hABawgAUsYAELWMACFrCABSxgAeuNFXJ6yLr9EIHpFTT9+douLt4eqrv4GVjAAhawgAUsYAELWMACFrCABaw3hqzbQ8o2sNqH7u0n2rY9aPfb7xtYwAIWsIAFLGABC1jAAhawgAUsYN2xgrefCJoe4p9+f+kHj7r4+ez7BxawgAUsYAELWMACFrCABSxgAQtYnUP49AaZ/jzpIXfbDqANxPSDcg3dgQUsYAELWMACFrCABSxgAQtYwLoTqPQGsf3+00P29JB6+u9Pg5d+v8ACFrCABSxgAQtYwAIWsIAFLGABaweo9iHubQBtHxS4bYeyvcNy8TOwgAUsYAELWMACFrCABSxgAQtYb9Y2FE8PjdPgtV0M3HaDRhc/AwtYwAIWsIAFLGABC1jAAhawgPUmWOmLXdsuhp7+fLcNuaeH1O0XP5/eAQALWMACFrCABSxgAQtYwAIWsIAFrA7A2t5f+4mm6aHz9omX6YMSp9eX1wEDFrCABSxgAQtYwAIWsIAFLGAB69Vuuxg1/ffTG2zbDe3SJ76+fhAIWMACFrCABSxgAQtYwAIWsIAFLGDdAeD2BrB9kCAN0PZQP/35XPwsYAELWMACFrCABSxgAQtYwALWnWCkh5LTG1QbOO1D6vT6sw2aB6kCC1jAAhawgAUsYAELWMACFrCA9cbQ+7bXP73BtN2Qb3qHs71DaDto8XrAAhawgAUsYAELWMACFrCABSxgvQJW24M/f/0Gc+mLcV87MffXL3YGFrCABSxgAQtYwAIWsIAFLGABC1gZsLY///ZQd/v7eu2gyq8HLGABC1jAAhawgAUsYAELWMACFrA6h+Db73/685x+/+0P1dgG1w38gAUsYAELWMACFrCABSxgAQtYwOoAaxvEbzeQ7aF72xD+ttdrPwhg6A4sYAELWMACFrCABSxgAQtYwALWDljtD6HYfr30DfHaH7zadhBj+vt9LWABC1jAAhawgAUsYAELWMACFrAkCViSBCxJwJIkYEkSsCQBS5KAJUnAkgQsSQKWJAFLErAkCViSBCxJwJIkYEkSsCQBS5KAJUnAkgQsSQKWJAFLErAkCViSgGURSAKWJAFLErAkCViSBCxJwJIkYEkSsCQBS5KAJUnAkgQsSQKWJAFLErAkCViSBCxJD/UflLNEpzDBetcAAAAASUVORK5CYII=\\\",\",\n \"terminalId\": \"32623319\",\n \"terminalName\": \"EGH Ghana PLC\",\n \"headerResponse\": {\n \"affiliateCode\": \"EGH\",\n \"requestId\": \"12142WER312\",\n \"responseCode\": \"000\",\n \"responseMessage\": \"Success\",\n \"sourceCode\": \"COPORATE_API\"\n }\n },\n \"response_timestamp\": \"2022-09-26T17:29:43.013\"\n}"}],"_postman_id":"8b524a83-f8d3-4d2b-a5eb-6fbc6095afa2"}],"id":"271d50de-5110-4e68-8e5d-db9efcd08910","description":"

Overview

Collection microservice has functionalities that will allow Ecobank to accept payments from your customers through the means of your choosing. eg.(Portal integration, Mobile App, POS, Web App etc.)
On our sandbox you are able to very quickly generate a REST API on top of our collections microservice, therefore allowing you to explore it within Postman.

Setup

Ensure you have the acquired the appropriate credential to make requests to Unified Developer LAB API.

To generate a secure Hash for your request payload a lab_key is required.
lab_key sample:

    XT7zuounWNKXmbwdAR+qYhyQymRdsEUylXFZ/frwBBjDKZsPCDlUjAMH4OQT+uvU\n\n

Requirement to successfully generate a secure hash:

lab_key is the key shared after onboarding
\n
payload is the concatenation of field values in your JSON request from top down as a single string.
PS: For the Payment section the payload should only be made up of field values in the header section of your JSON request.
\n
SHAR-512 is your algorithm for one-way hashing
\n

Hashing can be done with any language of preference, below is a sample JAVA code for hashing:

    private static final String LAB_KEY =\"XT7zuounWNKXmbwdAR+qYhyQymRdsEUylXFZ/frwBBjDKZsPCDlUjAMH4OQT+uvU\";\n    public static String Hash512Msg(String payload) {\n      String result;\n        try {\n            String data = payload + lab_key;\n            MessageDigest digest = MessageDigest.getInstance(\"SHA-512\");\n            // ** NOTE all bytes that are retrieved from the data string must be done so using UTF-8 Character Set.\n            byte[] hashBytes = (data).getBytes(\"UTF-8\");\n            //Create the hash bytes from the data\n            byte[] messageDigest = digest.digest(hashBytes);\n            //Create a HEX string from the hashed data\n            StringBuilder sb = new StringBuilder();\n            for (int i = 0; i < messageDigest.length; i++) {\n                String h = Integer.toHexString(0xFF & messageDigest[i]);\n                while (h.length() < 2) {\n                    h = \"0\" + h;\n                }\n                sb.append(h);\n            }\n            result = sb.toString();\n        } catch (Exception ex) {\n            //Log your errors;\n        }\n        //sample result :2611e1ad3a8077020c55a227408329f0b2bb4f00c0e409a93abd69dba133c5d5a7d7575fef87cb13a9d5319c2f78199d8e674ce6f7d63acea95ae5a214ad9f5a\n        return result;\n    }\n\n

Fire up request payload with secure hash value for integrity check:

 {    ....,\n    \"secureHash\":\"2611e1ad3a8077020c55a227408329f0b2bb4f00c0e409a93abd69dba133c5d5a7d7575fef87cb13a9d5319c2f78199d8e674ce6f7d63acea95ae5a214ad9f5a\"\n}\n\n

HTML. FORM URL

https://developer.ecobank.com/CBSWebSandbox/

Ensure your user has the correct permissions to access the collection service requested.

Now you're ready to run this collection in Postman!

\n","event":[{"listen":"prerequest","script":{"id":"9a9e7f65-048e-46cd-9f36-36b09e72422e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7fd11f3c-c6ed-4a58-b6ca-6fe449a88b7e","type":"text/javascript","exec":[""]}}],"_postman_id":"271d50de-5110-4e68-8e5d-db9efcd08910"},{"name":"Remittance","item":[{"name":"Cross-Border Ecobank-To-Ecobank","id":"e09e0d02-72a6-413f-88f0-b3cbb5b1f7a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

The API helps customers to initiate cross-border transactions.

Payment Header

This is a standard header for all payment request types. For test purposes, each of the parameter values in the header remains the same. This is to aid users get familiarize with request and response payloads.

The payment payload accommodates single and batch posting. The extension in the request payload determines the request type inter-bank being call for transaction posting. For test purposes, each of the parameter values remains the same. This is to aid users get familiarize with request and response payload

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
clientid	string	15	M	Client ID is used to identify each customer. Testing value is EGHTelc000043 and its static value for testing.	EGHTelc000043
batchsequence	string	1	M	Batch Sequence is used to identified batches per transaction e.g. (1 of 1, 2 of 1, 3 of 1).	1,2,3
batchamount	BigDecimal	NUMBER (22,2)	M	Batch Amount is the total amount of all individual request in a batch.	NUMBER (22,2)
transactionamount	BigDecimal	NUMBER (22,2)	M	Transaction Amount this is to total amount of all the batches amount in a transaction.	NUMBER (22,2)
batchid	string	15	M	Multiple transaction batches can be created but each batch will be identified by its BatchID. Customer to define the BatchID which is alphanumeric	EG15934CV
transactioncount	BigDecimal	Dependent on the total number of transactions sent	M	Transaction Count, this is the total number of all the individual transactions in the request	4,5,6
batchcount	string	200	M	Batch Count is the total of all individual request in this batch and will contain maximum of two hundred (200) per a batch.	4,5,6
transactionid	string	15	M	Transaction ID, this is a unique id that identifies the transaction.	E12T4433X4
debittype	Alphanumeric	8 - (Multiple)	M	This determines how customer’s account will be debited. Single debit for all transaction or debit for each transaction. For now, default value is Multiple.	Multiple
affiliateCode	Alphanumeric	3	M	Ecobank country where customer account is held. Sandbox value is EGH. In live Ecobank will provide the value for each country	Ghana (EGH), Nigeria (ENG), Togo (ETG), Senegal (ESN), etc.
totalbatches	Numeric	1 or 2	M	We have a concept of creating multiple batches of transactions but linking them together as same set of transaction using the same batchID hence if the batches of transaction were sent with the same batchID then totalbaches will be 2 else keep it always 1.	1,2
execution_date	Datetime	23	M	This is date of transactions. It cannot be back date. Only current or future date	YYYYMMDDHHmmss e.g., 2023-02-27T18:48:51.113

Extension parameter list

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
request_id	string	15	M	A unique reference assign to transaction. This is unique to each transaction.	2323V
request_type	string	15	M	This identifies the payment type that is been sent for posting	ECOBANKAFRICA
receiverLastName	string	50	M		Kasumu
sourceCountry	string	2	M	Source country	NG
senderNationality	string	2	M	Nationality of the sender	Fr, Gh, etc
senderPhoneNumber	Number	20	M	Phone number of the sender	07066690519
destinationBank	string	20	M	Destination bank	NG
purpose	string	50	M	Purpose of the transaction	Travel
receiverCcy	string	3	M	Currency of the receiving country	USD
receiverIdNumber	Number	20	M	Phone number of the receiver	jdhdh54123
senderIdNumber	Number	20	M	Phone number of the sender	jacobh54123
senderCcy	string	3	M	Currency of the sender country	GHS
senderGender	string	1	M	Gender of the sender (Male - M or Female- F)	M or F
sourceBank	string	2	M	Source bank code	GH
exchangeRate	string		M	Ecobank commercial rates	9.5
receiverFirstName	string	20	M	Receiver first name	Gaffar
senderLastName	string	20	M	Sender first name	Oladimeji
receiverResidentialAddress	string	50	M	Receiver residential address	8, Accra Level
receiverIdType	string	20	M	Receiver Identification type	passport
receiverIdExpiryDate	string	10	M	Receiver Identification Expiry date	09/20/2022
product	string	10	M	This is a static value as “ACCOUNT”	ACCOUNT
senderIdType	string	20	M	Receiver Identification type of the sender	passport
receiverDOB	string	10	M	Receiver date of birth	9/20/1999
receiverPhoneNumber	string	20	M	Receiver phone number	08066689079
senderDOB	string	20	M	Sender phone number	09/20/2080
senderFirstName	string	20	M	Sender’s first name	James
receiverNationality	string	2	M	Receiver nationality code	NG
destinationAccountNumber	string	20	M	Destination account number	0012057660
destinationCountry	string	2	M	Destination country	NG
narration	string	50	M	Transaction narration	Test Transaction
senderResidentialAddress	string	50	M	Sender’s residential address	4, Iganmu Road
senderIdExpiryDate	string	10	M	Sender’s Identification expiry date	09/20/2022
amount	amount	NUMBER(22,2)	M	Amount	NUMBER (22,2)
currency	string	3	M	Debit account currency	USD, GHS, etc.
status	string	3	O	This field should be null or NEW	NEW
rate_type	string	4	M	This is a static value as sport	Spot (static value)
secureHash	string	129	M	SHA 512 hashing algorithm = (clientid+batchsequence+batchamount+transactionamount+ batchid+ transactioncount+ batchcount+ transactionid+ debittype+ affiliateCode+ totalbatches+ execution_date+labkey)	Sample provided in request payload

","urlObject":{"path":["corporateapi","merchant","payment"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"49deab2a-c3db-43cd-a5e9-3ceece64d3b2","name":"Inter-affiliate book transfer","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests. ","type":"text"},{"key":"Accept","value":"application/json","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.","type":"text"},{"key":"Content-Type","value":"application/json","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paymentHeader\": {\n \"clientid\": \"EGHTelc000043\",\n \"batchsequence\": \"1\",\n \"batchamount\": 520,\n \"transactionamount\": 520,\n \"batchid\": \"EG1593490\",\n \"transactioncount\": 6,\n \"batchcount\": 6,\n \"transactionid\": \"E12T443308\",\n \"debittype\": \"Multiple\",\n \"affiliateCode\": \"EGH\",\n \"totalbatches\": \"1\",\n \"execution_date\": \"2020-06-01 00:00:00\"\n },\n \"extension\": [\n {\n \"request_id\": \"20000000QW4\",\n \"request_type\": \"ECOBANKAFRICA\",\n \"param_list\": \"[{\\\"key\\\":\\\"receiverLastName\\\", \\\"value\\\":\\\"Kasumu\\\"},{\\\"key\\\":\\\"sourceCountry\\\", \\\"value\\\":\\\"GH\\\"},{\\\"key\\\":\\\"senderNationality\\\", \\\"value\\\":\\\"Fr\\\"},{\\\"key\\\":\\\"senderPhoneNumber\\\", \\\"value\\\":\\\"07066690519\\\"},{\\\"key\\\":\\\"destinationBank\\\", \\\"value\\\":\\\"NG\\\"},{\\\"key\\\":\\\"purpose\\\", \\\"value\\\":\\\"Travel\\\"},{\\\"key\\\":\\\"receiverCcy\\\", \\\"value\\\":\\\"USD\\\"},{\\\"key\\\":\\\"receiverIdNumber\\\", \\\"value\\\":\\\"jdhdh54123\\\"},{\\\"key\\\":\\\"senderIdNumber\\\", \\\"value\\\":\\\"jacobh54123\\\"},{\\\"key\\\":\\\"senderCcy\\\", \\\"value\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"senderGender\\\", \\\"value\\\":\\\"M\\\"},{\\\"key\\\":\\\"sourceBank\\\", \\\"value\\\":\\\"GH\\\"},{\\\"key\\\":\\\"exchangeRate\\\", \\\"value\\\":\\\"9.5\\\"},{\\\"key\\\":\\\"receiverFirstName\\\", \\\"value\\\":\\\"Gaffar\\\"},{\\\"key\\\":\\\"senderLastName\\\", \\\"value\\\":\\\"Oladimeji\\\"},{\\\"key\\\":\\\"receiverResidentialAddress\\\", \\\"value\\\":\\\"8, Accra Level\\\"},{\\\"key\\\":\\\"receiverIdType\\\", \\\"value\\\":\\\"passport\\\"},{\\\"key\\\":\\\"receiverIdExpiryDate\\\", \\\"value\\\":\\\"09/20/2023\\\"},{\\\"key\\\":\\\"product\\\", \\\"value\\\":\\\"ACCOUNT\\\"},{\\\"key\\\":\\\"senderIdType\\\", \\\"value\\\":\\\"passport\\\"},{\\\"key\\\":\\\"receiverDOB\\\", \\\"value\\\":\\\"9/20/1999\\\"},{\\\"key\\\":\\\"receiverPhoneNumber\\\", \\\"value\\\":\\\"08066689079\\\"},{\\\"key\\\":\\\"senderDOB\\\", \\\"value\\\":\\\"09/20/2080\\\"},{\\\"key\\\":\\\"senderFirstName\\\", \\\"value\\\":\\\"James\\\"},{\\\"key\\\":\\\"receiverNationality\\\", \\\"value\\\":\\\"NG\\\"},{\\\"key\\\":\\\"destinationAccountNumber\\\", \\\"value\\\":\\\"0012057660\\\"},{\\\"key\\\":\\\"destinationCountry\\\", \\\"value\\\":\\\"NG\\\"},{\\\"key\\\":\\\"narration\\\", \\\"value\\\":\\\"Test Transaction\\\"},{\\\"key\\\":\\\"senderResidentialAddress\\\", \\\"value\\\":\\\"4, Iganmu Road\\\"},{\\\"key\\\":\\\"senderIdExpiryDate\\\", \\\"value\\\":\\\"09/20/2023\\\"}]\",\n \"amount\": 520,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n }\n ],\n \"secureHash\": \"398d4f285cc33e12f035da19fa9d954be35afaf66816531c4f1a1aedd3c6f132a85c62b23ca12d7b9a99bf5a84fc69b66738289a70e8f8115e90ffaa060f4026\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Fri, 14 Apr 2023 17:25:18 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": \"Request received successfully\",\n \"response_timestamp\": \"2023-04-14T17:25:18.577\"\n}"}],"_postman_id":"e09e0d02-72a6-413f-88f0-b3cbb5b1f7a1"},{"name":"Cross-Border Interbank Payment","id":"1a52ef59-735d-426b-b01c-b962d1dc5249","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

The API helps customers to initiate cross-border transactions.

Payment Header

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
clientid	string	15	M	Client ID is used to identify each customer. Testing value is EGHTelc000043 and its static value for testing.	EGHTelc000043
batchsequence	string	1	M	Batch Sequence is used to identified batches per transaction e.g. (1 of 1, 2 of 1, 3 of 1).	1,2,3
batchamount	BigDecimal	NUMBER (22,2)	M	Batch Amount is the total amount of all individual request in a batch.	NUMBER (22,2)
transactionamount	BigDecimal	NUMBER (22,2)	M	Transaction Amount this is to total amount of all the batches amount in a transaction.	NUMBER (22,2)
batchid	string	15	M	Multiple transaction batches can be created but each batch will be identified by its BatchID. Customer to define the BatchID which is alphanumeric	EG15934CV
transactioncount	BigDecimal	Dependent on the total number of transactions sent	M	Transaction Count, this is the total number of all the individual transactions in the request	4,5,6
batchcount	string	200	M	Batch Count is the total of all individual request in this batch and will contain maximum of two hundred (200) per a batch.	4,5,6
transactionid	string	15	M	Transaction ID, this is a unique id that identifies the transaction.	E12T4433X4
debittype	Alphanumeric	8 - (Multiple)	M	This determines how customer’s account will be debited. Single debit for all transaction or debit for each transaction. For now, default value is Multiple.	Multiple
affiliateCode	Alphanumeric	3	M	Ecobank country where customer account is held. Sandbox value is EGH. In live Ecobank will provide the value for each country	Ghana (EGH), Nigeria (ENG), Togo (ETG), Senegal (ESN), etc.
totalbatches	Numeric	1 or 2	M	We have a concept of creating multiple batches of transactions but linking them together as same set of transaction using the same batchID hence if the batches of transaction were sent with the same batchID then totalbaches will be 2 else keep it always 1.	1,2
execution_date	Datetime	23	M	This is date of transactions. It cannot be back date. Only current or future date	YYYYMMDDHHmmss e.g., 2023-02-27T18:48:51.113

Extension parameter list

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
request_id	string	15	M	A unique reference assign to transaction. This is unique to each transaction.	2323V
request_type	string	15	M	This identifies the payment type that is been sent for posting	ECOBANKAFRICA
receiverLastName	string	50	M		Kasumu
sourceCountry	string	2	M	Source country	NG
senderNationality	string	2	M	Nationality of the sender	Fr, Gh, etc
senderPhoneNumber	Number	20	M	Phone number of the sender	07066690519
destinationBank	string	20	M	Destination bank	NG
purpose	string	50	M	Purpose of the transaction	Travel
receiverCcy	string	3	M	Currency of the receiving country	USD
receiverIdNumber	Number	20	M	Phone number of the receiver	jdhdh54123
senderIdNumber	Number	20	M	Phone number of the sender	jacobh54123
senderCcy	string	3	M	Currency of the sender country	GHS
senderGender	string	1	M	Gender of the sender (Male - M or Female- F)	M or F
sourceBank	string	2	M	Source bank code	GH
exchangeRate	string		M	Ecobank commercial rates	9.5
receiverFirstName	string	20	M	Receiver first name	Gaffar
senderLastName	string	20	M	Sender first name	Oladimeji
receiverResidentialAddress	string	50	M	Receiver residential address	8, Accra Level
receiverIdType	string	20	M	Receiver Identification type	passport
receiverIdExpiryDate	string	10	M	Receiver Identification Expiry date	09/20/2022
product	string	10	M	This is a static value as “ACCOUNT”	ACCOUNT
senderIdType	string	20	M	Receiver Identification type of the sender	passport
receiverDOB	string	10	M	Receiver date of birth	9/20/1999
receiverPhoneNumber	string	20	M	Receiver phone number	08066689079
senderDOB	string	20	M	Sender phone number	09/20/2080
senderFirstName	string	20	M	Sender’s first name	James
receiverNationality	string	2	M	Receiver nationality code	NG
destinationAccountNumber	string	20	M	Destination account number	0012057660
destinationCountry	string	2	M	Destination country	NG
narration	string	50	M	Transaction narration	Test Transaction
senderResidentialAddress	string	50	M	Sender’s residential address	4, Iganmu Road
senderIdExpiryDate	string	10	M	Sender’s Identification expiry date	09/20/2022
amount	amount	NUMBER(22,2)	M	Amount	NUMBER (22,2)
currency	string	3	M	Debit account currency	USD, GHS, etc.
status	string	3	O	This field should be null or NEW	NEW
rate_type	string	4	M	This is a static value as sport	Spot (static value)
secureHash	string	129	M	SHA 512 hashing algorithm = (clientid+batchsequence+batchamount+transactionamount+ batchid+ transactioncount+ batchcount+ transactionid+ debittype+ affiliateCode+ totalbatches+ execution_date+labkey)	Sample provided in request payload

","urlObject":{"path":["corporateapi","merchant","payment"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"50090077-816a-48a3-9e43-b334f686424a","name":"Inter-affiliate book transfer","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests. ","type":"text"},{"key":"Accept","value":"application/json","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.","type":"text"},{"key":"Content-Type","value":"application/json","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paymentHeader\": {\n \"clientid\": \"EGHTelc000043\",\n \"batchsequence\": \"1\",\n \"batchamount\": 520,\n \"transactionamount\": 520,\n \"batchid\": \"EG1593490\",\n \"transactioncount\": 6,\n \"batchcount\": 6,\n \"transactionid\": \"E12T443308\",\n \"debittype\": \"Multiple\",\n \"affiliateCode\": \"EGH\",\n \"totalbatches\": \"1\",\n \"execution_date\": \"2020-06-01 00:00:00\"\n },\n \"extension\": [\n {\n \"request_id\": \"20000000QW4\",\n \"request_type\": \"ECOBANKAFRICA\",\n \"param_list\": \"[{\\\"key\\\":\\\"receiverLastName\\\", \\\"value\\\":\\\"Kasumu\\\"},{\\\"key\\\":\\\"sourceCountry\\\", \\\"value\\\":\\\"GH\\\"},{\\\"key\\\":\\\"senderNationality\\\", \\\"value\\\":\\\"Fr\\\"},{\\\"key\\\":\\\"senderPhoneNumber\\\", \\\"value\\\":\\\"07066690519\\\"},{\\\"key\\\":\\\"destinationBank\\\", \\\"value\\\":\\\"NG\\\"},{\\\"key\\\":\\\"purpose\\\", \\\"value\\\":\\\"Travel\\\"},{\\\"key\\\":\\\"receiverCcy\\\", \\\"value\\\":\\\"USD\\\"},{\\\"key\\\":\\\"receiverIdNumber\\\", \\\"value\\\":\\\"jdhdh54123\\\"},{\\\"key\\\":\\\"senderIdNumber\\\", \\\"value\\\":\\\"jacobh54123\\\"},{\\\"key\\\":\\\"senderCcy\\\", \\\"value\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"senderGender\\\", \\\"value\\\":\\\"M\\\"},{\\\"key\\\":\\\"sourceBank\\\", \\\"value\\\":\\\"GH\\\"},{\\\"key\\\":\\\"exchangeRate\\\", \\\"value\\\":\\\"9.5\\\"},{\\\"key\\\":\\\"receiverFirstName\\\", \\\"value\\\":\\\"Gaffar\\\"},{\\\"key\\\":\\\"senderLastName\\\", \\\"value\\\":\\\"Oladimeji\\\"},{\\\"key\\\":\\\"receiverResidentialAddress\\\", \\\"value\\\":\\\"8, Accra Level\\\"},{\\\"key\\\":\\\"receiverIdType\\\", \\\"value\\\":\\\"passport\\\"},{\\\"key\\\":\\\"receiverIdExpiryDate\\\", \\\"value\\\":\\\"09/20/2023\\\"},{\\\"key\\\":\\\"product\\\", \\\"value\\\":\\\"ACCOUNT\\\"},{\\\"key\\\":\\\"senderIdType\\\", \\\"value\\\":\\\"passport\\\"},{\\\"key\\\":\\\"receiverDOB\\\", \\\"value\\\":\\\"9/20/1999\\\"},{\\\"key\\\":\\\"receiverPhoneNumber\\\", \\\"value\\\":\\\"08066689079\\\"},{\\\"key\\\":\\\"senderDOB\\\", \\\"value\\\":\\\"09/20/2080\\\"},{\\\"key\\\":\\\"senderFirstName\\\", \\\"value\\\":\\\"James\\\"},{\\\"key\\\":\\\"receiverNationality\\\", \\\"value\\\":\\\"NG\\\"},{\\\"key\\\":\\\"destinationAccountNumber\\\", \\\"value\\\":\\\"0012057660\\\"},{\\\"key\\\":\\\"destinationCountry\\\", \\\"value\\\":\\\"NG\\\"},{\\\"key\\\":\\\"narration\\\", \\\"value\\\":\\\"Test Transaction\\\"},{\\\"key\\\":\\\"senderResidentialAddress\\\", \\\"value\\\":\\\"4, Iganmu Road\\\"},{\\\"key\\\":\\\"senderIdExpiryDate\\\", \\\"value\\\":\\\"09/20/2023\\\"}]\",\n \"amount\": 520,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n }\n ],\n \"secureHash\": \"398d4f285cc33e12f035da19fa9d954be35afaf66816531c4f1a1aedd3c6f132a85c62b23ca12d7b9a99bf5a84fc69b66738289a70e8f8115e90ffaa060f4026\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Fri, 14 Apr 2023 17:25:18 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": \"Request received successfully\",\n \"response_timestamp\": \"2023-04-14T17:25:18.577\"\n}"}],"_postman_id":"1a52ef59-735d-426b-b01c-b962d1dc5249"},{"name":"Cross-Border Xpress Cash Token","id":"7ab06504-a9e5-4cc2-9dc3-89adc2a3b843","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

The API helps customers to initiate cross-border transactions.

Payment Header

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
clientid	string	15	M	Client ID is used to identify each customer. Testing value is EGHTelc000043 and its static value for testing.	EGHTelc000043
batchsequence	string	1	M	Batch Sequence is used to identified batches per transaction e.g. (1 of 1, 2 of 1, 3 of 1).	1,2,3
batchamount	BigDecimal	NUMBER (22,2)	M	Batch Amount is the total amount of all individual request in a batch.	NUMBER (22,2)
transactionamount	BigDecimal	NUMBER (22,2)	M	Transaction Amount this is to total amount of all the batches amount in a transaction.	NUMBER (22,2)
batchid	string	15	M	Multiple transaction batches can be created but each batch will be identified by its BatchID. Customer to define the BatchID which is alphanumeric	EG15934CV
transactioncount	BigDecimal	Dependent on the total number of transactions sent	M	Transaction Count, this is the total number of all the individual transactions in the request	4,5,6
batchcount	string	200	M	Batch Count is the total of all individual request in this batch and will contain maximum of two hundred (200) per a batch.	4,5,6
transactionid	string	15	M	Transaction ID, this is a unique id that identifies the transaction.	E12T4433X4
debittype	Alphanumeric	8 - (Multiple)	M	This determines how customer’s account will be debited. Single debit for all transaction or debit for each transaction. For now, default value is Multiple.	Multiple
affiliateCode	Alphanumeric	3	M	Ecobank country where customer account is held. Sandbox value is EGH. In live Ecobank will provide the value for each country	Ghana (EGH), Nigeria (ENG), Togo (ETG), Senegal (ESN), etc.
totalbatches	Numeric	1 or 2	M	We have a concept of creating multiple batches of transactions but linking them together as same set of transaction using the same batchID hence if the batches of transaction were sent with the same batchID then totalbaches will be 2 else keep it always 1.	1,2
execution_date	Datetime	23	M	This is date of transactions. It cannot be back date. Only current or future date	YYYYMMDDHHmmss e.g., 2023-02-27T18:48:51.113

Extension parameter list

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
request_id	string	15	M	A unique reference assign to transaction. This is unique to each transaction.	2323V
request_type	string	15	M	This identifies the payment type that is been sent for posting	ECOBANKAFRICA
receiverLastName	string	50	M		Kasumu
sourceCountry	string	2	M	Source country	NG
senderNationality	string	2	M	Nationality of the sender	Fr, Gh, etc
senderPhoneNumber	Number	20	M	Phone number of the sender	07066690519
destinationBank	string	20	M	Destination bank	NG
purpose	string	50	M	Purpose of the transaction	Travel
receiverCcy	string	3	M	Currency of the receiving country	USD
receiverIdNumber	Number	20	M	Phone number of the receiver	jdhdh54123
senderIdNumber	Number	20	M	Phone number of the sender	jacobh54123
senderCcy	string	3	M	Currency of the sender country	GHS
senderGender	string	1	M	Gender of the sender (Male - M or Female- F)	M or F
sourceBank	string	2	M	Source bank code	GH
exchangeRate	string		M	Ecobank commercial rates	9.5
receiverFirstName	string	20	M	Receiver first name	Gaffar
senderLastName	string	20	M	Sender first name	Oladimeji
receiverResidentialAddress	string	50	M	Receiver residential address	8, Accra Level
receiverIdType	string	20	M	Receiver Identification type	passport
receiverIdExpiryDate	string	10	M	Receiver Identification Expiry date	09/20/2022
product	string	10	M	This is a static value as “ACCOUNT”	ACCOUNT
senderIdType	string	20	M	Receiver Identification type of the sender	passport
receiverDOB	string	10	M	Receiver date of birth	9/20/1999
receiverPhoneNumber	string	20	M	Receiver phone number	08066689079
senderDOB	string	20	M	Sender phone number	09/20/2080
senderFirstName	string	20	M	Sender’s first name	James
receiverNationality	string	2	M	Receiver nationality code	NG
destinationAccountNumber	string	20	M	Destination account number	0012057660
destinationCountry	string	2	M	Destination country	NG
narration	string	50	M	Transaction narration	Test Transaction
senderResidentialAddress	string	50	M	Sender’s residential address	4, Iganmu Road
senderIdExpiryDate	string	10	M	Sender’s Identification expiry date	09/20/2022
amount	amount	NUMBER(22,2)	M	Amount	NUMBER (22,2)
currency	string	3	M	Debit account currency	USD, GHS, etc.
status	string	3	O	This field should be null or NEW	NEW
rate_type	string	4	M	This is a static value as sport	Spot (static value)
secureHash	string	129	M	SHA 512 hashing algorithm = (clientid+batchsequence+batchamount+transactionamount+ batchid+ transactioncount+ batchcount+ transactionid+ debittype+ affiliateCode+ totalbatches+ execution_date+labkey)	Sample provided in request payload

","urlObject":{"path":["corporateapi","merchant","payment"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"f2a4429f-83ec-4e99-a33b-9409d4b811f2","name":"Inter-affiliate book transfer","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests. ","type":"text"},{"key":"Accept","value":"application/json","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.","type":"text"},{"key":"Content-Type","value":"application/json","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paymentHeader\": {\n \"clientid\": \"EGHTelc000043\",\n \"batchsequence\": \"1\",\n \"batchamount\": 520,\n \"transactionamount\": 520,\n \"batchid\": \"EG1593490\",\n \"transactioncount\": 6,\n \"batchcount\": 6,\n \"transactionid\": \"E12T443308\",\n \"debittype\": \"Multiple\",\n \"affiliateCode\": \"EGH\",\n \"totalbatches\": \"1\",\n \"execution_date\": \"2020-06-01 00:00:00\"\n },\n \"extension\": [\n {\n \"request_id\": \"20000000QW4\",\n \"request_type\": \"ECOBANKAFRICA\",\n \"param_list\": \"[{\\\"key\\\":\\\"receiverLastName\\\", \\\"value\\\":\\\"Kasumu\\\"},{\\\"key\\\":\\\"sourceCountry\\\", \\\"value\\\":\\\"GH\\\"},{\\\"key\\\":\\\"senderNationality\\\", \\\"value\\\":\\\"Fr\\\"},{\\\"key\\\":\\\"senderPhoneNumber\\\", \\\"value\\\":\\\"07066690519\\\"},{\\\"key\\\":\\\"destinationBank\\\", \\\"value\\\":\\\"NG\\\"},{\\\"key\\\":\\\"purpose\\\", \\\"value\\\":\\\"Travel\\\"},{\\\"key\\\":\\\"receiverCcy\\\", \\\"value\\\":\\\"USD\\\"},{\\\"key\\\":\\\"receiverIdNumber\\\", \\\"value\\\":\\\"jdhdh54123\\\"},{\\\"key\\\":\\\"senderIdNumber\\\", \\\"value\\\":\\\"jacobh54123\\\"},{\\\"key\\\":\\\"senderCcy\\\", \\\"value\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"senderGender\\\", \\\"value\\\":\\\"M\\\"},{\\\"key\\\":\\\"sourceBank\\\", \\\"value\\\":\\\"GH\\\"},{\\\"key\\\":\\\"exchangeRate\\\", \\\"value\\\":\\\"9.5\\\"},{\\\"key\\\":\\\"receiverFirstName\\\", \\\"value\\\":\\\"Gaffar\\\"},{\\\"key\\\":\\\"senderLastName\\\", \\\"value\\\":\\\"Oladimeji\\\"},{\\\"key\\\":\\\"receiverResidentialAddress\\\", \\\"value\\\":\\\"8, Accra Level\\\"},{\\\"key\\\":\\\"receiverIdType\\\", \\\"value\\\":\\\"passport\\\"},{\\\"key\\\":\\\"receiverIdExpiryDate\\\", \\\"value\\\":\\\"09/20/2023\\\"},{\\\"key\\\":\\\"product\\\", \\\"value\\\":\\\"ACCOUNT\\\"},{\\\"key\\\":\\\"senderIdType\\\", \\\"value\\\":\\\"passport\\\"},{\\\"key\\\":\\\"receiverDOB\\\", \\\"value\\\":\\\"9/20/1999\\\"},{\\\"key\\\":\\\"receiverPhoneNumber\\\", \\\"value\\\":\\\"08066689079\\\"},{\\\"key\\\":\\\"senderDOB\\\", \\\"value\\\":\\\"09/20/2080\\\"},{\\\"key\\\":\\\"senderFirstName\\\", \\\"value\\\":\\\"James\\\"},{\\\"key\\\":\\\"receiverNationality\\\", \\\"value\\\":\\\"NG\\\"},{\\\"key\\\":\\\"destinationAccountNumber\\\", \\\"value\\\":\\\"0012057660\\\"},{\\\"key\\\":\\\"destinationCountry\\\", \\\"value\\\":\\\"NG\\\"},{\\\"key\\\":\\\"narration\\\", \\\"value\\\":\\\"Test Transaction\\\"},{\\\"key\\\":\\\"senderResidentialAddress\\\", \\\"value\\\":\\\"4, Iganmu Road\\\"},{\\\"key\\\":\\\"senderIdExpiryDate\\\", \\\"value\\\":\\\"09/20/2023\\\"}]\",\n \"amount\": 520,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n }\n ],\n \"secureHash\": \"398d4f285cc33e12f035da19fa9d954be35afaf66816531c4f1a1aedd3c6f132a85c62b23ca12d7b9a99bf5a84fc69b66738289a70e8f8115e90ffaa060f4026\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Fri, 14 Apr 2023 17:25:18 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": \"Request received successfully\",\n \"response_timestamp\": \"2023-04-14T17:25:18.577\"\n}"}],"_postman_id":"7ab06504-a9e5-4cc2-9dc3-89adc2a3b843"},{"name":"Cross-Border Bank-To-Wallet(MoMo)","id":"e3b64d4d-1cec-40eb-a795-4b9e01fa9c66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

The API helps customers to initiate cross-border transactions.

Payment Header

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
clientid	string	15	M	Client ID is used to identify each customer. Testing value is EGHTelc000043 and its static value for testing.	EGHTelc000043
batchsequence	string	1	M	Batch Sequence is used to identified batches per transaction e.g. (1 of 1, 2 of 1, 3 of 1).	1,2,3
batchamount	BigDecimal	NUMBER (22,2)	M	Batch Amount is the total amount of all individual request in a batch.	NUMBER (22,2)
transactionamount	BigDecimal	NUMBER (22,2)	M	Transaction Amount this is to total amount of all the batches amount in a transaction.	NUMBER (22,2)
batchid	string	15	M	Multiple transaction batches can be created but each batch will be identified by its BatchID. Customer to define the BatchID which is alphanumeric	EG15934CV
transactioncount	BigDecimal	Dependent on the total number of transactions sent	M	Transaction Count, this is the total number of all the individual transactions in the request	4,5,6
batchcount	string	200	M	Batch Count is the total of all individual request in this batch and will contain maximum of two hundred (200) per a batch.	4,5,6
transactionid	string	15	M	Transaction ID, this is a unique id that identifies the transaction.	E12T4433X4
debittype	Alphanumeric	8 - (Multiple)	M	This determines how customer’s account will be debited. Single debit for all transaction or debit for each transaction. For now, default value is Multiple.	Multiple
affiliateCode	Alphanumeric	3	M	Ecobank country where customer account is held. Sandbox value is EGH. In live Ecobank will provide the value for each country	Ghana (EGH), Nigeria (ENG), Togo (ETG), Senegal (ESN), etc.
totalbatches	Numeric	1 or 2	M	We have a concept of creating multiple batches of transactions but linking them together as same set of transaction using the same batchID hence if the batches of transaction were sent with the same batchID then totalbaches will be 2 else keep it always 1.	1,2
execution_date	Datetime	23	M	This is date of transactions. It cannot be back date. Only current or future date	YYYYMMDDHHmmss e.g., 2023-02-27T18:48:51.113

Extension parameter list

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
request_id	string	15	M	A unique reference assign to transaction. This is unique to each transaction.	2323V
request_type	string	15	M	This identifies the payment type that is been sent for posting	ECOBANKAFRICA
receiverLastName	string	50	M		Kasumu
sourceCountry	string	2	M	Source country	NG
senderNationality	string	2	M	Nationality of the sender	Fr, Gh, etc
senderPhoneNumber	Number	20	M	Phone number of the sender	07066690519
destinationBank	string	20	M	Destination bank	NG
purpose	string	50	M	Purpose of the transaction	Travel
receiverCcy	string	3	M	Currency of the receiving country	USD
receiverIdNumber	Number	20	M	Phone number of the receiver	jdhdh54123
senderIdNumber	Number	20	M	Phone number of the sender	jacobh54123
senderCcy	string	3	M	Currency of the sender country	GHS
senderGender	string	1	M	Gender of the sender (Male - M or Female- F)	M or F
sourceBank	string	2	M	Source bank code	GH
exchangeRate	string		M	Ecobank commercial rates	9.5
receiverFirstName	string	20	M	Receiver first name	Gaffar
senderLastName	string	20	M	Sender first name	Oladimeji
receiverResidentialAddress	string	50	M	Receiver residential address	8, Accra Level
receiverIdType	string	20	M	Receiver Identification type	passport
receiverIdExpiryDate	string	10	M	Receiver Identification Expiry date	09/20/2022
product	string	10	M	This is a static value as “ACCOUNT”	ACCOUNT
senderIdType	string	20	M	Receiver Identification type of the sender	passport
receiverDOB	string	10	M	Receiver date of birth	9/20/1999
receiverPhoneNumber	string	20	M	Receiver phone number	08066689079
senderDOB	string	20	M	Sender phone number	09/20/2080
senderFirstName	string	20	M	Sender’s first name	James
receiverNationality	string	2	M	Receiver nationality code	NG
destinationAccountNumber	string	20	M	Destination account number	0012057660
destinationCountry	string	2	M	Destination country	NG
narration	string	50	M	Transaction narration	Test Transaction
senderResidentialAddress	string	50	M	Sender’s residential address	4, Iganmu Road
senderIdExpiryDate	string	10	M	Sender’s Identification expiry date	09/20/2022
amount	amount	NUMBER(22,2)	M	Amount	NUMBER (22,2)
currency	string	3	M	Debit account currency	USD, GHS, etc.
status	string	3	O	This field should be null or NEW	NEW
rate_type	string	4	M	This is a static value as sport	Spot (static value)
secureHash	string	129	M	SHA 512 hashing algorithm = (clientid+batchsequence+batchamount+transactionamount+ batchid+ transactioncount+ batchcount+ transactionid+ debittype+ affiliateCode+ totalbatches+ execution_date+labkey)	Sample provided in request payload

","urlObject":{"path":["corporateapi","merchant","payment"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"d92439a0-bffd-47ad-9990-8235c4a3a67e","name":"Inter-affiliate book transfer","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests. ","type":"text"},{"key":"Accept","value":"application/json","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.","type":"text"},{"key":"Content-Type","value":"application/json","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paymentHeader\": {\n \"clientid\": \"EGHTelc000043\",\n \"batchsequence\": \"1\",\n \"batchamount\": 520,\n \"transactionamount\": 520,\n \"batchid\": \"EG1593490\",\n \"transactioncount\": 6,\n \"batchcount\": 6,\n \"transactionid\": \"E12T443308\",\n \"debittype\": \"Multiple\",\n \"affiliateCode\": \"EGH\",\n \"totalbatches\": \"1\",\n \"execution_date\": \"2020-06-01 00:00:00\"\n },\n \"extension\": [\n {\n \"request_id\": \"20000000QW4\",\n \"request_type\": \"ECOBANKAFRICA\",\n \"param_list\": \"[{\\\"key\\\":\\\"receiverLastName\\\", \\\"value\\\":\\\"Kasumu\\\"},{\\\"key\\\":\\\"sourceCountry\\\", \\\"value\\\":\\\"GH\\\"},{\\\"key\\\":\\\"senderNationality\\\", \\\"value\\\":\\\"Fr\\\"},{\\\"key\\\":\\\"senderPhoneNumber\\\", \\\"value\\\":\\\"07066690519\\\"},{\\\"key\\\":\\\"destinationBank\\\", \\\"value\\\":\\\"NG\\\"},{\\\"key\\\":\\\"purpose\\\", \\\"value\\\":\\\"Travel\\\"},{\\\"key\\\":\\\"receiverCcy\\\", \\\"value\\\":\\\"USD\\\"},{\\\"key\\\":\\\"receiverIdNumber\\\", \\\"value\\\":\\\"jdhdh54123\\\"},{\\\"key\\\":\\\"senderIdNumber\\\", \\\"value\\\":\\\"jacobh54123\\\"},{\\\"key\\\":\\\"senderCcy\\\", \\\"value\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"senderGender\\\", \\\"value\\\":\\\"M\\\"},{\\\"key\\\":\\\"sourceBank\\\", \\\"value\\\":\\\"GH\\\"},{\\\"key\\\":\\\"exchangeRate\\\", \\\"value\\\":\\\"9.5\\\"},{\\\"key\\\":\\\"receiverFirstName\\\", \\\"value\\\":\\\"Gaffar\\\"},{\\\"key\\\":\\\"senderLastName\\\", \\\"value\\\":\\\"Oladimeji\\\"},{\\\"key\\\":\\\"receiverResidentialAddress\\\", \\\"value\\\":\\\"8, Accra Level\\\"},{\\\"key\\\":\\\"receiverIdType\\\", \\\"value\\\":\\\"passport\\\"},{\\\"key\\\":\\\"receiverIdExpiryDate\\\", \\\"value\\\":\\\"09/20/2023\\\"},{\\\"key\\\":\\\"product\\\", \\\"value\\\":\\\"ACCOUNT\\\"},{\\\"key\\\":\\\"senderIdType\\\", \\\"value\\\":\\\"passport\\\"},{\\\"key\\\":\\\"receiverDOB\\\", \\\"value\\\":\\\"9/20/1999\\\"},{\\\"key\\\":\\\"receiverPhoneNumber\\\", \\\"value\\\":\\\"08066689079\\\"},{\\\"key\\\":\\\"senderDOB\\\", \\\"value\\\":\\\"09/20/2080\\\"},{\\\"key\\\":\\\"senderFirstName\\\", \\\"value\\\":\\\"James\\\"},{\\\"key\\\":\\\"receiverNationality\\\", \\\"value\\\":\\\"NG\\\"},{\\\"key\\\":\\\"destinationAccountNumber\\\", \\\"value\\\":\\\"0012057660\\\"},{\\\"key\\\":\\\"destinationCountry\\\", \\\"value\\\":\\\"NG\\\"},{\\\"key\\\":\\\"narration\\\", \\\"value\\\":\\\"Test Transaction\\\"},{\\\"key\\\":\\\"senderResidentialAddress\\\", \\\"value\\\":\\\"4, Iganmu Road\\\"},{\\\"key\\\":\\\"senderIdExpiryDate\\\", \\\"value\\\":\\\"09/20/2023\\\"}]\",\n \"amount\": 520,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n }\n ],\n \"secureHash\": \"398d4f285cc33e12f035da19fa9d954be35afaf66816531c4f1a1aedd3c6f132a85c62b23ca12d7b9a99bf5a84fc69b66738289a70e8f8115e90ffaa060f4026\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Fri, 14 Apr 2023 17:25:18 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": \"Request received successfully\",\n \"response_timestamp\": \"2023-04-14T17:25:18.577\"\n}"}],"_postman_id":"e3b64d4d-1cec-40eb-a795-4b9e01fa9c66"},{"name":"Institution List","id":"eaeb6f0a-107d-4717-b202-b8eee1529b74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"23100191000000001\",\n \"clientId\": \"EGHTelc000043\",\n \"affiliateCode\": \"EGH\",\n \"destinationCountry\": \"GH\",\n \"secureHash\":\"91b81ebf6bf85439894183d86faf2ee6283ba38d8e98c931c0de210e4c5155985e58b8440d4664a5c09628d2cd5e67879be5136c67154b3cb410c99e1c5b425f\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/ecobankafrica/institutions","description":"

This API returns the list of Ecobank affiliates allowed to participate in cross-border transactions.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
requestId	string	15	M	A unique reference that is used to query pass a request to get list of institution list	2323V
secureHash	string	129	M	SHA 512 hashing algorithm = (RequestId +labkey	Sample provided in request payload

","urlObject":{"path":["corporateapi","merchant","ecobankafrica","institutions"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"28ecf69b-b9b3-4096-b9b4-74248980fb26","name":"Institution List","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests. ","type":"text"},{"key":"Accept","value":"application/json","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.","type":"text"},{"key":"Content-Type","value":"application/json","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"23100191000000001\",\n \"clientId\": \"EGHTelc000043\",\n \"affiliateCode\": \"EGH\",\n \"destinationCountry\": \"GH\",\n \"secureHash\":\"91b81ebf6bf85439894183d86faf2ee6283ba38d8e98c931c0de210e4c5155985e58b8440d4664a5c09628d2cd5e67879be5136c67154b3cb410c99e1c5b425f\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/ecobankafrica/institutions"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": [\n {\n \"institutionId\": \"AIRTEL_MONEY\",\n \"institutionType\": \"MNO\",\n \"institutionName\": \"AIRTEL MONEY\",\n \"countryCode\": \"EGH\"\n },\n {\n \"institutionId\": \"AIRTELTIGOEGH\",\n \"institutionType\": \"MNO\",\n \"institutionName\": \"AIRTEL MONEY\",\n \"countryCode\": \"EGH\"\n },\n {\n \"institutionId\": \"AIRTELTIGOMONEY\",\n \"institutionType\": \"MNO\",\n \"institutionName\": \"AIRTEL MONEY\",\n \"countryCode\": \"EGH\"\n },\n {\n \"institutionId\": \"300303\",\n \"institutionType\": \"BANK\",\n \"institutionName\": \"Absa\",\n \"countryCode\": \"EGH\"\n }\n ],\n \"response_timestamp\": \"2024-10-28T12:13:28.085\"\n}"}],"_postman_id":"eaeb6f0a-107d-4717-b202-b8eee1529b74"},{"name":"Name Enquiry","id":"68970106-787a-4cfe-917f-91b2e3701bf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"23100191000000002\",\n \"clientId\": \"EGHTelc000043\",\n \"affiliateCode\": \"EGH\",\n \"deliveryMethod\": \"ACCOUNT\",\n \"destinationEntityCode\": \"ECOBANK\",\n \"accountNo\": \"3441002127474\",\n \"destinationCountry\": \"GH\",\n \"secureHash\":\"05013a1f94d8849c7475c3498e3d2cb1c3004228a9b7562e9dee628e97dc7ea3a07bd0d8f3ed742ad851f9543f594203fa4461567f8a78ccc9e7892ad6882983\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/ecobankafrica/account/enquiry","description":"

The name enquiry API is used fetch the name and other details of a supplied account.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
deliveryMethod	string	10	M	This is static value as “ACCOUNT” since the request is to enquire into an account	ACCOUNT
destinationEntityCode	string	6	M	Static account as ECOBANK	ECOBANK
accountNo	Number	20	M	The account number to enquire	3441002127474
destinationCountry	string	2	M	Destination country	GH
requestId	string		M	A unique reference pass to each name enquiry request.	23100191000000002
secureHash	string	129	M	SHA 512 hashing algorithm = (RequestId +labkey	Sample provided in request payload

","urlObject":{"path":["corporateapi","merchant","ecobankafrica","account","enquiry"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"dfdb88c7-1e87-4d3d-a478-297c71d0b99a","name":"Name Enquiry","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests. ","type":"text"},{"key":"Accept","value":"application/json","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.","type":"text"},{"key":"Content-Type","value":"application/json","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"23100191000000002\",\n \"clientId\": \"EGHTelc000043\",\n \"affiliateCode\": \"EGH\",\n \"deliveryMethod\": \"ACCOUNT\",\n \"destinationEntityCode\": \"ECOBANK\",\n \"accountNo\": \"3441002127474\",\n \"destinationCountry\": \"GH\",\n \"secureHash\":\"05013a1f94d8849c7475c3498e3d2cb1c3004228a9b7562e9dee628e97dc7ea3a07bd0d8f3ed742ad851f9543f594203fa4461567f8a78ccc9e7892ad6882983\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/ecobankafrica/account/enquiry"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": {\n \"accountStatus\": \"ACTIVE\",\n \"accountName\": \"XXXX\",\n \"accountType\": \"S\",\n \"branchCode\": \"H55\",\n \"accountNo\": \"144100XXXXXX\",\n \"ccy\": \"GHS\",\n \"responseMessage\": \"Success\",\n \"affiliateCode\": \"EGH\",\n \"responseCode\": \"000\"\n },\n \"response_timestamp\": \"2024-10-28T12:17:50.948\"\n}"}],"_postman_id":"68970106-787a-4cfe-917f-91b2e3701bf3"},{"name":"Rate","id":"a6725e7f-46f8-49b0-b817-98af560fcb73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"23100191000000003\",\n \"secureHash\":\"0afbea4466be51759ce32c81c87c5c5230f70717385b4a9011c6c3950d9509773834f4726acda7b5828d6ea4e09bb7c0e85739c0bbc60152dce5ade5f755a3e4\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/ecobankafrica/rates","description":"

This API service fetches Ecobank commercial rates.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
requestId	string	15	M	A unique reference that is used to query pass a request to get list of institution list	2323V
secureHash	string	129	M	SHA 512 hashing algorithm = (RequestId +labkey	Sample provided in request payload

","urlObject":{"path":["corporateapi","merchant","ecobankafrica","rates"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6725e7f-46f8-49b0-b817-98af560fcb73"},{"name":"Transaction Enquiry","id":"3f440bde-54b1-4c2c-a27e-b90dbede4de8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"23100191000000004\",\n \"transactionReference\": \"Mondayda300920222#3\",\n \"secureHash\":\"f6f7e3d907432d284431b10278c6ee1f2dfc1d8fee520a7d0933067cc5b0d5cb4da1de669dd3a34c39a11e0e4cd97d4452436eb989607d0de14e12cc59136a41\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/ecobankafrica/transaction/enquiry","description":"

API service to query status of an earlier initiated REST transaction.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
requestId	string	15	M	A unique reference that is used to query pass a request to get list of institution list	2323V
transactionReference	string	20	M	Transaction reference passed in the earlier payment request.	Mondayda300920222#3
secureHash	string	129	M	SHA 512 hashing algorithm = (RequestId +labkey	Sample provided in request payload

","urlObject":{"path":["corporateapi","merchant","ecobankafrica","transaction","enquiry"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3f440bde-54b1-4c2c-a27e-b90dbede4de8"}],"id":"acfe7f55-27aa-487d-ba1a-799ecb466bd7","description":"

Overview

The section enables partners to transfer money from their accounts to various beneficiaries through diverse methods between affiliates impacting accounts in the different Banks or MNOs.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

SERVICE	DESCRIPTION
INTERBANKIA	This is used for movement of funds between countries to credit a third party or local bank account at the receiving country/affiliate. For example, sending from an Ecobank Ghana account to an account in another bank (other than Ecobank) in the receiving country.
TOKENIA	This enables the movement of funds from an Ecobank account in one country to another. A user generates an Xpress token in the originating country and shares it with his/her beneficiary in another country for redemption at any Ecobank ATM or Agent points.
MOMOIA	This API is used for the movement of funds between countries to credit a mobile wallet account in the receiving affiliate/country.

","_postman_id":"acfe7f55-27aa-487d-ba1a-799ecb466bd7"},{"name":"Payments","item":[{"name":"Bills Payment","item":[{"name":"Get Biller List","id":"eec6e30d-de2b-4565-89a1-cded3a7a8284","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"ECO2112134345\",\n \"affiliateCode\": \"EGH\",\n \"secureHash\": \"77f689d330dfe3b0797a53962b549b441777454432f00a94607195d8e56800a4e4d644ca96b443a98bfcf25e91f1bcb1971b09a74473646211033fa7324573a3\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/getbillerlist ","description":"

This API gets list of billers present in an affiliate

REQUEST PAYLOAD

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	SAMPLE VALUE
requestId	Alphanumeric	9	M	This field identifies the corporation ID provisioned for the corporate	(9 characters) e.g ECO21341245
affiliateCode	String	3	M	Affiliate code of which the account and client has been maintained	(3 letters) e.g., EGH
secureHash	Alphanumeric	128	M	Combination of requestId and affiliate code to build the secure hash	DEST_BANK_CODE

RESPONSE PAYLOAD

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	Sample Value
response_code	Numeric	3	M	This parameter field indicated the transaction status. 000 means successful submission and any other code means an error occurred	200, 000 (3 digits)
response_message	String	7	M	This parameter field indicate an acknowledgment message from the API that gives the status of the request submission. Other response message is an error	Success (7 letters)
requestId	Alphanumeric	9	M	This field identifies the request ID provisioned for the corporate	(9 characters) e.g ECO21341245
sourceCode	String	17	M	This parameter field identifies the source code maintained	(17 letters) E.g. ECOBANKMOBILEAPP
billerCode	Alphanumeric	15	M	Created and assigned to the customer	E.g. CAUC
billerID	Alphanumeric	15	M	Created and assigned to the customer. 15 character maximum	E.g. 77124
billerName	String	50	M	Biller name assigned to the customer. 50 character maximum	E.g. CAUC - CONTINUING STUDENTS
billerDescription	String	50	M	Biller name assigned to the customer	E.g. CAUC - CONTINUING STUDENTS
billerCategory	String	50	M	Biller name assigned to the customer	E.g. SCHOOL, UTILITY
billerLogo	blob	50	M	logo that identify a particular biller	E.g. /usr/app/Alert/ecobank_banner.jpg
billAmountType	string	10		amount value return ten-digit character maximum	Send/received/DR/CR
billAmount	Numeric	NUMBER (22,2)	M	Amount of the transaction	800.00
ccy	String	3	M	The currency of the account provisioned	3 letters e.g., GHS
collectionAccountNo	Numeric	20	M	Collection account provisioned for the biller setup for client. 20 numbers maximum	E.g. 1441004523456
aggregatorName	String	15	M	Aggregator that the biller is leveraging on for the transfer	E.g. BANKCOLLECT
amountDenominations	String	10	M	amount value return ten-digit character maximum	E.g. coin/ note
productCodeList	String	50	M	value return 50-digit character maximum	E.g. AIRTELTIGOEGH

","urlObject":{"path":["corporateapi","merchant","getbillerlist "],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"acfa626b-6739-4d1a-82ea-0e1c66343d74","name":"Get Biller List","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests. ","type":"text"},{"key":"Accept","value":"application/json","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.","type":"text"},{"key":"Content-Type","value":"application/json","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"ECO2112134345\",\n \"affiliateCode\": \"EGH\",\n \"secureHash\": \"77f689d330dfe3b0797a53962b549b441777454432f00a94607195d8e56800a4e4d644ca96b443a98bfcf25e91f1bcb1971b09a74473646211033fa7324573a3\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/getbillerlist"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Fri, 23 Sep 2022 17:04:43 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": {\n \"hostHeaderInfo\": {\n \"sourceCode\": \"ECOBANKMOBILEAPP\",\n \"requestId\": \"ECO2112134345\",\n \"affiliateCode\": \"EGH\",\n \"responseCode\": \"000\",\n \"responseMessage\": \"Success\"\n },\n \"billerInfo\": [\n {\n \"billerCode\": \"MGC\",\n \"billerID\": 77427,\n \"billerName\": \"METHODIST COLLECTION\",\n \"billerDescription\": \"METHODIST COLLECTION\",\n \"billerCategory\": null,\n \"billerLogo\": \"/usr/app/Alert/ecobank_banner.jpg\",\n \"billAmountType\": \"\",\n \"billAmount\": 0,\n \"ccy\": \"\",\n \"collectionAccountNo\": \"\",\n \"aggregatorName\": \"NEWESB\",\n \"amountDenominations\": \"\",\n \"productCodeList\": \"\"\n },\n {\n \"billerCode\": \"GHWATER\",\n \"billerID\": 76758,\n \"billerName\": \"GHANA WATER\",\n \"billerDescription\": \"GHANA WATER\",\n \"billerCategory\": \"ECOBANK\",\n \"billerLogo\": \"/usr/app/Alert/ecobank_banner.jpg\",\n \"billAmountType\": \"\",\n \"billAmount\": 1,\n \"ccy\": \"GHS\",\n \"collectionAccountNo\": \"\",\n \"aggregatorName\": \"GHANA WATER\",\n \"amountDenominations\": \"\",\n \"productCodeList\": \"\"\n }\n ]\n },\n \"response_timestamp\": \"2022-09-23T17:04:43.506\"\n}"}],"_postman_id":"eec6e30d-de2b-4565-89a1-cded3a7a8284"},{"name":"Get Biller Details","id":"22c57a29-be69-4ca6-8274-896defa6b2f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"ECO21345\",\n \"affiliateCode\": \"EGH\",\n \"billerCode\": \"ACSSERV\",\n \"secureHash\": \"f4a6ca53d07017ac5a8122e83156de16edbb8c9b6149663eb1af43311562a916d671f9b7ed985837d19e9a9d6cd6a015496d486bb28a0b3557919351c15f9dd2\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/getbillerdetails","description":"

This API gets details of a particular biller

REQUEST PAYLOAD

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	Sample Value
requestId	Alphanumeric	13	M	This parameter field identifies the generated request ID	(Between 10 and 13 characters) e.g. EC12O21WE4521
affiliateCode	String	3	M	Affiliate code is used to identify the affiliate under which the account has been configured	(3 letters) e.g., EGH
billerCode	Alphanumeric	20	M	billerCode is used to identify each customer. This is provided prior to going live	(Between 10 and 20 characters) E.g. AIRTELTIGOEGH
secureHash	Alphanumeric	128	M	Click on link to get details on how to generate secureHash. Link	128 length characters

RESPONSE PAYLOAD

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	Sample Value
response_code	Numeric	3	M	This Numeric status code that implies the status of the transaction submission. 200 means successful submission and any other code means an error occurred.	(3 digits e.g. 200) The service request has been accepted successfully
response_message	String	7	M	This parameter field indicate an acknowledgment message from the API that gives the status of the request submission. Other response message is an error	(7 letters) success
sourceCode	String	17	M	This parameter field identifies the source code maintained	(17 letters) E.g. ECOBANKMOBILEAPP
requestId	Alphanumeric	15	M	This parameter field identifies the generated request ID	Between 10 and 15 characters) e.g. EC12O21WE4521
affiliateCode	String	3	M	Affiliate code is used to identify the affiliate under which the account has been configured	(3 letters) e.g., EGH
responseCode	String	3	M	This Numeric status code that implies the status of the transaction submission. 000 means successful submission and any other code means an error occurred.	(3 digits) 000
responseMessage	String	7	M	This parameter field indicate an acknowledgment message from the API that gives the status of the request submission. Other response message is an error	(7 letters) e.g. success
billerCode	Alphanumeric	10	M	Biller code maintained for biller. 10-digit character maximum	AIRTELTIGOEGH
billerID	Alphanumeric	15	M	Biller code maintained for biller. 15-digit character maximum	77120
billerName	String	50	M	Biller name assigned or setup for client. 50-digit character maximum	AIRTELTIGO MOBILE MONEY
billerDescription	String	50	M	Biller description for biller maintained. 50-digit character maximum	AIRTELTIGO MOBILE MONEY
billerCategory	String	20	M	Category of the biller. 20-character maximum	MOBILEMONEY
billerEmail	Alphanumeric	20	M	Email address assigned to the biller setup. 20 maximum characters	biller@ecobank.com
billerPhone	Numeric	20	M	Phone number setup under the biller. 20 character maximum	0243454488
billerSite	Alphanumeric	50	M	value return 50-digit character maximum	AIRTELTIGOEGH.COM
billerLogo	Alphanumeric	20	M	The image the identify the biller. 20 character maximum.	/usr/app/Alert/ecobank_banner.jpg\"
billAmountType	String	10	M	value return ten-digit character maximum	Cedis
billAmount	Numeric	NUMBER (22,2)	M	Amount of the transaction	800.00
ccy	String	3	M	The currency of the account provisioned	3 letters e.g., GHS
collectionAccountNo	Numeric	20	M	collection account value return 20-digit character maximum	1443443456777
aggregatorName	Alphanumeric	15	M	value return 15-digit character maximum. The payment aggregator	MOBILEMONEY_V2
validationRequired	String	1	M	Value as YES (Y) or NO (N)	‘’Y/N’’
productList	Alphanumeric	50	M	value return 50-digit character maximum	AIRTELTIGOEGH
serialNo	Alphanumeric	15	M	value return 15-digit character max	2346545655
fieldName	Alphanumeric	15	M	value return 15-digit character max	BEN_PHONE_NO
fieldTitle	Alphanumeric	15	M	value return 15-digit character max	BEN_PHONE_NO
dataType	String	10	M	Value returns maximum 10 characters	DOUBLE
validateField	String	1	M	Value as YES (Y) or NO (N)	‘’Y/N’’
defaultValue	String	15	M	value return 15-digit character max	AIRTELTIGOEGH
maxFieldLength	Numeric	100	M	value return 100-digit character max	100
listofValues	Alphanumeric	10	M	value return 10-digit character maximum	AIRTELTIGOEGH
lookupValue	Alphanumeric	10	M	value return 10-digit character maximum	AIRTELTIGOEGH
productCode	String	20	M	value return 20-digit character maximum	AIRTELTIGO_MOBILEMONEY
productName	String	20	M	value return 20-digit character maximum	value return 20-digit character maximum
productDescription	String	20	M	value return 20-digit character maximum	AIRTELTIGO_MOBILEMONEY
productCategory	Numeric	3	M	Product Category field return 3-digit character maximum	002 (3 digits)
amountType	String	10	M	Value returns 10 maximum character length	Eg “cedis”
minAmount	Numeric	NUMBER (22,2)	M	Amount of the transaction	800.00
maxAmount	Numeric	NUMBER (22,2)	M	Amount of the transaction	800.00
ccy	String	3	M	The currency of the account provisioned	3 letters e.g., GHS
exchRate	Numeric	NUMBER (22,2)	M	Exchange rate of the transaction	1.0
response_timestamp	Timestamp	23	M	This is the Timestamp of the specified transaction request YEAR+MONTH+DATE+HOUR+MINUTE+SECOND	YYYYMMDDHHmmss e.g. 2022-04-05T18:48:51.113

","urlObject":{"path":["corporateapi","merchant","getbillerdetails"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"34598a1f-7c0b-4927-be2f-69cb83f13cc5","name":"Get Biller Details","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests. ","type":"text"},{"key":"Accept","value":"application/json","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.","type":"text"},{"key":"Content-Type","value":"application/json","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"ECO21345\",\n \"affiliateCode\": \"EGH\",\n \"billerCode\": \"ACSSERV\",\n \"secureHash\": \"f4a6ca53d07017ac5a8122e83156de16edbb8c9b6149663eb1af43311562a916d671f9b7ed985837d19e9a9d6cd6a015496d486bb28a0b3557919351c15f9dd2\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/getbillerdetails"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Fri, 23 Sep 2022 17:10:32 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": {\n \"hostHeaderInfo\": {\n \"sourceCode\": \"ECOBANKMOBILEAPP\",\n \"requestId\": \"ECO21345\",\n \"affiliateCode\": \"EGH\",\n \"responseCode\": \"000\",\n \"responseMessage\": \"Success\"\n },\n \"billerDetail\": {\n \"billerCode\": \"ACSSERV\",\n \"billerID\": 87262,\n \"billerName\": \"ACS AFRICA COASTAL SERVICES\",\n \"billerDescription\": \"ACS AFRICA COASTAL SERVICES\",\n \"billerCategory\": \"UTILITY\",\n \"billerEmail\": \"\",\n \"billerPhone\": \"\",\n \"billerSite\": \"\",\n \"billerLogo\": \"/usr/app/Alert/ecobank_banner.jpg\",\n \"billAmountType\": \"\",\n \"billAmount\": 1,\n \"collectionAccountNo\": \"\",\n \"collectionAccountName\": \"\",\n \"collectionAccountBankCode\": \"\",\n \"aggregatorName\": \"BANKCOLLECT\",\n \"validationRequired\": \"N\",\n \"productList\": \"\"\n },\n \"billFormData\": [\n {\n \"serialNo\": 1,\n \"fieldName\": \"INVOICE NUMBER\",\n \"fieldTitle\": \"INVOICE NUMBER\",\n \"dataType\": \"String\",\n \"validateField\": \"N\",\n \"defaultValue\": \"\",\n \"maxFieldLength\": 100,\n \"listofValues\": \"\",\n \"lookupValue\": []\n }\n ],\n \"billerProductInfo\": [\n {\n \"productCode\": \"ACSSERV\",\n \"productName\": \"ACS AFRICA COASTAL SERVICES\",\n \"productDescription\": \"ACS AFRICA COASTAL SERVICES\",\n \"productCategory\": \"ACSSERV\",\n \"amountType\": \"Y\",\n \"minAmount\": 1,\n \"maxAmount\": 50000,\n \"ccy\": \"GHS\",\n \"exchRate\": 1\n }\n ]\n },\n \"response_timestamp\": \"2022-09-23T17:10:32.778\"\n}"}],"_postman_id":"22c57a29-be69-4ca6-8274-896defa6b2f9"},{"name":"Validate Biller","id":"575a20cc-d7d1-4627-9665-1211622e1523","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"EC12O2134521\",\n \"affiliateCode\": \"EGH\",\n \"billerCode\": \"MTNPTU\",\n \"productCode\": \"02\",\n \"mobileNnumber\": \"0254875943\",\n \"customerName\": \"Edu\",\n \"formDataValue\": [\n {\n \"fieldName\": \"METER NUMBER\",\n \"fieldValue\": \"54140081982\"\n\n }\n ],\n \"secureHash\": \"bb7e8868c7a55852fd1fa07034027366e9535ae2115e70ad792c52f6f1d732030d4547edcd334be6a2241749842c0553832d1ced353f0f694eccd9a541facb10\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/validatebiller","description":"

This API validate the biller request before sending the transaction for processing

REQUEST PAYLOAD

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	Sample Value
billerCode	String	10	M	value return 10-digit character maximum	AIRTELTIGOEGH
productCode	String	15	M	value return 15-digit character maximum	AIRTELTIGO_MOBILEMONEY
affiliateCode	String	3	M	Affiliate code is used to identify the affiliate under which the account has been configured	(3 letters) e.g., EGH
requestId	Alphanumeric	15	M	This parameter field identifies the generated request ID	Between 10 and 15 characters) e.g. EC12O2134521
mobileNnumber	Numeric	15	M	value return 15-digit character maximum	024567778
customerName	String	5	M	value return 15-digit character maximum	ADBP
fieldName	String	15	M	value return 15-digit character maximum	BEN_PHONE_NO
fieldValue	String	15	M	value return 15-digit character maximum	0560000159
dataType	String	10	M	value return 10-digit character maximum	String

RESPONSE PAYLOAD

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	Sample Value
response_code	Numeric	3	M	This Numeric status code that implies the status of the transaction submission. 200 means successful submission and any other code means an error occurred.	(3 digits e.g. 200) The service request has been accepted successfully
response_message	String	7	M	This parameter field indicate an acknowledgment message from the API that gives the status of the request submission. Other response message is an error	(7 letters) success
sourceCode	String	17	M	This parameter field identifies the source code maintained	17 letters) E.g. ECOBANKMOBILEAPP
requestId	Alphanumeric	15	M	This parameter field identifies the generated request ID	Between 10 and 15 characters) e.g. EC12O21WE4521
affiliateCode	String	3	M	Affiliate code is used to identify the affiliate under which the account has been configured	(3 letters) e.g., EGH
responseCode	String	3	M	This Numeric status code that implies the status of the transaction submission. 000 means successful submission and any other code means an error occurred.	(3 digits) 000
responseMessage	String	7	M	This parameter field indicate an acknowledgment message from the API that gives the status of the request submission. Other response message is an error	(7 letters) e.g. success
billerCode	Alphanumeric	10	M	value return 10-digit character maximum. Biller code that identifies each biller	AIRTELTIGOEGH
billRefNo	Alphanumeric	20	M	value return 20-digit character maximum. Ref Number that comes with a biller transaction	223 AIRTELTIGOEGH
customerName	String	15	M	value return 15-digit character maximum. Customer name	MAN WORLD
amount	Numeric	NUMBER (22,2)	M	Amount of the transaction.	800.00
paymentDescription	String	100	M	value return 100-digit character maximum	2202070CLTBU:2202070BN2D7,,,Interbank: TRN IFO AIRTELTIGOEGH Corporate AI (POOLSTN MC) BO MAN WORLD.
productCode	Alphanumeric	10	M	value return 10-digit character maximum	AIRTELTIGOEGH
responseValues	Alphanumeric	50	M	value return 50-digit character maximum	Request received successfully
fieldName	Alphanumeric	50	M	value return 50-digit character maximum	‘BEN_PHONE_NO’, ‘CHARGE
fieldDescription	String	10	M	value return 10-digit character maximum	Payment
fieldMasked	String	10	M	value return 10-digit character maximum
fieldValue	Numeric	NUMBER (22,2)	M	This parameter depicts the field value.	1.0
fieldRequired	String	5	M	value return 5-digit character maximum	Yes (Y)/ NO (N)
dataType	String	10	M	value return 10-digit character maximum	DOUBLE
response_timestamp	Timestamp	23	M	This is the Timestamp of the specified transaction request YEAR+MONTH+DATE+HOUR+MINUTE+SECOND	YYYYMMDDHHmmss e.g. 2022-04-05T18:48:51.113

","urlObject":{"path":["corporateapi","merchant","validatebiller"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"fcd2dcc2-e958-43bc-a17c-3391941c8af2","name":"Validate Biller","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests. ","type":"text"},{"key":"Accept","value":"application/json","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.","type":"text"},{"key":"Content-Type","value":"application/json","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"EC12O2134521\",\n \"affiliateCode\": \"EGH\",\n \"billerCode\": \"MTNPTU\",\n \"productCode\": \"02\",\n \"mobileNnumber\": \"0254875943\",\n \"customerName\": \"Edu\",\n \"formDataValue\": [\n {\n \"fieldName\": \"METER NUMBER\",\n \"fieldValue\": \"54140081982\"\n\n }\n ],\n \"secureHash\": \"bb7e8868c7a55852fd1fa07034027366e9535ae2115e70ad792c52f6f1d732030d4547edcd334be6a2241749842c0553832d1ced353f0f694eccd9a541facb10\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/validatebiller"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Fri, 23 Sep 2022 17:17:53 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": {\n \"hostHeaderInfo\": {\n \"sourceCode\": \"ECOBANKMOBILEAPP\",\n \"requestId\": \"0254875943\",\n \"affiliateCode\": \"EGH\",\n \"responseCode\": \"000\",\n \"responseMessage\": \"Success\"\n },\n \"billerCode\": \"MTNPTU\",\n \"billRefNo\": \"46356262\",\n \"customerName\": \"Benson\",\n \"amount\": 0,\n \"paymentDescription\": \"\",\n \"productCode\": \"\",\n \"responseValues\": \"\",\n \"formDataValue\": [\n {\n \"fieldName\": \"CHARGE\",\n \"fieldDescription\": \"\",\n \"fieldMasked\": \"\",\n \"fieldValue\": \"100.0\",\n \"fieldRequired\": \"\",\n \"dataType\": \"DOUBLE\"\n },\n {\n \"fieldName\": \"VAT\",\n \"fieldDescription\": \"\",\n \"fieldMasked\": \"\",\n \"fieldValue\": \"0.0\",\n \"fieldRequired\": \"\",\n \"dataType\": \"DOUBLE\"\n },\n {\n \"fieldName\": \"VAT\",\n \"fieldDescription\": \"\",\n \"fieldMasked\": \"\",\n \"fieldValue\": \"0.0\",\n \"fieldRequired\": \"\",\n \"dataType\": \"DOUBLE\"\n },\n {\n \"fieldName\": \"TOTAL CHARGE\",\n \"fieldDescription\": \"\",\n \"fieldMasked\": \"\",\n \"fieldValue\": \"100.0\",\n \"fieldRequired\": \"\",\n \"dataType\": \"DOUBLE\"\n },\n {\n \"fieldName\": \"TOTAL CHARGE\",\n \"fieldDescription\": \"\",\n \"fieldMasked\": \"\",\n \"fieldValue\": \"100.0\",\n \"fieldRequired\": \"\",\n \"dataType\": \"DOUBLE\"\n }\n ]\n },\n \"response_timestamp\": \"2022-09-23T17:17:53.181\"\n}"}],"_postman_id":"575a20cc-d7d1-4627-9665-1211622e1523"},{"name":"PostBillPayment","id":"24b816b8-9240-4187-bc9e-8271439bb1cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","type":"text"}],"body":{"mode":"raw","raw":"{\"paymentHeader\": {\n \"clientid\": \"EGHTelc000043\",\n \"batchsequence\": \"1\",\n \"batchamount\": 300,\n \"transactionamount\": 300,\n \"batchid\": \"EG1593490\",\n \"transactioncount\": 1,\n \"batchcount\": 1,\n \"transactionid\": \"E12T443308\",\n \"debittype\": \"Multiple\",\n \"affiliateCode\": \"EGH\",\n \"totalbatches\": \"1\",\n \"execution_date\": \"2020-06-01 00:00:00\"\n},\n\"extension\": [\n {\n \"request_id\": \"ECI55096987905\",\n \"request_type\": \"BILLPAYMENT\",\n \"param_list\": \"[{\\\"key\\\":\\\"billerCode\\\", \\\"value\\\":\\\"Pass_Bio_ECI\\\"},{\\\"key\\\":\\\"billRefNo\\\", \\\"value\\\":\\\"239729\\\"},{\\\"key\\\":\\\"cbaRefNo\\\", \\\"value\\\":\\\"\\\"},{\\\"key\\\":\\\"customerName\\\", \\\"value\\\":\\\"Freeman Kay\\\"},{\\\"key\\\":\\\"customerRefNo\\\", \\\"value\\\":\\\"239729\\\"},{\\\"key\\\":\\\"productCode\\\", \\\"value\\\":\\\"PassBio\\\"},{\\\"key\\\":\\\"formDataValue\\\", \\\"value\\\":\\\"[{\\\\\\\"fieldName\\\\\\\":\\\\\\\"LastName\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"Kojo\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"FirstName\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"Kwame\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"Amount\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"300\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"Phone\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"225543756765\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"Email\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"enyaledzigbor@ecobank.com\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"reference\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"210120400582\\\\\\\"}]\\\"}]\",\n \"amount\": 300,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n }],\n \n \"secureHash\":\"398d4f285cc33e12f035da19fa9d954be35afaf66816531c4f1a1aedd3c6f132a85c62b23ca12d7b9a99bf5a84fc69b66738289a70e8f8115e90ffaa060f4026\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/payment","description":"

BILL PAYMENT SERVICE

Allows customer to make bill payment, by enabling customer to validate references pertaining to a bill and further allow payment.

TRANSACTION DESCRIPTION (HEADER)

The payment payload accommodates single and batch posting. The extension in the request payload determines the request type (domestic, token, interbank, billpayment, airtime top-up) being call for transaction posting. For test purposes, each of the parameter values remains the same. This is to aid users get familiarize with request and response payload.

Each transaction contains number of batches, and each batch will have a header and a body, below are the header details:

Also, the body contain a list of requests. Each request contains a request type and another array of key-value pair objects that are specific for each request type.
Each of the key-value pair objects required for each request type is explain below on a tabular form.

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
clientid	string	15	M	Client ID is used to identify each customer. Testing value is EGHTelc000043 and its static value for testing.	EGHTelc000043
batchsequence	string	1	M	Batch Sequence is used to identified batches per transaction e.g. (1 of 1, 2 of 1, 3 of 1).	1,2,3
batchamount	BigDecimal	NUMBER (22,2)	M	Batch Amount is the total amount of all individual request in a batch.	NUMBER (22,2)
transactionamount	BigDecimal	NUMBER (22,2)	M	Transaction Amount this is to total amount of all the batches amount in a transaction.	NUMBER (22,2)
batchid	string	15	M	Multiple transaction batches can be created but each batch will be identified by its BatchID. Customer to define the BatchID which is alphanumeric	EG15934CV
transactioncount	BigDecimal	Dependent on the total number of transactions sent	M	Transaction Count, this is the total number of all the individual transactions in the request	4,5,6
batchcount	string	200	M	Batch Count is the total of all individual request in this batch and will contain maximum of two hundred (200) per a batch.	4,5,6
transactionid	string	15	M	Transaction ID, this is a unique id that identifies the transaction.	E12T4433X4
debittype	Alphanumeric	8 - (Multiple)	M	This determines how customer’s account will be debited. Single debit for all transaction or debit for each transaction. For now, default value is Multiple.	Multiple
affiliateCode	Alphanumeric	3	M	Ecobank country where customer account is held. Sandbox value is EGH. In live Ecobank will provide the value for each country	Ghana (EGH), Nigeria (ENG), Togo (ETG), Senegal (ESN), etc.
totalbatches	Numeric	1 or 2	M	We have a concept of creating multiple batches of transactions but linking them together as same set of transaction using the same batchID hence if the batches of transaction were sent with the same batchID then totalbaches will be 2 else keep it always 1.	1,2

SERVICE: BILL PAYMENT

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
request_id	string	15	M	A unique reference that identifies instrument in a batch. This is unique to each transaction.	ECI55096987905
request_type	string	12	M	This identifies the payment type that is been sent	BILLPAYMENT
billerCode	string	15	M	This code identifies the biller being called for payment. Additional endpoint exist that helps customers to call list of billers present in an affiliate.	Pass_Bio_ECI
billRefNo	string	15	M	This is bill reference number passed by customers	239729
cbaRefNo	string	15	O	This is reference passed by customers	239729AB
customerName	string	50	M	Customer name	Freeman Kay
customerRefNo	string	15	M	Customer reference number	239729BB
productCode	string	15	M	Product code of the exact biller being paid to. Additional endpoint exist to help customers spool details of a biller details that comprises of the product code and other vital details required for transaction posting.	PassBio
formDataValue	list		M	The list of form data values varies based on the biller mandatory values required for validation.	\"billFormData\": [ { \"serialNo\": 1, \"fieldName\": \"INVOICE NUMBER\", \"fieldTitle\": \"INVOICE NUMBER\", \"dataType\": \"String\", \"validateField\": \"N\", \"defaultValue\": \"\", \"maxFieldLength\": 100, \"listofValues\": \"\", \"lookupValue\": [] } ],
amount	amount	NUMBER (22,2)	M	Transaction amount	NUMBER (22,2)
currency	string	3	M	Debit account currency	USD, GHS, etc.
status	string	3	O	This field should be null or NEW	NEW
rate_type	string	4	M	This is a static value as sport	Spot (static value)
secureHash	string	129	M	SHA 512 hashing algorithm = (clientid+batchsequence+batchamount+transactionamount+ batched+ transactioncount+ batchcount+ transactionid+ debittype+ affiliateCode+ totalbatches+ execution_date+labkey)	Sample provided in request payload

","urlObject":{"path":["corporateapi","merchant","payment"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"a2aa5ee8-8679-4bf5-b0a3-b96efd7aa7d0","name":"PostBillPayment","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","type":"text"}],"body":{"mode":"raw","raw":"{\"paymentHeader\": {\n \"clientid\": \"EGHTelc000043\",\n \"batchsequence\": \"1\",\n \"batchamount\": 300,\n \"transactionamount\": 300,\n \"batchid\": \"EG1593490\",\n \"transactioncount\": 1,\n \"batchcount\": 1,\n \"transactionid\": \"E12T443308\",\n \"debittype\": \"Multiple\",\n \"affiliateCode\": \"EGH\",\n \"totalbatches\": \"1\",\n \"execution_date\": \"2020-06-01 00:00:00\"\n},\n\"extension\": [\n {\n \"request_id\": \"ECI55096987905\",\n \"request_type\": \"BILLPAYMENT\",\n \"param_list\": \"[{\\\"key\\\":\\\"billerCode\\\", \\\"value\\\":\\\"Pass_Bio_ECI\\\"},{\\\"key\\\":\\\"billRefNo\\\", \\\"value\\\":\\\"239729\\\"},{\\\"key\\\":\\\"cbaRefNo\\\", \\\"value\\\":\\\"\\\"},{\\\"key\\\":\\\"customerName\\\", \\\"value\\\":\\\"Freeman Kay\\\"},{\\\"key\\\":\\\"customerRefNo\\\", \\\"value\\\":\\\"239729\\\"},{\\\"key\\\":\\\"productCode\\\", \\\"value\\\":\\\"PassBio\\\"},{\\\"key\\\":\\\"formDataValue\\\", \\\"value\\\":\\\"[{\\\\\\\"fieldName\\\\\\\":\\\\\\\"LastName\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"Kojo\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"FirstName\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"Kwame\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"Amount\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"300\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"Phone\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"225543756765\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"Email\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"enyaledzigbor@ecobank.com\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"reference\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"210120400582\\\\\\\"}]\\\"}]\",\n \"amount\": 300,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n }],\n \n \"secureHash\":\"398d4f285cc33e12f035da19fa9d954be35afaf66816531c4f1a1aedd3c6f132a85c62b23ca12d7b9a99bf5a84fc69b66738289a70e8f8115e90ffaa060f4026\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Mon, 20 Mar 2023 12:17:39 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": \"Request received successfully\",\n \"response_timestamp\": \"2023-03-20T12:17:39.532\"\n}"}],"_postman_id":"24b816b8-9240-4187-bc9e-8271439bb1cb"}],"id":"536e8bf7-7999-4c00-8a03-65e6bd935bb9","description":"

This API is designed to handle all the bill payment needs for merchants. The service facilitates an integration to get list of billers, get biller details, and validate biller request

\n","_postman_id":"536e8bf7-7999-4c00-8a03-65e6bd935bb9"},{"name":"Payment","id":"fca97841-db96-4828-bc1b-525e973efe91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paymentHeader\": {\n \"clientid\": \"EGHTelc000043\",\n \"batchsequence\": \"1\",\n \"batchamount\": 520,\n \"transactionamount\": 520,\n \"batchid\": \"EG1593490\",\n \"transactioncount\": 6,\n \"batchcount\": 6,\n \"transactionid\": \"E12T443308\",\n \"debittype\": \"Multiple\",\n \"affiliateCode\": \"EGH\",\n \"totalbatches\": \"1\",\n \"execution_date\": \"2020-06-01 00:00:00\"\n },\n \"extension\": [\n {\n \"request_id\": \"2323\",\n \"request_type\": \"domestic\",\n \"param_list\": \"[{\\\"key\\\":\\\"creditAccountNo\\\", \\\"value\\\":\\\"1441001996321\\\"},{\\\"key\\\":\\\"debitAccountBranch\\\", \\\"value\\\":\\\"ACCRA\\\"},{\\\"key\\\":\\\"debitAccountType\\\", \\\"value\\\":\\\"Corporate\\\"},{\\\"key\\\":\\\"creditAccountBranch\\\", \\\"Accra\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"creditAccountType\\\", \\\"value\\\":\\\"Corporate\\\"},{\\\"key\\\":\\\"amount\\\", \\\"value\\\":\\\"10\\\"},{\\\"key\\\":\\\"ccy\\\", \\\"value\\\":\\\"GHS\\\"}]\",\n \"amount\": 10,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n },\n {\n \"request_id\": \"432\",\n \"request_type\": \"token\",\n \"param_list\": \"[{\\\"key\\\":\\\"transactionDescription\\\", \\\"value\\\":\\\"Service payment for electrical repairs.\\\"},{\\\"key\\\":\\\"secretCode\\\", \\\"value\\\":\\\"AWER1234\\\"},{\\\"key\\\":\\\"sourceAccount\\\",\\\"value\\\":\\\"1441000565307\\\"},{\\\"key\\\":\\\"sourceAccountCurrency\\\", \\\"value\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"sourceAccountType\\\", \\\"value\\\":\\\"Corporate\\\"},{\\\"key\\\":\\\"senderName\\\", \\\"value\\\":\\\"Freeman Kay\\\"},{\\\"key\\\":\\\"ccy\\\", \\\"value\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"senderMobileNo\\\", \\\"value\\\":\\\"0202205113\\\"},{\\\"key\\\":\\\"amount\\\", \\\"value\\\":\\\"40\\\"},{\\\"key\\\":\\\"senderId\\\", \\\"value\\\":\\\"QWE345Y4\\\"},{\\\"key\\\":\\\"beneficiaryName\\\", \\\"value\\\":\\\"Stephen Kojo\\\"},{\\\"key\\\":\\\"beneficiaryMobileNo\\\", \\\"value\\\":\\\"0233445566\\\"},{\\\"key\\\":\\\"withdrawalChannel\\\", \\\"value\\\":\\\"ATM\\\"}]\",\n \"amount\": 40,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n },\n {\n \"request_id\": \"2325\",\n \"request_type\": \"INTERBANK\",\n \"param_list\": \"[{\\\"key\\\":\\\"destinationBankCode\\\", \\\"value\\\":\\\"ASB\\\"},{\\\"key\\\":\\\"senderName\\\", \\\"value\\\":\\\"BEN\\\"},{\\\"key\\\":\\\"senderAddress\\\", \\\"value\\\":\\\"23 Accra Central\\\"},{\\\"key\\\":\\\"senderPhone\\\", \\\"value\\\":\\\"233263653712\\\"},{\\\"key\\\":\\\"beneficiaryAccountNo\\\",\\\"value\\\":\\\"110424812001\\\"},{\\\"key\\\":\\\"beneficiaryName\\\", \\\"value\\\":\\\"Owen\\\"},{\\\"key\\\":\\\"beneficiaryPhone\\\", \\\"value\\\":\\\"233543837123\\\"},{\\\"key\\\":\\\"transferReferenceNo\\\", \\\"value\\\":\\\"QWE345Y4\\\"},{\\\"key\\\":\\\"amount\\\", \\\"value\\\":\\\"10\\\"},{\\\"key\\\":\\\"ccy\\\", \\\"value\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"transferType\\\", \\\"value\\\":\\\"spot\\\"}]\",\n \"amount\": 10,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n },\n {\n \"request_id\": \"ECI55096987905\",\n \"request_type\": \"BILLPAYMENT\",\n \"param_list\": \"[{\\\"key\\\":\\\"billerCode\\\", \\\"value\\\":\\\"Pass_Bio_ECI\\\"},{\\\"key\\\":\\\"billRefNo\\\", \\\"value\\\":\\\"239729\\\"},{\\\"key\\\":\\\"cbaRefNo\\\", \\\"value\\\":\\\"\\\"},{\\\"key\\\":\\\"customerName\\\", \\\"value\\\":\\\"Freeman Kay\\\"},{\\\"key\\\":\\\"customerRefNo\\\", \\\"value\\\":\\\"239729\\\"},{\\\"key\\\":\\\"productCode\\\", \\\"value\\\":\\\"PassBio\\\"},{\\\"key\\\":\\\"formDataValue\\\", \\\"value\\\":\\\"[{\\\\\\\"fieldName\\\\\\\":\\\\\\\"LastName\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"Kojo\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"FirstName\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"Kwame\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"Amount\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"300\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"Phone\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"225543756765\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"Email\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"enyaledzigbor@ecobank.com\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"reference\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"210120400582\\\\\\\"}]\\\"}]\",\n \"amount\": 300,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n },\n {\n \"request_id\": \"WQ5500098663046\",\n \"request_type\": \"AIRTIMETOPUP\",\n \"param_list\": \"[{\\\"key\\\":\\\"billerCode\\\", \\\"value\\\":\\\"A02E\\\"},{\\\"key\\\":\\\"billRefNo\\\", \\\"value\\\":\\\"81729\\\"},{\\\"key\\\":\\\"cbaRefNo\\\", \\\"value\\\":\\\"\\\"},{\\\"key\\\":\\\"customerName\\\", \\\"value\\\":\\\"Owen Kay\\\"},{\\\"key\\\":\\\"customerRefNo\\\", \\\"value\\\":\\\"824225\\\"},{\\\"key\\\":\\\"productCode\\\", \\\"value\\\":\\\"A02E\\\"},{\\\"key\\\":\\\"formDataValue\\\", \\\"value\\\":\\\"[{\\\\\\\"fieldName\\\\\\\":\\\\\\\"BEN_PHONE_NO\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"2348034830707\\\\\\\"}]\\\"}]\",\n \"amount\": 10,\n \"currency\": \"NGN\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n },\n {\n \"request_id\": \"1234BBY8SXZX\",\n \"request_type\": \"MOMO\",\n \"param_list\": \"[{\\\"key\\\":\\\" billerCode\\\", \\\"value\\\":\\\"AIRTELTIGOEGH\\\"},{\\\"key\\\":\\\"billRefNo\\\", \\\"value\\\":\\\"2988759\\\"},{\\\"key\\\":\\\"cbaRefNo\\\", \\\"value\\\":\\\"05609\\\"},{\\\"key\\\":\\\"customerName\\\", \\\"value\\\":\\\"Owen Kay\\\"},{\\\"key\\\":\\\"customerRefNo\\\", \\\"value\\\":\\\"824225\\\"},{\\\"key\\\":\\\"productCode\\\", \\\"value\\\":\\\"AIRTELTIGO_MOBILEMONEY\\\"},{\\\"key\\\":\\\"formDataValue\\\", \\\"value\\\":\\\"[{\\\\\\\"fieldName\\\\\\\":\\\\\\\"BEN_PHONE_NO\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"0560000159\\\\\\\"}]\\\"}]\",\n \"amount\": 150,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n },\n {\n \"request_id\": \"ByA1lUeHKK\",\n \"request_type\": \"INTERBANKIA\",\n \"param_list\": \"[{\\\"key\\\":\\\"destinationCountry\\\", \\\"value\\\":\\\"EKE\\\"},{\\\"key\\\":\\\"destinationBankCode\\\", \\\"value\\\":\\\"11000\\\"}, {\\\"key\\\":\\\"beneficiaryAccountNo\\\",\\\"value\\\":\\\"01108738185300\\\"},{\\\"key\\\":\\\"beneficiaryName\\\", \\\"value\\\":\\\"Harmony Blinks\\\"},{\\\"key\\\":\\\"beneficiaryPhone\\\", \\\"value\\\":\\\"233543837123\\\"},{\\\"key\\\":\\\"amount\\\", \\\"value\\\":\\\"100\\\"},{\\\"key\\\":\\\"transferCurrency\\\", \\\"value\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"transferReason\\\", \\\"value\\\":\\\"vacation\\\"},{\\\"key\\\":\\\"settleCurrency\\\", \\\"value\\\":\\\"USD\\\"}]\",\n \"amount\": 100,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n },\n {\n \"request_id\": \"ByA1lUeHUU\",\n \"request_type\": \"TOKENIA\",\n \"param_list\": \"[{\\\"key\\\":\\\"destAffiliate\\\", \\\"value\\\":\\\"EKE\\\"},{\\\"key\\\":\\\"destCrncy\\\", \\\"value\\\":\\\"KES\\\"}, {\\\"key\\\":\\\"destinationAccount\\\",\\\"value\\\":\\\"01108738185300\\\"},{\\\"key\\\":\\\"destinationAccountName\\\", \\\"value\\\":\\\"Owen\\\"},{\\\"key\\\":\\\"receiveFirstName\\\", \\\"value\\\":\\\"Eugene\\\"},{\\\"key\\\":\\\"receiveLastName\\\", \\\"value\\\":\\\"Eugene\\\"},{\\\"key\\\":\\\"receiverPhoneNumber\\\", \\\"value\\\":\\\"233543837123\\\"},{\\\"key\\\":\\\"receiveEmailAddress\\\", \\\"value\\\":\\\"test@gmail.com\\\"},{\\\"key\\\":\\\"receiveIdType\\\", \\\"value\\\":\\\"23421221\\\"},{\\\"key\\\":\\\"receiveIdNumber\\\", \\\"value\\\":\\\"23421221\\\"},{\\\"key\\\":\\\"sourceAmount\\\", \\\"value\\\":\\\"100\\\"},{\\\"key\\\":\\\"testQuestion\\\", \\\"value\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"testAnswer\\\", \\\"value\\\":\\\"vacation\\\"},{\\\"key\\\":\\\"narration\\\", \\\"value\\\":\\\"narration\\\"},{\\\"key\\\":\\\"purposeOfTransfer\\\", \\\"value\\\":\\\"purposeOfTransfer\\\"},{\\\"key\\\":\\\"sendExternalRef\\\", \\\"value\\\":\\\"ByA1lUeHUU\\\"}]\",\n \"amount\": 100,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n },\n {\n \"request_id\": \"ByA1lUeHSS\",\n \"request_type\": \"TOKENIA\",\n \"param_list\": \"[{\\\"key\\\":\\\"destAffiliate\\\", \\\"value\\\":\\\"EKE\\\"},{\\\"key\\\":\\\"destCrncy\\\", \\\"value\\\":\\\"KES\\\"}, {\\\"key\\\":\\\"destinationAccount\\\",\\\"value\\\":\\\"01108738185300\\\"},{\\\"key\\\":\\\"destinationAccountName\\\", \\\"value\\\":\\\"Owen\\\"},{\\\"key\\\":\\\"receiveFirstName\\\", \\\"value\\\":\\\"Eugene\\\"},{\\\"key\\\":\\\"receiveLastName\\\", \\\"value\\\":\\\"Eugene\\\"},{\\\"key\\\":\\\"receiverPhoneNumber\\\", \\\"value\\\":\\\"233543837123\\\"},{\\\"key\\\":\\\"receiveEmailAddress\\\", \\\"value\\\":\\\"test@gmail.com\\\"},{\\\"key\\\":\\\"receiveIdType\\\", \\\"value\\\":\\\"23421221\\\"},{\\\"key\\\":\\\"receiveIdNumber\\\", \\\"value\\\":\\\"23421221\\\"},{\\\"key\\\":\\\"sourceAmount\\\", \\\"value\\\":\\\"100\\\"},{\\\"key\\\":\\\"testQuestion\\\", \\\"value\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"testAnswer\\\", \\\"value\\\":\\\"vacation\\\"},{\\\"key\\\":\\\"narration\\\", \\\"value\\\":\\\"narration\\\"},{\\\"key\\\":\\\"purposeOfTransfer\\\", \\\"value\\\":\\\"purposeOfTransfer\\\"},{\\\"key\\\":\\\"sendExternalRef\\\", \\\"value\\\":\\\"ByA1lUeHSS\\\"}]\",\n \"amount\": 100,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n }\n ],\n \"secureHash\": \"398d4f285cc33e12f035da19fa9d954be35afaf66816531c4f1a1aedd3c6f132a85c62b23ca12d7b9a99bf5a84fc69b66738289a70e8f8115e90ffaa060f4026\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/payment","description":"

Overview

The payment section enables partners to transfer money from their account to various beneficiaries through divers methods.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

SERVICE	DESCRIPTION
DOMESTIC	Enables customer to send an instruction to debit an account within Ecobank and credit another Ecobank account holder of the same country.
TOKEN	Allows customer to make cash payment to their beneficiaries and enable withdrawal to be done via ATM or Xpress point using the generated Token upon successfully sending an instruction.
INTERBANK	Enables customer debit an account within Ecobank and credit a beneficiary's account with another bank in the same country. This caters for Instant payment, RTGS, SICA, SYGMA and TFT transactions.
BILLPAYMENT	Allows customer to make bill payment, by enabling customer to validate references pertaining to a bill and further allow payment.
AIRTIME TOP-UP	Allows customer make airtime top-up request to credit Momo accounts across affiliates where Ecobank have an integration with MNO’s
MOMO	Allow customers to initiate bank-to-wallet transactions across affiliates where Ecobank has an integration with the telcos/aggregators.

TRANSACTION DESCRIPTION (HEADER)

Each transaction contains number of batches, and each batch will have a header and a body, below are the header details:

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
clientid	string	15	M	Client ID is used to identify each customer. Testing value is EGHTelc000043 and its static value for testing.	EGHTelc000043
batchsequence	string	1	M	Batch Sequence is used to identified batches per transaction e.g. (1 of 1, 2 of 1, 3 of 1).	1,2,3
batchamount	BigDecimal	NUMBER (22,2)	M	Batch Amount is the total amount of all individual request in a batch.	NUMBER (22,2)
transactionamount	BigDecimal	NUMBER (22,2)	M	Transaction Amount this is to total amount of all the batches amount in a transaction.	NUMBER (22,2)
batchid	string	15	M	Multiple transaction batches can be created but each batch will be identified by its BatchID. Customer to define the BatchID which is alphanumeric	EG15934CV
transactioncount	BigDecimal	Dependent on the total number of transactions sent	M	Transaction Count, this is the total number of all the individual transactions in the request	4,5,6
batchcount	string	200	M	Batch Count is the total of all individual request in this batch and will contain maximum of two hundred (200) per a batch.	4,5,6
transactionid	string	15	M	Transaction ID, this is a unique id that identifies the transaction.	E12T4433X4
debittype	Alphanumeric	8 - (Multiple)	M	This determines how customer’s account will be debited. Single debit for all transaction or debit for each transaction. For now, default value is Multiple.	Multiple
affiliateCode	Alphanumeric	3	M	Ecobank country where customer account is held. Sandbox value is EGH. In live Ecobank will provide the value for each country	Ghana (EGH), Nigeria (ENG), Togo (ETG), Senegal (ESN), etc.
totalbatches	Numeric	1 or 2	M	We have a concept of creating multiple batches of transactions but linking them together as same set of transaction using the same batchID hence if the batches of transaction were sent with the same batchID then totalbaches will be 2 else keep it always 1.	1,2
execution_date	Datetime	23	M	This is date of transactions. It cannot be back date. Only current or future date	YYYYMMDDHHmmss e.g., 2023-02-27T18:48:51.113

SERVICE : INTERBANK

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
request_id	string	15	M	A unique reference that identifies instrument in a batch. This is unique to each transaction.	2323V
request_type	string	15	M	This identifies the payment type that is been sent for posting	INTERBANK
destinationBankCode	string	20	M	Bank code of the destination bank	ASB, ECOCGHAC
senderName	string	50	M	This parameter field indicates the sender’s name	BEN
senderAddress	string	50	M	This parameter field indicates the sender’s address	23 Accra Central
senderPhone	string	20	M	This parameter field identifies the sender’s address	233263653712
beneficiaryAccountNo	string	20	M	Beneficiary’s account number	110424812001
beneficiaryName	string	50	M	Beneficiary’s name	Owen, Kofi Oppong
beneficiaryPhone	string	20	M	Beneficiary’s phone number	233543837123
transferReferenceNo	string	15	M	A unique reference to pass to a transaction	QWE345Y4
amount	amount	NUMBER (22,2)	M	Amount	NUMBER (22,2)
Ccy	string	3	M	Currency of the receiving account	USD, GHS, etc.
transferType	string	4	M	This is a static value as sport	Spot (static value)
amount	amount	NUMBER (22,2)	M	Amount	NUMBER (22,2)
currency	string	3	M	Debit account currency	USD, GHS, etc.
status	string	3	O	This field should be null or NEW	NEW
rate_type	string	4	M	This is a static value as sport	Spot (static value)
secureHash	string	129	M	SHA 512 hashing algorithm = (clientid+batchsequence+batchamount+transactionamount+ batchid+ transactioncount+ batchcount+ transactionid+ debittype+ affiliateCode+ totalbatches+ execution_date+labkey)	Sample provided in request payload

SERVICE: TOKEN(XPRESS-CASH)

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
request_id	string	15	M	A unique reference that identifies instrument in a batch. This is unique to each transaction.	2323V
request_type	string	12	M	This identifies the payment type	token
transactionDescription	string	50	O	This is the transaction description	Service payment for electrical repairs
secretCode	string	15	O	A unique reference or code that is attached to a transaction and for identification.	AWER1234
sourceAccount	Numeric	16	O	This is the source account number	1441000565307
sourceAccountCurrency	string	3	O	This is the source account currency	GHS
sourceAccountType	string	10	O	This value is source account type, and it is static.	Corporate
senderName	string	50	M	This is the sender’s name	Freeman Kay
ccy	string	3	M	Transaction currency	GHS
senderMobileNo	Number	15	M	Sender’s mobile number	0202205113
amount	amount	NUMBER (22,2)	M	Transaction amount	NUMBER (22,2)
senderId	string	15	O	This is sender’s ID	QWE345Y4
beneficiaryName	string	50	O	This is beneficiary’s name	Stephen Kojo
beneficiaryMobileNo	Numeric	15	O	This beneficiary’s phone number	0233445566
withdrawalChannel	string	10	O	The channel for recipient to withdraw the money. This usually through an ATM or Merchant	ATM
amount	amount	NUMBER (22,2)	M	Debiting amount	NUMBER (22,2)
currency	string	3	M	Debit account currency	USD, GHS, etc.
status	string	3	O	This field should be null or NEW	NEW
rate_type	string	4	M	This is a static value as sport	Spot (static value)
secureHash	string	129	M	SHA 512 hashing algorithm = (clientid+batchsequence+batchamount+transactionamount+ batchid+ transactioncount+ batchcount+ transactionid+ debittype+ affiliateCode+ totalbatches+ execution_date+labkey)	Sample provided in request payload

SERVICE: DOMESTIC

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
request_id	string	15	M	A unique reference that identifies instrument in a batch. This is unique to each transaction.	2323V
request_type	string	12	M	This identifies the payment type that is been sent	domestic
creditAccountNo	Number	16	M	This is credit account number	1441001996321
debitAccountBranch	string	20	O	Debit account branch	ACCRA
debitAccountType	string	10	O	This value is source account type, and it is static.	Corporate
creditAccountBranch	string	20	O	Branch of the credit account number	Accra
creditAccountType	string	10	O	This value is source account type.	Corporate
amount	amount	NUMBER (22,2)	M	Transaction amount	NUMBER (22,2)
ccy	string	3	M	Transaction currency	GHS
amount	amount	NUMBER (22,2)	M	Transaction amount	NUMBER (22,2)
currency	string	3	M	Debit account currency	USD, GHS, etc.
status	string	3	O	This field should be null or NEW	null or NEW
rate_type	string	4	M	This is a static value as sport	Spot (static value)
secureHash	string	129	M	SHA 512 hashing algorithm = (clientid+batchsequence+batchamount+transactionamount+ batchid+ transactioncount+ batchcount+ transactionid+ debittype+ affiliateCode+ totalbatches+ execution_date+labkey)	Sample provided in request payload

SERVICE: BILL PAYMENT

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
request_id	string	15	M	A unique reference that identifies instrument in a batch. This is unique to each transaction.	ECI55096987905
request_type	string	12	M	This identifies the payment type that is been sent	BILLPAYMENT
billerCode	string	15	M	This code identifies the biller being called for payment. Additional endpoint exist that helps customers to call list of billers present in an affiliate.	Pass_Bio_ECI
billRefNo	string	15	M	This is bill reference number passed by customers	239729
cbaRefNo	string	15	O	This is reference passed by customers	239729AB
customerName	string	50	M	Customer name	Freeman Kay
customerRefNo	string	15	M	Customer reference number	239729BB
productCode	string	15	M	Product code of the exact biller being paid to. Additional endpoint exist to help customers spool details of a biller details that comprises of the product code and other vital details required for transaction posting.	PassBio
formDataValue	list		M	The list of form data values varies based on the biller mandatory values required for validation.	\"billFormData\": [ { \"serialNo\": 1, \"fieldName\": \"INVOICE NUMBER\", \"fieldTitle\": \"INVOICE NUMBER\", \"dataType\": \"String\", \"validateField\": \"N\", \"defaultValue\": \"\", \"maxFieldLength\": 100, \"listofValues\": \"\", \"lookupValue\": [] } ],
amount	amount	NUMBER (22,2)	M	Transaction amount	NUMBER (22,2)
currency	string	3	M	Debit account currency	USD, GHS, etc.
status	string	3	O	This field should be null or NEW	NEW
rate_type	string	4	M	This is a static value as sport	Spot (static value)
secureHash	string	129	M	SHA 512 hashing algorithm = (clientid+batchsequence+batchamount+transactionamount+ batchid+ transactioncount+ batchcount+ transactionid+ debittype+ affiliateCode+ totalbatches+ execution_date+labkey)	Sample provided in request payload

SERVICE: AIRTIME TOP-UP

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
request_id	string	15	M	A unique reference that identifies instrument in a batch. This is unique to each transaction.	WQ5500098663046
request_type	string	12	M	This identifies the payment type that is been sent	AIRTIMETOPUP
billerCode	string	15	M	This code identifies the telco being called for fulfilment. List of telco codes for each affiliate will be provided once migrated to production. Alternately, “Get Biller List” API under bill payment collection can be used to spool all biller list including telcos present in an affiliate.	A02E, MTN, etc.
billRefNo	string	15	M	This is bill reference number passed by customers	239729
cbaRefNo	string	15	O	This is reference passed by customers	AD0CCXX
customerName	string	50	M	Customer’s name	Freeman Kay
customerRefNo	string	15	O	Customer reference number	239729
productCode	string	15	M	This code identifies the telco being called for fulfilment. List of telco codes for each affiliate will be provided once migrated to production. Alternatively, Use “Get Biller Details” API under bill payment collection to spool a biller detail and identify the productCode to be passed for a particular telco product.	A02E, MTN, etc.
formDataValue: BEN_PHONE_NO	Number	20	M	Beneficiary telephone number	225543756765
amount	amount	NUMBER (22,2)	M	Transaction amount	NUMBER (22,2)
currency	string	3	M	Debit account currency	USD, GHS, etc.
status	string	3	O	This field should be null or NEW	null or NEW
rate_type	string	4	M	This is a static value as sport	Spot (static value)
secureHash	string	129	M	SHA 512 hashing algorithm = (clientid+batchsequence+batchamount+transactionamount+ batchid+ transactioncount+ batchcount+ transactionid+ debittype+ affiliateCode+ totalbatches+ execution_date+labkey)	Sample provided in request payload

SERVICE: MOMO

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
request_id	string	15	M	A unique reference that identifies a transaction. This is unique to each transaction.	WQ5500098663046
request_type	string	12	M	This identifies the payment type that is been sent	MOMO
billerCode	string	15	M	This code identifies the telco being called for fulfilment. List of telco codes for each affiliate will be provided once migrated to production. Alternately, “Get Biller List” API under bill payment collection can be used to spool all biller list including telcos present in an affiliate.	AIRTELTIGOEGH, MTN, etc.
billRefNo	string	15	M	This is bill reference number passed by customers	239729
cbaRefNo	string	15	O	This is reference passed by customers	AD0CCXX
customerName	string	50	M	Customer’s name	Freeman Kay
customerRefNo	string	15	O	Customer reference number	239729
productCode	string	15	M	This code identifies the telco being called for fulfilment. List of telco codes for each affiliate will be provided once migrated to production. Alternatively, Use “Get Biller Details” API under bill payment collection to spool a biller detail and identify the productCode to be passed for a particular telco product.	AIRTELTIGO_MOBILEMONEY, etc.
formDataValue: BEN_PHONE_NO	Number	20	M	Beneficiary telephone number. Use “Get Biller Details” API under bill payment collection can be used to spool a biller detail and identify the form data value to be passed for a particular biller (Telco)	225543756765
amount	amount	NUMBER (22,2)	M	Transaction amount	NUMBER (22,2)
currency	string	3	M	Debit account currency	USD, GHS, etc.
status	string	3	O	This field should be null or NEW	null or NEW
rate_type	string	4	M	This is a static value as sport	Spot (static value)
secureHash	string	129	M	SHA 512 hashing algorithm = (clientid+batchsequence+batchamount+transactionamount+ batchid+ transactioncount+ batchcount+ transactionid+ debittype+ affiliateCode+ totalbatches+ execution_date+labkey)	Sample provided in request payload

SERVICE: INTERBANKIA

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
request_id	string	15	M	A unique reference that identifies a transaction. This is unique to each transaction.	WQ5500098663046
request_type	string	12	M	This identifies the payment type that is been sent	INTERBANKIA
destinationCountry	string	3	M	Destination country	EKE, EGH, ENG, etc.
destinationBankCode	string	15	M	Bank code for receiving bank. This will be gotten from Institution list endpoint.	000001
beneficiaryAccountNo	string	15	O	Account number of receiver	0012057660
beneficiaryName	string	50	M	Name Of Receiver	MEHTA HARMEET SINGH
beneficiaryPhone	string	15	O	Phone number of Receiver	239729
amount	string	15	M	Amount to be sent	AIRTELTIGO_MOBILEMONEY, etc.
formDataValue: BEN_PHONE_NO	Number	20	M	Beneficiary telephone number. Use “Get Biller Details” API under bill payment collection can be used to spool a biller detail and identify the form data value to be passed for a particular biller (Telco)	225543756765
amount	amount	NUMBER (22,2)	M	Transaction amount	NUMBER (22,2)
currency	string	3	M	Debit account currency	USD, GHS, etc.
status	string	3	O	This field should be null or NEW	null or NEW
rate_type	string	4	M	This is a static value as sport	Spot (static value)
secureHash	string	129	M	SHA 512 hashing algorithm = (clientid+batchsequence+batchamount+transactionamount+ batchid+ transactioncount+ batchcount+ transactionid+ debittype+ affiliateCode+ totalbatches+ execution_date+labkey)	Sample provided in request payload

SERVICE: TOKENIA

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
request_id	string	15	M	A unique reference that identifies a transaction. This is unique to each transaction.	WQ5500098663046
request_type	string	12	M	This identifies the payment type that is been sent	MOMO
billerCode	string	15	M	This code identifies the telco being called for fulfilment. List of telco codes for each affiliate will be provided once migrated to production. Alternately, “Get Biller List” API under bill payment collection can be used to spool all biller list including telcos present in an affiliate.	AIRTELTIGOEGH, MTN, etc.
billRefNo	string	15	M	This is bill reference number passed by customers	239729
cbaRefNo	string	15	O	This is reference passed by customers	AD0CCXX
customerName	string	50	M	Customer’s name	Freeman Kay
customerRefNo	string	15	O	Customer reference number	239729
productCode	string	15	M	This code identifies the telco being called for fulfilment. List of telco codes for each affiliate will be provided once migrated to production. Alternatively, Use “Get Biller Details” API under bill payment collection to spool a biller detail and identify the productCode to be passed for a particular telco product.	AIRTELTIGO_MOBILEMONEY, etc.
formDataValue: BEN_PHONE_NO	Number	20	M	Beneficiary telephone number. Use “Get Biller Details” API under bill payment collection can be used to spool a biller detail and identify the form data value to be passed for a particular biller (Telco)	225543756765
amount	amount	NUMBER (22,2)	M	Transaction amount	NUMBER (22,2)
currency	string	3	M	Debit account currency	USD, GHS, etc.
status	string	3	O	This field should be null or NEW	null or NEW
rate_type	string	4	M	This is a static value as sport	Spot (static value)
secureHash	string	129	M	SHA 512 hashing algorithm = (clientid+batchsequence+batchamount+transactionamount+ batchid+ transactioncount+ batchcount+ transactionid+ debittype+ affiliateCode+ totalbatches+ execution_date+labkey)	Sample provided in request payload

SERVICE: MOMOIA

FIELD	TYPE	LENGTH(MAX)	M/O	DESCRIPTION	SAMPLE VALUE
request_id	string	15	M	A unique reference that identifies a transaction. This is unique to each transaction.	WQ5500098663046
request_type	string	12	M	This identifies the payment type that is been sent	MOMO
billerCode	string	15	M	This code identifies the telco being called for fulfilment. List of telco codes for each affiliate will be provided once migrated to production. Alternately, “Get Biller List” API under bill payment collection can be used to spool all biller list including telcos present in an affiliate.	AIRTELTIGOEGH, MTN, etc.
billRefNo	string	15	M	This is bill reference number passed by customers	239729
cbaRefNo	string	15	O	This is reference passed by customers	AD0CCXX
customerName	string	50	M	Customer’s name	Freeman Kay
customerRefNo	string	15	O	Customer reference number	239729
productCode	string	15	M	This code identifies the telco being called for fulfilment. List of telco codes for each affiliate will be provided once migrated to production. Alternatively, Use “Get Biller Details” API under bill payment collection to spool a biller detail and identify the productCode to be passed for a particular telco product.	AIRTELTIGO_MOBILEMONEY, etc.
formDataValue: BEN_PHONE_NO	Number	20	M	Beneficiary telephone number. Use “Get Biller Details” API under bill payment collection can be used to spool a biller detail and identify the form data value to be passed for a particular biller (Telco)	225543756765
amount	amount	NUMBER (22,2)	M	Transaction amount	NUMBER (22,2)
currency	string	3	M	Debit account currency	USD, GHS, etc.
status	string	3	O	This field should be null or NEW	null or NEW
rate_type	string	4	M	This is a static value as sport	Spot (static value)
secureHash	string	129	M	SHA 512 hashing algorithm = (clientid+batchsequence+batchamount+transactionamount+ batchid+ transactioncount+ batchcount+ transactionid+ debittype+ affiliateCode+ totalbatches+ execution_date+labkey)	Sample provided in request payload

","urlObject":{"path":["corporateapi","merchant","payment"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"b95c8eb0-ae97-4f35-a2a8-2316e863ba46","name":"Payment","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests. ","type":"text"},{"key":"Accept","value":"application/json","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.","type":"text"},{"key":"Content-Type","value":"application/json","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paymentHeader\": {\n \"clientid\": \"EGHTelc000043\",\n \"batchsequence\": \"1\",\n \"batchamount\": 520,\n \"transactionamount\": 520,\n \"batchid\": \"EG1593490\",\n \"transactioncount\": 6,\n \"batchcount\": 6,\n \"transactionid\": \"E12T443308\",\n \"debittype\": \"Multiple\",\n \"affiliateCode\": \"EGH\",\n \"totalbatches\": \"1\",\n \"execution_date\": \"2020-06-01 00:00:00\"\n },\n \"extension\": [\n {\n \"request_id\": \"2323\",\n \"request_type\": \"domestic\",\n \"param_list\": \"[{\\\"key\\\":\\\"creditAccountNo\\\", \\\"value\\\":\\\"1441001996321\\\"},{\\\"key\\\":\\\"debitAccountBranch\\\", \\\"value\\\":\\\"ACCRA\\\"},{\\\"key\\\":\\\"debitAccountType\\\", \\\"value\\\":\\\"Corporate\\\"},{\\\"key\\\":\\\"creditAccountBranch\\\", \\\"Accra\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"creditAccountType\\\", \\\"value\\\":\\\"Corporate\\\"},{\\\"key\\\":\\\"amount\\\", \\\"value\\\":\\\"10\\\"},{\\\"key\\\":\\\"ccy\\\", \\\"value\\\":\\\"GHS\\\"}]\",\n \"amount\": 10,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n },\n {\n \"request_id\": \"432\",\n \"request_type\": \"token\",\n \"param_list\": \"[{\\\"key\\\":\\\"transactionDescription\\\", \\\"value\\\":\\\"Service payment for electrical repairs.\\\"},{\\\"key\\\":\\\"secretCode\\\", \\\"value\\\":\\\"AWER1234\\\"},{\\\"key\\\":\\\"sourceAccount\\\",\\\"value\\\":\\\"1441000565307\\\"},{\\\"key\\\":\\\"sourceAccountCurrency\\\", \\\"value\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"sourceAccountType\\\", \\\"value\\\":\\\"Corporate\\\"},{\\\"key\\\":\\\"senderName\\\", \\\"value\\\":\\\"Freeman Kay\\\"},{\\\"key\\\":\\\"ccy\\\", \\\"value\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"senderMobileNo\\\", \\\"value\\\":\\\"0202205113\\\"},{\\\"key\\\":\\\"amount\\\", \\\"value\\\":\\\"40\\\"},{\\\"key\\\":\\\"senderId\\\", \\\"value\\\":\\\"QWE345Y4\\\"},{\\\"key\\\":\\\"beneficiaryName\\\", \\\"value\\\":\\\"Stephen Kojo\\\"},{\\\"key\\\":\\\"beneficiaryMobileNo\\\", \\\"value\\\":\\\"0233445566\\\"},{\\\"key\\\":\\\"withdrawalChannel\\\", \\\"value\\\":\\\"ATM\\\"}]\",\n \"amount\": 40,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n },\n {\n \"request_id\": \"2325\",\n \"request_type\": \"INTERBANK\",\n \"param_list\": \"[{\\\"key\\\":\\\"destinationBankCode\\\", \\\"value\\\":\\\"ASB\\\"},{\\\"key\\\":\\\"senderName\\\", \\\"value\\\":\\\"BEN\\\"},{\\\"key\\\":\\\"senderAddress\\\", \\\"value\\\":\\\"23 Accra Central\\\"},{\\\"key\\\":\\\"senderPhone\\\", \\\"value\\\":\\\"233263653712\\\"},{\\\"key\\\":\\\"beneficiaryAccountNo\\\",\\\"value\\\":\\\"110424812001\\\"},{\\\"key\\\":\\\"beneficiaryName\\\", \\\"value\\\":\\\"Owen\\\"},{\\\"key\\\":\\\"beneficiaryPhone\\\", \\\"value\\\":\\\"233543837123\\\"},{\\\"key\\\":\\\"transferReferenceNo\\\", \\\"value\\\":\\\"QWE345Y4\\\"},{\\\"key\\\":\\\"amount\\\", \\\"value\\\":\\\"10\\\"},{\\\"key\\\":\\\"ccy\\\", \\\"value\\\":\\\"GHS\\\"},{\\\"key\\\":\\\"transferType\\\", \\\"value\\\":\\\"spot\\\"}]\",\n \"amount\": 10,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n },\n {\n \"request_id\": \"ECI55096987905\",\n \"request_type\": \"BILLPAYMENT\",\n \"param_list\": \"[{\\\"key\\\":\\\"billerCode\\\", \\\"value\\\":\\\"Pass_Bio_ECI\\\"},{\\\"key\\\":\\\"billRefNo\\\", \\\"value\\\":\\\"239729\\\"},{\\\"key\\\":\\\"cbaRefNo\\\", \\\"value\\\":\\\"\\\"},{\\\"key\\\":\\\"customerName\\\", \\\"value\\\":\\\"Freeman Kay\\\"},{\\\"key\\\":\\\"customerRefNo\\\", \\\"value\\\":\\\"239729\\\"},{\\\"key\\\":\\\"productCode\\\", \\\"value\\\":\\\"PassBio\\\"},{\\\"key\\\":\\\"formDataValue\\\", \\\"value\\\":\\\"[{\\\\\\\"fieldName\\\\\\\":\\\\\\\"LastName\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"Kojo\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"FirstName\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"Kwame\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"Amount\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"300\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"Phone\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"225543756765\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"Email\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"enyaledzigbor@ecobank.com\\\\\\\"},{\\\\\\\"fieldName\\\\\\\":\\\\\\\"reference\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"210120400582\\\\\\\"}]\\\"}]\",\n \"amount\": 300,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n },\n {\n \"request_id\": \"WQ5500098663046\",\n \"request_type\": \"AIRTIMETOPUP\",\n \"param_list\": \"[{\\\"key\\\":\\\"billerCode\\\", \\\"value\\\":\\\"A02E\\\"},{\\\"key\\\":\\\"billRefNo\\\", \\\"value\\\":\\\"81729\\\"},{\\\"key\\\":\\\"cbaRefNo\\\", \\\"value\\\":\\\"\\\"},{\\\"key\\\":\\\"customerName\\\", \\\"value\\\":\\\"Owen Kay\\\"},{\\\"key\\\":\\\"customerRefNo\\\", \\\"value\\\":\\\"824225\\\"},{\\\"key\\\":\\\"productCode\\\", \\\"value\\\":\\\"A02E\\\"},{\\\"key\\\":\\\"formDataValue\\\", \\\"value\\\":\\\"[{\\\\\\\"fieldName\\\\\\\":\\\\\\\"BEN_PHONE_NO\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"2348034830707\\\\\\\"}]\\\"}]\",\n \"amount\": 10,\n \"currency\": \"NGN\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n },\n {\n \"request_id\": \"1234BBY8SXZX\",\n \"request_type\": \"MOMO\",\n \"param_list\": \"[{\\\"key\\\":\\\" billerCode\\\", \\\"value\\\":\\\"AIRTELTIGOEGH\\\"},{\\\"key\\\":\\\"billRefNo\\\", \\\"value\\\":\\\"2988759\\\"},{\\\"key\\\":\\\"cbaRefNo\\\", \\\"value\\\":\\\"05609\\\"},{\\\"key\\\":\\\"customerName\\\", \\\"value\\\":\\\"Owen Kay\\\"},{\\\"key\\\":\\\"customerRefNo\\\", \\\"value\\\":\\\"824225\\\"},{\\\"key\\\":\\\"productCode\\\", \\\"value\\\":\\\"AIRTELTIGO_MOBILEMONEY\\\"},{\\\"key\\\":\\\"formDataValue\\\", \\\"value\\\":\\\"[{\\\\\\\"fieldName\\\\\\\":\\\\\\\"BEN_PHONE_NO\\\\\\\",\\\\\\\"fieldValue\\\\\\\":\\\\\\\"0560000159\\\\\\\"}]\\\"}]\",\n \"amount\": 150,\n \"currency\": \"GHS\",\n \"status\": \"\",\n \"rate_type\": \"spot\"\n }\n ],\n \"secureHash\": \"398d4f285cc33e12f035da19fa9d954be35afaf66816531c4f1a1aedd3c6f132a85c62b23ca12d7b9a99bf5a84fc69b66738289a70e8f8115e90ffaa060f4026\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Fri, 14 Apr 2023 17:02:03 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": \"Request received successfully\",\n \"response_timestamp\": \"2023-04-14T17:02:03.891\"\n}"}],"_postman_id":"fca97841-db96-4828-bc1b-525e973efe91"}],"id":"149a5d48-68d6-459b-92e1-5100607d1311","_postman_id":"149a5d48-68d6-459b-92e1-5100607d1311","description":""},{"name":"Hashing Service","item":[{"name":"SecureHash","id":"c09008a0-5d68-4325-8b46-3d5537c02036","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","type":"text"}],"body":{"mode":"raw","raw":"{\n \"param1\":\"Aymard\",\n \"param2\":\"Gildas\",\n \"param3\":\"MILANDOU\",\n \"param4\":\"Ecobank\",\n \"param5\":\"Group\",\n \"secureHash\": \"95803de67ceca952bb6469901b32de511e6be8ab6763ae882f82b9b29063298919c1806a3307b2edd3d51620062ee43b663d45375c36c60b08dff7dd648cba10\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/securehash","description":"

Procedure

This method allows you test the hashing algorithm in isolation with different values dynamically generated from your platform.

param1,2,3 ...5 stand for values of your payload that will be concatenated from top down in a single string, that is what makes your payload.

Setup

Ensure you have the aqcuired the appropriate credential to make requests to Unified Developer LAB API.

To generate a secure Hash for your request payload a lab_key is required. \nlab_key sample:

    XT7zuounWNKXmbwdAR+qYhyQymRdsEUylXFZ/frwBBjDKZsPCDlUjAMH4OQT+uvU\n

Requirement to successfully generate a secure hash:

lab_key this is automatically sent to you after successful registration on the sandbox and same will be sent to you for production during the Go live onboarding process. This is same as the \"API Key\".
\n
payload is the concatenation of field values in your JSON request from top down as a single string.\nPS: For the Payment section the payload should only be made up of field values in the header section of your JSON request.
\n
SHAR-512 is your algorithm for one-way hashing.
\n

Hashing can be done with any language of preference, below is a sample JAVA code for hashing:

    private static final String LAB_KEY =\"XT7zuounWNKXmbwdAR+qYhyQymRdsEUylXFZ/frwBBjDKZsPCDlUjAMH4OQT+uvU\";\n\n    public static String Hash512Msg(String payload) {\n      String result;\n        try {\n            String data = payload + lab_key;\n            MessageDigest digest = MessageDigest.getInstance(\"SHA-512\");\n            // ** NOTE all bytes that are retrieved from the data string must be done so using UTF-8 Character Set.\n            byte[] hashBytes = (data).getBytes(\"UTF-8\");\n            //Create the hash bytes from the data\n            byte[] messageDigest = digest.digest(hashBytes);\n            //Create a HEX string from the hashed data\n            StringBuilder sb = new StringBuilder();\n            for (int i = 0; i < messageDigest.length; i++) {\n                String h = Integer.toHexString(0xFF & messageDigest[i]);\n                while (h.length() < 2) {\n                    h = \"0\" + h;\n                }\n                sb.append(h);\n            }\n            result = sb.toString();\n        } catch (Exception ex) {\n            //Log your errors;\n        }\n        //sample result :2611e1ad3a8077020c55a227408329f0b2bb4f00c0e409a93abd69dba133c5d5a7d7575fef87cb13a9d5319c2f78199d8e674ce6f7d63acea95ae5a214ad9f5a\n        \n        return result;\n    }\n

Fire up request payload with secure hash value for integrity check:

 {  ....,\n    \"secureHash\":\"2611e1ad3a8077020c55a227408329f0b2bb4f00c0e409a93abd69dba133c5d5a7d7575fef87cb13a9d5319c2f78199d8e674ce6f7d63acea95ae5a214ad9f5a\"\n}\n

Ensure your user has the correct permissions to access the payment/collection service requested.

Now you're ready to run this collection in Postman!

\n","urlObject":{"protocol":"https","path":["corporateapi","merchant","securehash"],"host":["developer","ecobank","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c09008a0-5d68-4325-8b46-3d5537c02036"}],"id":"c5fcfdab-5653-4586-815e-568fcaf8be94","_postman_id":"c5fcfdab-5653-4586-815e-568fcaf8be94","description":""},{"name":"Account Services","item":[{"name":"Get Account Balance","id":"89d7f8b9-49d8-4a8a-ae3c-acd26cb3e6fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{access_token}}","description":"

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"14232436312\",\n \"affiliateCode\": \"EGH\",\n \"accountNo\": \"6500184371\",\n \"clientId\": \"ECO00184371123\",\n \"companyName\": \"ECOBANK TEST CO\",\n \"secureHash\": \"7cf1b1f6e1cce663de5cac528fa1f69ccf06b8cbe5263a412b341caa2a787198185921ca71cb1fa1ef04731726068202588955195f313b022a7d25b095fdc28f\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/accountbalance","urlObject":{"path":["corporateapi","merchant","accountbalance"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"80953a3f-59e0-438c-94fe-853f78e4434e","name":"Get Account balance","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.","type":"text"},{"key":"Accept","value":"application/json","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.","type":"text"},{"key":"Content-Type","value":"application/json","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is.","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{access_token}}","description":"The HTTP Authorization request header contains the credentials to authenticate a user agent with a server, usually after the server has responded with a 401 Unauthorized status and the WWW-Authenticate header.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"14232436312\",\n \"affiliateCode\": \"EGH\",\n \"accountNo\": \"6500184371\",\n \"clientId\": \"ECO00184371123\",\n \"companyName\": \"ECOBANK TEST CO\",\n \"secureHash\": \"ab7fd06c906c0601cda2c5679b94474ef6968132500c61f80f7606f307ef6f47917cd650a01633d512d2a64d7e130cf640eb1164a7aeef637d5ee4f802f04005\"\n}","options":{"raw":{"language":"json"}}},"url":"https://160.119.246.117:443/corporateapi/merchant/accountbalance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Tue, 19 Apr 2022 18:46:57 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=31622400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": {\n \"hostHeaderInfo\": {\n \"sourceCode\": \"CORPORATEAPI\",\n \"requestId\": \"14232436312\",\n \"affiliateCode\": \"EGH\",\n \"responseCode\": \"000\",\n \"responseMessage\": \"SUCCESS\"\n },\n \"accountNo\": \"1441000574000\",\n \"responseCode\": \"000\",\n \"responseMessage\": \"SUCCESS\",\n \"accountName\": \"TEST USER\",\n \"ccy\": \"GHS\",\n \"branchCode\": \"H01\",\n \"customerID\": \"410592151\",\n \"availableBalance\": 15.92,\n \"currentBalance\": 15.92,\n \"odlimit\": 0,\n \"accountType\": \"S\",\n \"accountClass\": \"KEXSAV\",\n \"accountStatus\": \"ACTIVE\"\n },\n \"response_timestamp\": \"2022-04-19T19:46:57.557\"\n}"}],"_postman_id":"89d7f8b9-49d8-4a8a-ae3c-acd26cb3e6fe"},{"name":"Get Account Enquiry","id":"065afcf7-402b-4625-82d2-24f2dbbfe663","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"14232436312\",\n \"affiliateCode\": \"EGH\",\n \"accountNo\": \"1441000574000 \",\n \"clientId\": \"ECO00184371123\",\n \"companyName\": \"ECOBANK TEST CO\",\n \"secureHash\": \"255c24fb0f941002af9b2f3e98d2d6ee4b10d049d255bdd47d1ca0d1ac2a70f88b704bbfc1cca534adbbbd0b310fabee9e9ac3d7ae72ad6ed7a5c8ec548fe19e\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/accountinquiry","urlObject":{"path":["corporateapi","merchant","accountinquiry"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"af1df41f-3630-4fb9-b384-32bfe2074bfa","name":"Get Account enquiry","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.","type":"text"},{"key":"Accept","value":"application/json","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.","type":"text"},{"key":"Content-Type","value":"application/json","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is.","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{access_token}}","description":"The HTTP Authorization request header contains the credentials to authenticate a user agent with a server, usually after the server has responded with a 401 Unauthorized status and the WWW-Authenticate header.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"14232436312\",\n \"affiliateCode\": \"EGH\",\n \"accountNo\": \"1441000574000 \",\n \"clientId\": \"ECO00184371123\",\n \"companyName\": \"ECOBANK TEST CO\",\n \"secureHash\": \"2a58ca499561e941d9196999a1ed253161a47c98466d06ecaa02eb52a3b02261a03cbae9f5fdc0a3efe7b1f941764ff661cb1de24c8aa5029ecef6a1feb3efae\"\n}","options":{"raw":{"language":"json"}}},"url":"https://160.119.246.117:443/corporateapi/merchant/accountinquiry"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Tue, 19 Apr 2022 18:52:51 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=31622400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": {\n \"accountNo\": \"1441000574000\",\n \"accountName\": \"TEST USER\",\n \"ccy\": \"GHS\",\n \"accountStatus\": \"ACTIVE\",\n \"responseCode\": \"000\",\n \"responseMessage\": \"SUCCESS\",\n \"affiliateCode\": \"EGH\",\n \"requestId\": \"ECO00184371123\",\n \"sourceCode\": \"CORPORATEAPI\"\n },\n \"response_timestamp\": \"2022-04-19T19:52:51.596\"\n}"}],"_postman_id":"065afcf7-402b-4625-82d2-24f2dbbfe663"},{"name":"Accountinquirythridpay","id":"26923112-e8b8-4956-9f64-0f7f7b489290","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"726262198272\",\n \"affiliateCode\": \"EGH\",\n \"accountNo\": \"1020820171412\",\n \"destinationBankCode\": \"300315\",\n \"clientId\": \"EC06500184371123\",\n \"companyName\": \"Ecobanker\",\n \"secureHash\": \"a35da5755881a5535207fe8071f6ef21a407387d3300632b60829089ce2a35a704512fa9168f76a958bea23a3b178493a4109e335915a01e85d09919642b6833\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/accountinquirythridpay","urlObject":{"path":["corporateapi","merchant","accountinquirythridpay"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"75453d9e-294d-4243-a643-647214a31822","name":"https://developer.ecobank.com/corporateapi/merchant/accountinquirythridpay","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"726262198272\",\n \"affiliateCode\": \"EGH\",\n \"accountNo\": \"1020820171412\",\n \"destinationBankCode\": \"300315\",\n \"clientId\": \"EC06500184371123\",\n \"companyName\": \"Ecobanker\",\n \"secureHash\": \"581bfbee17b9c9c982e44612c21237c32bdf968b54caf6c3ebac49f5cb1e43561da32118e0053b6d23f16cc5808bc00743b4a74cea45d8fb41c15f85eb536c17\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/accountinquirythridpay"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Wed, 03 Nov 2021 18:20:05 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": {\n \"accountName\": \"PURCHASE ACCOUNT\",\n \"accountType\": \"S\",\n \"accountStatus\": \"ACTIVE\",\n \"hostHeaderInfo\": {\n \"sourceCode\": \"CORPORATEAPI\",\n \"requestId\": \"726262198272\",\n \"affiliateCode\": \"EGH\",\n \"responseCode\": \"000\",\n \"responseMessage\": \"success\"\n }\n },\n \"response_timestamp\": \"2021-11-03T18:20:05.058\"\n}"}],"_postman_id":"26923112-e8b8-4956-9f64-0f7f7b489290"},{"name":"Statement Generation","id":"01be6373-e019-4995-aca3-733366acf557","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","type":"text","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{access_token}}","description":"

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"123456\",\n \"clientId\": \"ZEEPAY\",\n \"affiliateCode\": \"EGH\",\n \"corporateId\": \"OMNI\",\n \"accountNumber\": \"1441000574000\",\n \"startDate\": \"20200301\",\n \"endDate\": \"20200316\",\n \"secureHash\":\"aa708d5f5434bc385d9b096ff663bd19abb07658e0c7c3b0580a616dded6e05218ebdef8b1c1547446993b99a04f7e65885ca44b5dc6548acbbfd2b5d1117e5c\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/statement","urlObject":{"path":["corporateapi","merchant","statement"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"50826a18-5b1a-420c-9cc0-7da0671181e6","name":"Statement","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","type":"text"}],"body":{"mode":"raw","raw":"{\n \"affiliateCode\": \"EGH\",\n \"corporateId\": \"OMNI\",\n \"accountNumber\": \"1441000574000\",\n \"startDate\": \"20200301\",\n \"endDate\": \"20200316\",\n \"secureHash\":\"2683608c9ac7f949fa95b3d361dc2e7e9c7925252c04081d67d73e9b4233ac20db0d2bb72b4e3b7aeda678ce27864c8427818225832e0059b1d29c0aa369929a\"\n}","options":{"raw":{"language":"json"}}},"url":"https://160.119.246.117:443/corporateapi/merchant/statement"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Tue, 19 Apr 2022 18:44:21 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=31622400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": [\n {\n \"acccy\": \"GHS\",\n \"drcrind\": \"CR\",\n \"trnrefno\": \"H75ZEXA1923800E0\",\n \"paidin\": \"10\",\n \"paidout\": \"\",\n \"valuedate\": \"2019-09-02 20:00:00.0\",\n \"lcyamount1\": \"10\",\n \"narrative\": \"MOBILE TRANSFER BD1441000820520-SA Xpress Account DT0209\"\n },\n {\n \"acccy\": \"GHS\",\n \"drcrind\": \"CR\",\n \"trnrefno\": \"H75ZEXA1923800E1\",\n \"paidin\": \"15\",\n \"paidout\": \"\",\n \"valuedate\": \"2019-09-02 21:30:00.0\",\n \"lcyamount1\": \"15\",\n \"narrative\": \"MOBILE TRANSFER BD1441000820520-SA Xpress Account DT0201\"\n },\n {\n \"acccy\": \"GHS\",\n \"drcrind\": \"CR\",\n \"trnrefno\": \"H75ZEXA1923800E2\",\n \"paidin\": \"17\",\n \"paidout\": \"\",\n \"valuedate\": \"2019-09-02 10:03:00.0\",\n \"lcyamount1\": \"17\",\n \"narrative\": \"MOBILE TRANSFER BD1441000820520-SA Xpress Account DT0205\"\n }\n ],\n \"response_timestamp\": \"2022-04-19T19:44:21.866\"\n}"}],"_postman_id":"01be6373-e019-4995-aca3-733366acf557"}],"id":"03be64b9-f0dd-4df6-9cca-9e8062943bae","description":"

STEPS

Register for Sandbox Access if you have not yet registered (Click to Register) - https://developer.ecobank.com/app/register.xhtml
User received an email (User ID, Password, Lab Key & Documentation Link)
Click on the Documentation Link sent on
Export project to postman
Begin your development work by generate the Token using your username and password (sent on mail)
Build your secure hash service using your secure service tree
Generate your secure hash for the payload plus LabKey (sent on mail)
NB: The LabKey received via email can be used to generate a new secure hash. However, all default values in each of the payloads should not be change for the secure hash to work in the Sandbox
Build your header and request xml to post balance enquiry request
Test the balance enquiry service and request for Go-live.
NB: Payload cannot be changed
Request for Go-Live (Click link for Go-live) - https://developer.ecobank.com/app/go-live.xhtml
Go-Live Requirement:
a. Provide your Sandbox access details
b. Accept Terms & Conditions
c. Provide your Company and Contact information
d. Upload test cases results
The bank will contact you within 48 hours

Endpoint:https://developer.ecobank.com/corporateapi/merchant/accountbalance

BALANCE ENQUIRY

REQUEST PAYLOAD

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGHT	M/O	DESCRIPTION	Sample Value
requestId	Alphanumeric	13	M	This parameter field identifies the generated request ID	(Between 10 and 13 characters) e.g. 142324363AB
affiliateCode	String	3	M	Affiliate code is used to identify the affiliate under which the account has been configured	(3 letters) e.g., EGH
accountNumber	Numeric	40	M	Account number maintained for corporate	Between 9 and 40 digits) e.g., 1441000574000
clientID	Alphanumeric	20	M	Client ID is used to identify each customer. This is provided prior to going live	(Between 10 and 20 characters) E.g. ECO00184371123
companyName	String	50	M	Company name provisioned for the corporate	(Maximum 50 Characters) E.g. ECOBANK TEST CO
secureHash	Alphanumeric	128	M	Click on link for Secure harsh generation. Link	128 length characters

RESPONSE PAYLOAD

FIELD	TYPE	LENGHT	M/O	DESCRIPTION	Sample Value
response_code	Numeric	3	M	This Numeric status code that implies the status of the transaction submission. 200 means successful submission and any other code means an error occurred.	(3 digits e.g. 200) The service request has been accepted successfully
response_message	String	7	m	This parameter field indicate an acknowledgment message from the API that gives the status of the request submission. Other response message is an error	(7 letters) success
sourceCode	String	13	M	This parameter field identifies the source code maintained	(13 letters) E.g. CORPORATEAPI
requestId	Alphanumeric	15	M	This parameter field identifies the generated request ID	Between 10 and 15 characters) e.g. 142324363AB
affiliateCode	String	3	M	Affiliate code is used to identify the affiliate under which the account has been configured	(3 letters) e.g., EGH
response_code	Numeric	3	M	This Numeric status code that implies the status of the transaction submission. 000 means successful submission and any other code means an error occurred.	(3 digits) 000
response_message	String	7	M	This parameter field indicate an acknowledgment message from the API that gives the status of the request submission. Other response message is an error	(7 letters) e.g. success
accountNumber	Numeric	40	M	Account number maintained for corporate	(Between 9 and 40 digits) e.g., 1441000574000
accountName	String	16	M	Account name assigned to the account	Between 9 and 16) e.g TEST USER
ccy	String	3	M	The currency of the account that has been provisioned	3 letters e.g., GHS
branchCode	String	3	M	Branch Code assigned to the account that has been created	(3 characters) E.g. H01
customerID	Alphanumeric	10	M	alpha-numeric string equal to 10 letters	10 letters E.g. 4105921AB
narrative	String	255	M	Transaction fulfillment message	(255 length of characters) CASH IN - AGENCY BANKING REF:A200229092623562 CASHIN of GHS810 by HADI B/O NAR: DEPOSIT AT 32674170467 ADMARO LIMITED
availableBalance	Decimal	NUMERIC (22,2)	M	This parameter tag displays the available balance	200.00
currentBalance	Decimal	NUMERIC (22,2)	M	This parameter tag displays the current balance	200.00
odlimit	Decimal	NUMERIC (22,2)	M	This parameter tag displays the odd limit amount	200.00
accountType	String	1	M	This is the account type under which the customer account has been maintained	(1 letter) S
accountClass	String	6	M	This is the account class under which the customer account has been maintained	(6 characters) GHSTAF
accountStatus	String	6	M	This is check is the if the account is valid and active	(6 characters) ACTIVE
response_timestamp	Timestamp	23	M	This is the Timestamp of the specified transaction request YEAR+MONTH+DATE+HOUR+MINUTE+SECOND	YYYYMMDDHHmmss e.g. 2022-04-05T18:48:51.113

ACCOUNT ENQUIRY

Endpoint:https://developer.ecobank.com/corporateapi/merchant/accountinquiry

REQUEST PAYLOAD

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGHT	M/O	DESCRIPTION	Sample Value
requestId	Alphanumeric	15	M	This parameter field identifies the generated request ID	Between 10 and 15 characters) e.g. 142324363AB
affiliateCode	String	3	M	Affiliate code is used to identify the affiliate under which the account has been configured	(3 letters) e.g., EGH
accountNumber	Numeric	40	M	Account number maintained for corporate	(Between 9 and 40 digits) e.g., 1441000574000
clientID	Alphanumeric	15	M	Client ID is used to identify each customer. This is provided prior to going live	Between 10 and 15 characters) E.g. ECO00184371123
companyName	String	50	M	Company name provisioned for the corporate	(Maximum 50 Characters) E.g. ECOBANK TEST CO
secureHash	String (Alphanumeric)	128	M	Click on link for Secure harsh generation. Link	128 lengths of characters

RESPONSE PAYLOAD

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	Sample Value
response_code	Numeric	3	M	This Numeric status code that implies the status of the transaction submission. 200 means successful submission and any other code means an error occurred.	(3 digits) 200 The service request has been accepted successfully
response_message	String	7	M	This parameter field indicate an acknowledgment message from the API that gives the status of the request submission. Other response message is an error	(7 letters) Success
accountNumber	Numeric	40	M	Account number maintained for corporate	Between 9 and 40 digits) e.g., 1441000574000
acccy	String	3	M	The currency of the account that has been provisioned	3 letters e.g., GHS
branchCode	String	6	M	Branch Code assigned to the account that has been created	(3 characters) E.g. H01
accountStatus	String	6	M	Branch Code assigned to the account that has been created	(6 letters ) ACTIVE
response_code	Numeric	3	M	This Numeric status code that implies the status of the transaction submission. 000 means successful submission and any other code means an error occurred.	(3 digits) 000
response_message	String	7	M	This parameter field indicate an acknowledgment message from the API that gives the status of the request submission. Other response message is an error	(7 letters) SUCCESS
affiliateCode	String	3	M	Affiliate code is used to identify the affiliate under which the account has been configured	(3 letters) e.g., EGH
requestId	Alphanumeric	13	M	This parameter field identifies the generated request ID	(Between 10 and 13 characters) e.g. 142324363AB
sourceCode	String	13	M	This parameter field identifies the source code maintained	(13 letters) E.g. CORPORATEAPI
response_timestamp	Timestamp	13	M	This is the Timestamp of the specified transaction request YEAR+MONTH+DATE+HOUR+MINUTE+SECOND	YYYYMMDDHHmmss e.g. 2022-04-05T18:48:51.113

Statement

Endpoint: https://developer.ecobank.com/corporateapi/statement

REQUEST PAYLOAD

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	SAMPLE VALUE
affiliateCode	String	3	M	Affiliate code is used to identify the affiliate of the account	(3 letters) e.g., EGH
corporateId	String	4	M	This field identifies the corporation ID provisioned for the corporate	(4 letters) e.g OMNI
accountNumber	Numeric	40	M	Account number maintained for corporate	Between 16 and 40 digits) e.g., 1441000574000
startDate	Timestamp	8	M	This is the Timestamp of the statement request start date and in the format of YEAR+MONTH+DATE	YYYYMMDD (8 digits) e.g. 20200301
endDate	Timestamp	8	M	This is the Timestamp of the statement request end date and in the format of YEAR+MONTH+DATE	YYYYMMDD (8 digits) e.g. 20200316
secureHash	Alphanumeric	128	M	Click on link for Secure harsh generation. Link	128 lengths of characters

RESPONSE PAYLOAD

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	Sample Value
response_code	Numeric	3	M	This Numeric status code that implies the status of the transaction submission. 000 means successful submission and any other code means an error occurred.	000 (3 digits)
response_message	String	7	M	This parameter field indicate an acknowledgment message from the API that gives the status of the request submission. Other response message is an error	Success (7 letters)
acccy	String	3	M	The currency of the account provisioned	3 letters e.g., GHS
narrative	String	255	M	Transaction fulfillment message	(255 length of characters) e.g. CASH IN - AGENCY BANKING REF:A200229092623562 CASHIN of GHS810 by HADI B/O NAR: DEPOSIT AT 32674170467 ADMARO LIMITED
drcrind	String	2	M	Accounting entries process	DR/CR (2 letters)
trnrefno	Alphanumeric	18	M	Unique transaction reference for each of the request	(18 characters) e.g. H04ZEXA2006200RY
valuedate	Timestamp	8	M	This is the Timestamp of the specified transaction request YEAR+MONTH+DATE	YYYY-MM-DD (8 digits) e.g. 2020-02-29
lcyamount1	Numeric	NUMBER	M	Amount of the transaction	800.00
paidin	Numeric	NUMBER	M	Display Amount if it’s a DR request. NULL for CR request	800.00
paidout	Numeric	Numeric	M	Display Amount if it’s a CR request. NULL for DR request	800.00

","_postman_id":"03be64b9-f0dd-4df6-9cca-9e8062943bae"},{"name":"Account Opening","item":[{"name":"Create Account Opening","id":"80dc2169-8b2c-435e-8259-5bda0f6ab94c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientId\": \"ECO76383823\",\n \"requestId\": \"ECO76383823\",\n \"affiliateCode\": \"ENG\",\n \"firstName\": \"Rotimi\",\n \"middlename\": \"\",\n \"lastname\": \"Akinola\",\n \"mobileNo\": \"2348089991325\",\n \"gender\": \"M\",\n \"identityNo\": \"198837383982\",\n \"identityType\": \"MOBILE_WALLET_NO\",\n \"iDIssueDate\": \"01072021\",\n \"iDExpiryDate\": \"01072021\",\n \"ccy\": \"NGN\",\n \"country\": \"NGN\",\n \"branchCode\": \"ENG\",\n \"dateOfBirth\": \"01072021\",\n \"countryOfResidence\": \"NIGERIA\",\n \"email\": \"treknfreedom@yahoo.com\",\n \"street\": \"Labone\",\n \"city\": \"Accra\",\n \"state\": \"Accra\",\n \"image\": \"oeyetweuiww8262822999999999\",\n \"signature\": \"orjerjeklellwewpw726527289292\",\n \"secureHash\": \"a43aa74662060b7b9c942dd7ace565a0919118db758bcd71a0f5c7cd7e349f6309b02866b6156ef9171a1b23119c71e77db2edd38cc89963d7f34b541d6dc461\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/createexpressaccount","description":"

OVERVIEW

API to quickly create an account with minimal information.

The Ecobank Xpress Account is a digital account that is mobile
based. It is simple and does not require any form of documentation for opening,
therefore making it easy and convenient for all, while affording the customers
the same services available to regular account holders**

STEPS

1. Register for Sandbox Access if you have not yet registered (Click to Register) https://developer.ecobank.com/app/register.xhtml**
2. User received an email (User ID, Password, Lab Key & Documentation Link)**

3. Click on the Documentation Link sent on email

4. Export project to postman

5. Begin your development work by generate the Token using your username and password (sent on mail)

6. Build your secure hash service using your secure service tree

7. Generate your secure hash for the payload plus LabKey (sent on mail)

NB: *The LabKey received via email can be used to generate a new secure hash. However,all default values in each of the payloads should not be change for the securehash to work in the Sandbox*

8. Build your header and request xml to post xpress account opening request

9. Test the xpress account opening service and request for Go-live.

NB: Payload cannot be changed

10. Request for Go-Live (Click link for Go-live) - https://developer.ecobank.com/app/go-live.xhtml

11. Go-Live Requirement:

a. Provide your Sandbox access details

b. Accept Terms & Conditions

c. Provide your Company and Contact information

d. Upload test cases results

12. The bank will contact you within 48 hours

Endpoint
https://developer.ecobank.com/corporateapi/ merchant/createxpressaccount:

REQUEST PAYLOAD

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	SAMPLE VALUE
requestId	Alphanumeric	15	M	This parameter field identifies the generated request ID	Between 10 and 15 characters) e.g. ECO76383823
affiliateCode	String	3	M	Affiliate code of which the account and client has been maintained	(3 letters) e.g., EGH
firstName	String	15	M	First name setup for client	Rotimi
middlename	String	15	O	Middle name Setup for client	Tomi
lastname	String	15	M	Last name setup for client	Akinola
mobileNo	Number	15	M	Mobile number maintained under the account	2348089991325
gender	String	1	M	This parameter indicates the gender. Either male or female	M/F
identityNo	Alphanumeric	20	M	Takes up to maximum 20-character length	198837383982
identityType	Alphanumeric	15	M	Takes up to maximum 20-character length	MOBILE_WALLET_NO
IDIssueDate	Timestamp	23	M	This is the Timestamp indicating the transaction expiry DAY+MONTH+YEAR	01072021
ccy	String	3	M	The currency of the account provisioned	3 letters e.g., NGN
country	String	3	M	The country of the account provisioned	NGN
branchCode	String	3	M	Branch code configured for the account	ENG
datetime	Timestamp	23	M	This is the Timestamp indicating the transaction datetime DAY+MONTH+YEAR	01072021
countryOfResidence	String	20	M	Residence country of the customer registering	NIGERIA
email	Alphanumeric	15	M	Parameter field identifying the email address that needs to be maintained	treknfreedom@yahoo.com
city	String	10	M	Takes up to maximum 10-character length	Accra
state	String	10	M	Maximum 10-character length.	Accra
street	String	10	M	Maximum 10-character length.	Labone
image	String	5000	O	Image file in Base64
signature	String	5000	O	Image file in Base64
secureHash	Alphanumeric	128	M	Click on link for Secure harsh generation. Link	128 lengths of characters

RESPONSE PAYLOAD

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	Sample Value
response_code	Numeric	3	M	This parameter field implies a successful account opening. 200 means successful submission and any other code means an error occurred.	200 (3 digits)
response_message	String	7	M	This parameter field indicates an acknowledgment message from the API that gives the status of the request submission. Other response message is an error	Success (7 letters)
sourceCode	String	17	M	This parameter field identifies the source code maintained	(17 letters) E.g. ECOBANKMOBILEAPP
requestId	Alphanumeric	9	M	This field identifies the generated request id	(9 characters) e.g USD5203186701105
affiliateCode	String	3		Displays the affiliate code on which the account has been maintained	ENG
response_code	Numeric	3	M	This parameter field implies a successful account opening. 000 means successful submission and any other code means an error occurred.	00
response_Message	String	7	M	This parameter field indicates an acknowledgment message	SUCCESS
shortname	String	10	O	Parameter field to populate the short name
accountNo	Number	20	M	Maximum 20-character length.	8111183723
response_timestamp	Timestamp	23	M	This field identifies the Timestamp and of this format YEAR+MONTH+DATE+HOUR+MINUTE+SECOND	YYYYMMDDHHmmss e.g. 2022-04-05T18:48:51.113

","urlObject":{"path":["corporateapi","merchant","createexpressaccount"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"03920546-eb4e-4e01-9191-65053e609ea5","name":"https://developer.ecobank.com/corporateapi/merchant/createexpressaccount","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \"ECO76383823\",\n \"affiliateCode\": \"ENG\",\n \"firstName\": \"Rotimi\",\n \"middlename\": \"\",\n \"lastname\": \"Akinola\",\n \"mobileNo\": \"2348089991325\",\n \"gender\": \"M\",\n \"identityNo\": \"198837383982\",\n \"identityType\": \"MOBILE_WALLET_NO\",\n \"IDIssueDate\": \"01072021\",\n \"IDExpiryDate\": \"01072021\",\n \"ccy\": \"NGN\",\n \"country\": \"NGN\",\n \"branchCode\": \"ENG\",\n \"datetime\": \"01072021\",\n \"countryOfResidence\": \"NIGERIA\",\n \"email\": \"treknfreedom@yahoo.com\",\n \"street\": \"Labone\",\n \"city\": \"Accra\",\n \"state\": \"Accra\",\n \"image\":\"oeyetweuiww8262822999999999\",\n \"signature\":\"orjerjeklellwewpw726527289292\",\n \"secureHash\": \"a43aa74662060b7b9c942dd7ace565a0919118db758bcd71a0f5c7cd7e349f6309b02866b6156ef9171a1b23119c71e77db2edd38cc89963d7f34b541d6dc461\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/createexpressaccount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Wed, 17 Nov 2021 18:05:52 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": {\n \"hostHeaderInfo\": {\n \"sourceCode\": \"ECOBANKMOBILEAPP\",\n \"requestId\": \"USD5203186701105\",\n \"affiliateCode\": \"ENG\",\n \"responseCode\": \"000\",\n \"responseMessage\": \"SUCCESS\"\n },\n \"shortname\": \"\",\n \"accountNo\": \"8111183723\",\n \"customerID\": \"001404246\"\n },\n \"response_timestamp\": \"2021-11-17T18:05:52.802\"\n}"}],"_postman_id":"80dc2169-8b2c-435e-8259-5bda0f6ab94c"},{"name":"Internal Account Opening","id":"2147db98-8be7-4856-8c38-bad295d0b405","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientId\": \"ECO76383823\",\n \"requestId\": \"ECO76383823\",\n \"affiliateCode\": \"ENG\",\n \"firstName\": \"Rotimi\",\n \"lastname\": \"Akinola\",\n \"mobileNo\": \"2348089991325\",\n \"gender\": \"M\",\n \"identityNo\": \"198837383982\",\n \"identityType\": \"MOBILE_WALLET_NO\",\n \"iDIssueDate\": \"01072021\",\n \"iDExpiryDate\": \"01072021\",\n \"ccy\": \"NGN\",\n \"country\": \"NGN\",\n \"branchCode\": \"ENG\",\n \"dateOfBirth\": \"01072021\",\n \"countryOfResidence\": \"NIGERIA\",\n \"email\": \"treknfreedom@yahoo.com\",\n \"city\": \"Accra\",\n \"state\": \"Accra\",\n \"street\": \"Labone\",\n \"image\": \"oeyetweuiww8262822999999999\",\n \"signature\": \"orjerjeklellwewpw726527289292\",\n \"secureHash\": \"a43aa74662060b7b9c942dd7ace565a0919118db758bcd71a0f5c7cd7e349f6309b02866b6156ef9171a1b23119c71e77db2edd38cc89963d7f34b541d6dc461\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/createaccount","description":"

OVERVIEW

This API enable customers to create Ecobank internal accounts.

HEADERS

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

KEY	VALUE
Authorization	Bearer {{access_token}} The HTTP Authorization request header contains the credentials to authenticate a user agent with a server, usually after the server has responded with a 401 Unauthorized status and the WWW-Authenticate header.
Content-Type	application/json In responses, a Content-Type header tells the client what the content type of the returned content actually is.
Accept	application/json The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.
Origin	developer.ecobank.com The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server’s name. It is sent with CORS requests, as well as with POST requests.

REQUEST PAYLOAD

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	SAMPLE VALUE
clientId	Alphanumeric	15	M	A unique client ID from the customer.	ECO76383823
requestId	Alphanumeric	15	M	This is a randomly generated ID/reference that is required from the customer.	ECO76383823
affiliateCode	String	3	M	The affiliate or country the account opening request is originating from.	(3 letters) e.g. Ghana = EGH, Nigeria = ENG, Togo = ETG
firstName	String	15	M	First name of the account holder	Rotimi
lastname	String	15	M	First name of the account holder	Akinola
mobileNo	Number	15	M	Mobile number of the account holder	2348089991325
gender	String	1	M	This parameter indicates the gender. Either male or female	M / F
identityNo	Alphanumeric	20	M	The ID card being used for the registration	Example of Ghana Card ID GHA-0000000-3
identityType	Alphanumeric	15	M	This identifies the type of card being used for the registration. E.g., Passport, Ghana card, Driver License	Ghana Card
IDIssueDate	Timestamp	23	M	Card issued date. DAY+MONTH+YEAR	01072021
IDExpiryDate	Timestamp	23	M	Card expiry date. DAY+MONTH+YEAR	01072021
ccy	String	3	M	The account currency of the originating account opening request.	3 letters e.g., NGN
country	String	3	M	The account country of the originating account opening request.	NGN
branchCode	String	3	M	Account branch code	ENG
dateOfBirth	String		M	Account holder’s date of birth. DAY+MONTH+YEAR	01072021
countryOfResidence	String	20	M	Residence country of the customer registering	NIGERIA
email	Alphanumeric	15	M	Account email address.	treknfreedom@yahoo.com
street	String	50	M	Street name	Labone
city	String	20	M	City name	Accra
state	String	10	M	State name	Greater
image	Base 64	128	M	Image should be converted to base 64 encoding scheme.	oeyetweuiww8262822999999999
signature	Base 64	128	M	Signature should be converted to base 64 encoding scheme.	orjerjeklellwewpw726527289292
secureHash	Alphanumeric	128	M	SHA512 hashing algorithm. These are the values to harsh (clientId+requestId + affiliateCode + firstName + lastname + mobileNo + gender + identityNo + identityType + iDIssueDate + iDExpiryDate + ccy + country + branchCode + dateOfBirth + countryOfResidence + email + city + state+street +image +signature + labkey)	128 lengths of characters[BPN[CM1]

","urlObject":{"protocol":"https","path":["corporateapi","merchant","createaccount"],"host":["developer","ecobank","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2147db98-8be7-4856-8c38-bad295d0b405"}],"id":"d9868999-e9cc-4e00-912d-2080e32cd6ad","_postman_id":"d9868999-e9cc-4e00-912d-2080e32cd6ad","description":""},{"name":"Status Service","item":[{"name":"Transaction Status Query","id":"758a9aef-edc6-45de-8ab0-1631c80936a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientId\": \"EGHTelc000043\",\n \"requestId\": \"WQ5500098663046\",\n \"secureHash\":\"290b7aac393a8ca4ff999e50aee4958f6054848153e466fbd51a7db540c6e74b82378e5f07de040f89c5cd52090de5f7d72a7e4fe9671ef3bdb7775136e14fbf\"\n}\n\n\n","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/txns/status","description":"

OVERVIEW

Transaction notification query helps customers at any time call an API to know the status of their transactions.

STEPS

Pass a payload request to generate token.
Use token value to authenticate status API call.
Pass status request payload.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	SAMPLE VALUE
clientId	string	15 Maximum character length	M	Client ID assigned to customer	EGHZEEP000002
requestId	string	15 Maximum character length	M	The value is the request ID from the payment payload	\"request_id\": \"2323\",
secureHash	string	128 character length	M	secureHash=Hash512Msg(clientId+requestId+labkey )	6821cf6887c9c56edd3886de3796e5f8596ce1f4271f26bbd7c5858f832a718a70cb900836df2fb1b5b9bce7f30784701af70f15613ffc412583820dcb8e88ec

","urlObject":{"path":["corporateapi","merchant","txns","status"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"c389ed86-dcdb-4203-bab1-ea4d4075ce7e","name":"Transaction Status","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientId\": \"EGHTelc000043\",\n \"requestId\": \"WQ5500098663046\",\n \"secureHash\":\"290b7aac393a8ca4ff999e50aee4958f6054848153e466fbd51a7db540c6e74b82378e5f07de040f89c5cd52090de5f7d72a7e4fe9671ef3bdb7775136e14fbf\"\n}\n\n\n","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/txns/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Tue, 07 Mar 2023 15:15:52 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": [\n {\n \"requestType\": \"AIRTIMETOPUP\",\n \"affiliateCode\": \"ENG\",\n \"amount\": 100,\n \"currency\": \"NGN\",\n \"status\": \"success\",\n \"statusCode\": \"000\",\n \"statusReason\": \"Success\",\n \"transactionRefNo\": \"12345678\"\n }\n ],\n \"response_timestamp\": \"2023-03-07T15:15:52.283\"\n}"}],"_postman_id":"758a9aef-edc6-45de-8ab0-1631c80936a1"},{"name":"Etoken Status","id":"5f689c50-1c6a-4c47-af68-83ac66d8315f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"

The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests.

\n","type":"text"},{"key":"Accept","value":"application/json","description":"

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

In responses, a Content-Type header tells the client what the content type of the returned content actually is.

\n","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","description":"

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \" 17200984 \",\n \" affiliateCode \": \"EGH\",\n \"secureHash\":\"460be5cb9c0f7465c7c24b710c24c23a4da4ac0f72dc9fd029673eec1dfe2664cbdfca3af83f6c38b8e9be9947d6c245d310420bb906a34d14e7c16a0d4fa939\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/etokenstatus","description":"

OVERVIEW

Transaction notification query helps customers to check the status of etoken transactions.

STEPS

Pass a payload request to generate token
Use token value to authenticate etoken API call
Pass payload request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

FIELD	TYPE	LENGTH	M/O	DESCRIPTION	SAMPLE VALUE
requestId	Alphanumeric	15	M	Auto generated request ID by the customer to send payload request	172009AB
affiliateCode	Sting	3	M	This field identifies the affiliate code where the account has been maintained	(3 letters) e.g EGH
secureHash	Alphanumeric	128	M	secureHash=Hash512Msg(requestId+affiliateCode)	128 lengths of characters

","urlObject":{"path":["corporateapi","merchant","etokenstatus"],"host":["https://developer.ecobank.com"],"query":[],"variable":[]}},"response":[{"id":"9781a6c5-4d14-4af5-b101-5d549f5b64c2","name":"Etoken Status","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"developer.ecobank.com","description":"The Origin request header indicates where a fetch originates from. It doesn't include any path information, but only the server name. It is sent with CORS requests, as well as with POST requests. ","type":"text"},{"key":"Accept","value":"application/json","description":"The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.","type":"text"},{"key":"Content-Type","value":"application/json","description":"In responses, a Content-Type header tells the client what the content type of the returned content actually is.","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","description":"The HTTP Authorization request header contains the credentials to authenticate a user agent with a server, usually after the server has responded with a 401 Unauthorized status and the WWW-Authenticate header.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"requestId\": \" 17200984 \",\n \" affiliateCode \": \"EGH\",\n \"secureHash\":\"460be5cb9c0f7465c7c24b710c24c23a4da4ac0f72dc9fd029673eec1dfe2664cbdfca3af83f6c38b8e9be9947d6c245d310420bb906a34d14e7c16a0d4fa939\"\n}","options":{"raw":{"language":"json"}}},"url":"https://developer.ecobank.com/corporateapi/merchant/etokenstatus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Date","value":"Mon, 26 Sep 2022 17:12:25 GMT"},{"key":"Pragma","value":"No-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Access-Control-Allow-Origin","value":"developer.ecobank.com"},{"key":"Strict-Transport-Security","value":"max-age=16070400; includeSubDomains"},{"key":"Access-Control-Allow-Methods","value":"POST"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": 200,\n \"response_message\": \"success\",\n \"response_content\": \"PENDING\",\n \"response_timestamp\": \"2022-09-26T17:12:25.259\"\n}"}],"_postman_id":"5f689c50-1c6a-4c47-af68-83ac66d8315f"}],"id":"88e33130-bba2-4bc4-9d77-e012b7124911","_postman_id":"88e33130-bba2-4bc4-9d77-e012b7124911","description":""}],"event":[{"listen":"prerequest","script":{"id":"85a23f28-8f13-4ac6-a4ae-e86fee7ec2cb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b23bbc54-25b4-47df-970e-9edd2f318e8b","type":"text/javascript","exec":[""]}}],"variable":[{"key":"test_url_base","value":"https://172.16.69.127:7002","type":"string"},{"key":"pilot_url_base","value":"http://unifiedapi.ecobank.com/v1","type":"string"},{"key":"consumer_userId","value":"sadarkwah@ecobank.com","type":"string"},{"key":"token_secret","value":"$2a$10$cmQMqhfWmFPv0Tz5/GiTQOQ/Ig45y55Q5LMn3o./x.UVTtI5860JK","type":"string"},{"key":"access_token","value":"{{access_token}}","type":"string"},{"key":"consumer_api_key","value":"{{consumer_api_key}}","type":"string"},{"key":"merchant_test_url1","value":"https://172.16.78.155:7002","type":"string"},{"key":"base_url","value":"https://developer.ecobank.com","type":"string"},{"key":"rapid_transfer_host","value":"https://developer.ecobank.com:8081","type":"string"},{"key":"agent_base_url","value":"https://appsuat.ecobank.com","type":"string"}]}