To start integrating with Eganow API, you need an Eganow merchant account.
\nFollow the steps below
\nInput your email for a verification code to be sent to your email.
\nUpon successful verification, proceed to enter your personal information.
\nOnce all requirements have been met, your account will be pending approval.
\nOnce approved, your account will be active.
\nThe API credentials will be generated on your merchant dashboard. These credentials are:
\nSecret username
\nSecret password
\nx-Auth
\nLog into your merchant dashboard.
\nClick on the icon in the top right corner.
\nClick on the key icon.
\nSelect a service
\nClick on generate credentials.
\nThe secret username, secret password and x-Auth will be generated.
\nTake note: The credentials generated belong to the specific service selected and cannot be used for transactions on another service.
\nAccount name: Fenesam Enterprise
Email: fenesam@egacoreapi.com
Password: Password@123
Service name: Fenesam Enterprise CEDI 3DS
\nSecret Username: GH02331c931bb215de44c9b093c8d2f3ca3563
\nSecret Password: 048fea7126b2aea0e6d35fb63400a5883397b7bb5adb0222e76e581d42c4bb6a
\nx-Auth: GH0233R0gwMjMzMWM5MzFiYjIxNWRlNDRjOWIwOTNjOGQyZjNjYTM1NjM6MDQ4ZmVhNzEyNmIyYWVhMGU2ZDM1ZmI2MzQwMGE1ODgzMzk3YjdiYjVhZGIwMjIyZTc2ZTU4MWQ0MmM0YmI2YQ==
\nService name: Fenesam Enterprise USD 2DS
\nSecret Username: GH0233cbe45acb13cc4b0ab104cfb52e38610f
\nSecret Password: fe242cdc4c274584bced97747e0a98217f0f94e10a2ded7eed0ac82b1752770f
\nx-Auth:
\nGH0233R0gwMjMzY2JlNDVhY2IxM2NjNGIwYWIxMDRjZmI1MmUzODYxMGY6ZmUyNDJjZGM0YzI3NDU4NGJjZWQ5Nzc0N2UwYTk4MjE3ZjBmOTRlMTBhMmRlZDdlZWQwYWM4MmIxNzUyNzcwZg==
\nService name: Fenesam Enterprise USD 3DS
\nSecret Username: GH02332375d195759c48279ac9f938db46a2fe
\nSecret Password: 35dff7a2bddd505fddcea508a63da901330095b8ac79dd2bf96ad6a7b66e2369
\nx-Auth:
\nGH0233R0gwMjMzMjM3NWQxOTU3NTljNDgyNzlhYzlmOTM4ZGI0NmEyZmU6MzVkZmY3YTJiZGRkNTA1ZmRkY2VhNTA4YTYzZGE5MDEzMzAwOTViOGFjNzlkZDJiZjk2YWQ2YTdiNjZlMjM2OQ==
\nAccount name: Graceway Limited
Email: graceway@egacoreapi.com
Password: Password@123
Service name: Graceway Limited CEDI 3DS
\nSecret Username: GH023366e5b2db90b34145beb40ade1ced6873
\nSecret Password: 5aa1a002e041e3f8f912f7730960b8e96c4b14e284d0a19dc211362fa7a707c4
\nx-Auth:
\nGH0233R0gwMjMzNjZlNWIyZGI5MGIzNDE0NWJlYjQwYWRlMWNlZDY4NzM6NWFhMWEwMDJlMDQxZTNmOGY5MTJmNzczMDk2MGI4ZTk2YzRiMTRlMjg0ZDBhMTlkYzIxMTM2MmZhN2E3MDdjNA==
\nService name: Graceway Limited USD 2DS
\nSecret Username: GH02334c41451fadb249bea424be567bca5a63
\nSecret Password: 3f707a86f4f1c7e0281a2fba33ba4e4c677f71b7fae5a03bbb0eb4206baf6c15
\nx-Auth:
\nGH0233R0gwMjMzNGM0MTQ1MWZhZGIyNDliZWE0MjRiZTU2N2JjYTVhNjM6M2Y3MDdhODZmNGYxYzdlMDI4MWEyZmJhMzNiYTRlNGM2NzdmNzFiN2ZhZTVhMDNiYmIwZWI0MjA2YmFmNmMxNQ==
\nService name: Graceway Limited USD 3DS
\nSecret Username: GH0233c2eb24c6143f43e099537421ea31966c
\nSecret Password: d39939e47bc7826ad0124b5c8bb9f4eb59fc4abc91c66b634604397615ac1d5d
\nx-Auth:
\nGH0233R0gwMjMzYzJlYjI0YzYxNDNmNDNlMDk5NTM3NDIxZWEzMTk2NmM6ZDM5OTM5ZTQ3YmM3ODI2YWQwMTI0YjVjOGJiOWY0ZWI1OWZjNGFiYzkxYzY2YjYzNDYwNDM5NzYxNWFjMWQ1ZA==
\nAccount name: Skypanda Express Limited
Email: skypanda@egacoreapi.com
Password: Password@123
Service name: Skypanda Express Limited
\nSecret Username: GH02337ee438af8be748b0aaa01922512edb3f
\nSecret Password: a87f52d7084e4d12a67c651de33bc6d0d36dbc424e86961e81c4beda3207928d
\nx-Auth:
\nGH0233R0gwMjMzN2VlNDM4YWY4YmU3NDhiMGFhYTAxOTIyNTEyZWRiM2Y6YTg3ZjUyZDcwODRlNGQxMmE2N2M2NTFkZTMzYmM2ZDBkMzZkYmM0MjRlODY5NjFlODFjNGJlZGEzMjA3OTI4ZA==
\nService name: Skypanda Express Limited USD 2DS
\nSecret Username: GH02337fdc9020652246e7917c3f38ca8abf9f
\nSecret Password: 32f912be780382143ec42ffb9f2307e6966a46fe047a07104d3b74e9eff1068f
\nx-Auth:
\nGH0233R0gwMjMzN2ZkYzkwMjA2NTIyNDZlNzkxN2MzZjM4Y2E4YWJmOWY6MzJmOTEyYmU3ODAzODIxNDNlYzQyZmZiOWYyMzA3ZTY5NjZhNDZmZTA0N2EwNzEwNGQzYjc0ZTllZmYxMDY4Zg==
\nService name: Skypanda Express Limited USD 3DS
\nSecret Username: GH0233d6790d7cfb7c436abd72f119e5921087
\nSecret Password: ca6d08722b0864f19dca476fc262575eea2b34c867908a26d8678e59b4ff398a
\nx-Auth:
\nGH0233R0gwMjMzZDY3OTBkN2NmYjdjNDM2YWJkNzJmMTE5ZTU5MjEwODc6Y2E2ZDA4NzIyYjA4NjRmMTlkY2E0NzZmYzI2MjU3NWVlYTJiMzRjODY3OTA4YTI2ZDg2NzhlNTliNGZmMzk4YQ==
\nPAY PARTNER CODES
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"The official documentation for the Eganow Payment Gateway API","slug":"the-official-documentation-for-the-eganow-payment-gateway-api"},{"content":"Below are test accounts with API credentials.","slug":"below-are-test-accounts-with-api-credentials"}],"owner":"42616338","collectionId":"5132f587-0882-48bd-89ca-5525a7ed0d0b","publishedId":"2sB3Hrkx6K","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-09-24T10:29:03.000Z"},"item":[{"name":"Authentication","item":[{"name":"Generate Token","item":[{"name":"/api/auth/token","id":"c068c6e7-acb0-4994-b248-957c43aa925c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{auth_username}}"},{"key":"password","value":"{{auth_password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/auth/token","description":"Request parameters
\n","urlObject":{"path":["api","auth","token"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"ebd9b3f5-4eac-490c-95bc-b0f4d303c8bb","name":"OK","originalRequest":{"method":"GET","header":[],"url":"https://developer.sandbox.egacoreapi.com/api/auth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 15 Oct 2025 13:30:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"public,max-age=300"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE"},{"key":"Access-Control-Allow-Headers","value":"x-language-id, x-country-code, x-ega-user-access-token, Content-Type, Authorization"},{"key":"Access-Control-Max-Age","value":"1728000"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Authentication successful\",\n \"egaMerchantId\": \"SANDBOX EndPoint
URL: https://developer.sandbox.egacoreapi.com/api/auth/token
Method: GET
Authorization: Basic Auth
\nThis generates a token using the username and password from the Business Dashboard.
\nToken expires after 1 hour.
\nAuthorization for token generation.
\n","_postman_id":"fe4df881-2b28-4659-9ab1-acdbc7e10e6b"},{"name":"Verify Token","item":[{"name":"/api/auth/verify","id":"61be9d59-bf59-4618-88c5-e634285c722e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{baseUrl}}/api/auth/verify","description":"Request parameters
\nHTTP Response Codes
\n","urlObject":{"path":["api","auth","verify"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"140bd455-dfa2-44b7-a77a-18ede4178cdd","name":"OK","originalRequest":{"method":"POST","header":[],"url":"{{baseUrl}}/api/auth/verify"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 17 Sep 2025 16:31:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"public,max-age=300"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE"},{"key":"Access-Control-Allow-Headers","value":"x-language-id, x-country-code, x-ega-user-access-token, Content-Type, Authorization"},{"key":"Access-Control-Max-Age","value":"1728000"}],"cookie":[],"responseTime":null,"body":"{\n \"merchantAuthInfo\": {\n \"customerGuidClaim\": \"SANDBOX EndPoint
URL: https://developer.sandbox.egacoreapi.com/api/auth/verify
Method: POST
Authorization: Bearer Token
\nThis request checks the validity of your access token.
\nAuthorization for token verification.
\n","_postman_id":"e624f555-7ef0-4d73-9c3c-d0da51bfd7bd"}],"id":"4444a181-504c-4b1f-9d55-f49ba26b1c71","description":"This folder contains all the API requests related to generating your access token and checking if your access is valid.
\n","_postman_id":"4444a181-504c-4b1f-9d55-f49ba26b1c71"},{"name":"Paypartners","item":[{"name":"Paypartner Search","item":[{"name":"/api/partners/search","id":"01e67e8d-eaa8-41a5-84e5-5e5ea6862336","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Auth","value":"{{x_auth}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"countryCode\": \"GH0233\",\n \"languageId\": \"en\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/api/partners/search","description":"Request Parameters
\nHTTP Response Codes
\nRequest Parameters
\nHTTP Response Codes
\nThis request calculates the fees or charges for a transaction.
\nSANDBOX EndPoint
URL: https://developer.sandbox.egacoreapi.com/api/partners/charges
Method: POST
It requires Bearer token and x-Auth.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"334b0895-33f5-4c99-98df-892300ebb203","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"e293f243-8924-4970-86f5-d71de2f9d597","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"54261cd1-4208-434d-b0b3-fb485b91b57b"}],"id":"422e7a4c-8ac0-4633-9751-f41bf066b4c6","description":"This gives you the available pay partner codes to be used for all transactions.
\nSANDBOX EndPoint
URL: https://developer.sandbox.egacoreapi.com/api/partners/search
Method: POST
It requires Bearer token and x-Auth.
\n","_postman_id":"422e7a4c-8ac0-4633-9751-f41bf066b4c6"},{"name":"Transactions","item":[{"name":"Mobile Money Collection","item":[{"name":"/api/transactions/collection","id":"25e6395c-e149-42b4-b91f-d77dafa9f2a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-Auth","value":"{{x_auth}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paypartnerCode\": \"MTNGH\",\n \"amount\": 15,\n \"accountNoOrCardNoOrMSISDN\": \"{{mobile_msisdn}}\",\n \"accountName\": \"TEST PERSON\",\n \"transactionId\": \"1ecac1a2-6199-4e2d-b38a-1b2128465e40\",\n \"narration\": \"Testing\",\n \"transCurrencyIso\": \"GHS\",\n \"expiryDateMonth\": 0,\n \"expiryDateYear\": 0,\n \"cvv\": \"\",\n \"languageId\": \"en\",\n \"callback\": \"https://webhook.site/35291469-e3ee-489c-ac05-61984f170727\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/api/transactions/collection","description":"Request parameters
\nCallback
\nAfter every transaction (collection or payout), Eganow will make an HTTPS POST request to the callback URL you provided during the transaction request.
\nConfiguration: Callbacks can be configured via the merchant dashboard or provided directly in the API request (which takes precedence).
\nExpected Statuses: Callbacks will provide transaction status as 'pending', 'failed', or 'successful'.
\nFailureReason: The callback payload does not include a specific reason for transaction failure.
\nHTTP Response Codes
\nTransaction Status Values (within the response body)
\n","urlObject":{"path":["api","transactions","collection"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"58e314f5-8f15-474a-8daa-2accc7691885","name":"/api/transactions/collection","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-Auth","value":"{{x_auth}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paypartnerCode\": \"MTNGH\",\n \"amount\": 15,\n \"accountNoOrCardNoOrMSISDN\": \"{{mobile_msisdn}}\",\n \"accountName\": \"TEST PERSON\",\n \"transactionId\": \"1bb6158a-5247-4478-b9f4-0abad2efdad8\",\n \"narration\": \"Testing\",\n \"transCurrencyIso\": \"GHS\",\n \"expiryDateMonth\": 0,\n \"expiryDateYear\": 0,\n \"cvv\": \"\",\n \"languageId\": \"en\",\n \"callback\": \"https://webhook.site/35291469-e3ee-489c-ac05-61984f170727\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/api/transactions/collection"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 07 Apr 2026 10:33:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionStatus\": \"PENDING\",\n \"eganowReferenceNo\": \"GHOD1AB17B2433964BEDA4A211CD64AC5D30\",\n \"message\": \"Transaction initiated\"\n}"}],"_postman_id":"25e6395c-e149-42b4-b91f-d77dafa9f2a4"}],"id":"8c0953e8-cde2-43ee-b4eb-d6ab8b37b9dd","description":"This folder contains endpoints for initiating mobile money collection transactions on the Eganow platform.
\nIt currently includes the following endpoint:
\nAuthentication
\nAll requests in this folder require both Bearer Token and x-Auth authentication.
\nSupported Mobile Money Networks
\nNotes
\nThe sandbox endpoint is: https://developer.sandbox.egacoreapi.com/api/transactions/collection
Use the appropriate paypartnerCode to target the correct mobile money network.
Card Paypartner code
\nRequest parameters
\nHTTP Response Codes
\nTransaction Status Values (within the response body)
\nCallback
\nAfter every transaction (collection or payout), Eganow will make an HTTPS POST request to the callback URL you provided during the transaction request.
\nConfiguration: Callbacks can be configured via the merchant dashboard or provided directly in the API request (which takes precedence).
\nExpected Statuses: Callbacks will provide transaction status as 'pending', 'failed', 'successful', 'authentication_in_progress', 'expired' or 'cancelled'.
\nFailure Reason: The callback payload does not include a specific reason for transaction failure.
\nTake note:
\nThere are 3 transaction responses available for card transactions:
- Authentication in progress
- Failed
- Successful
To simulate these responses:
- Pass amount of 1000 to simulate 3dSecure response.
- pass amount of 2000 to simulate a failed transaction.
- pass any other amount to simulate a Successful transaction.
To handle the 3dsecuere response, we encrypt the payload in base64. When you receive it, you need to decrypt the base64 value to get the html to render for your customers. You can choose to render in an iframe or render in a full page.
\nAdditional verification needed to complete your transaction
\\nVerifying your authentication...
\\nThis folder contains endpoints for initiating card-based collection transactions on the Eganow platform.
\nIt currently includes the following endpoint:
\nAuthentication
\nAll requests in this folder require both Bearer Token and x-Auth authentication.
\nNotes
\nCard collections are processed synchronously using the 3D Secure (3DS) protocol.
\nUse the Sandbox endpoint https://developer.sandbox.egacoreapi.com/api/transactions/card/collect for testing.
Request parameters
\nThe Paypartner codes for mobilemoney are:
\nCallback
\nAfter every transaction (collection or payout), Eganow will make an HTTPS POST request to the callback URL you provided during the transaction request.
\nConfiguration: Callbacks can be configured via the merchant dashboard or provided directly in the API request (which takes precedence).
\nExpected Statuses: Callbacks will provide transaction status as 'pending', 'failed', or 'successful'.
\nFailure Reason: The callback payload does not include a specific reason for transaction failure.
\nHTTP Response Codes
\nTransaction Status Values (within the response body)
\nThis folder contains the endpoint for initiating a mobile money payout on the Eganow platform.
\nAuthentication: Requires both Bearer Token and x-Auth.
\nNotes
\ntransactionId is required and must be unique across all requests.
accountNoOrCardNoOrMSISDN must be in international format (e.g. 233XXXXXXXXX — no +, or leading with zero ''0244XXXXXX'').
paypartnerCode must be a valid mobile money code: MTNGH (MTN Ghana) or TCELGH (Telecel Ghana).
callback is required — Eganow will POST the final transaction status to this URL.
Possible status values: SUCCESSFUL, FAILED, or PENDING.
Supported Banks Paypartner codes
\nRequest parameters
\nCallback
\nAfter every transaction (collection or payout), Eganow will make an HTTPS POST request to the callback URL you provided during the transaction request.
\nConfiguration: Callbacks can be configured via the merchant dashboard or provided directly in the API request (which takes precedence).
\nExpected Statuses: Callbacks will provide transaction status as 'pending', 'failed', or 'successful'.
\nFailure Reason: The callback payload does not include a specific reason for transaction failure.
\nHTTP Response Codes
\nTransaction Status Values (within the response body)
\nThis folder contains the endpoint for initiating bank payout transactions on the Eganow platform.
\nAuthentication: Requires both Bearer Token and x-Auth.
\nNotes
\ntransactionId must be unique across all requests.
Currency is specified using ISO 4217 codes (e.g., GHS).
A callback webhook URL is required to receive the final transaction status.
The request body should be sent as JSON with the following parameters:
\nHTTP Response Codes
\nTransaction Status Values (within the response body)
\nThis endpoint initiates an internal transfer from a collection account to a payout account — specifically, moving funds between internal wallets such as from a collection account to a payout account.
\nAll requests in this folder require two layers of authentication:
\nBearer Token — A valid access token passed via the Authorization header as {{access_token}}.
x-Auth Header — An additional authentication key passed via the x-Auth header as {{x_auth}}.
\n\n","_postman_id":"4c425f07-4c11-43f6-afb9-5c0301a7dcf3"},{"name":"Status","item":[{"name":"/api/transactions/status","id":"9f689718-1b38-422f-a32e-e03dc0bf148f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-Auth","value":"{{x_auth}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"transactionId\": \"GHODC794ABC81C9F442A8A8827ABA648BBC8\",\n \"languageId\": \"en\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/api/transactions/status","description":"These transfers are strictly internal and do not involve external payment partners or mobile money networks.
\n
Request parameters
\n","urlObject":{"path":["api","transactions","status"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"10b88be9-6035-4934-92f5-9d4590472bff","name":"/api/transactions/status","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-Auth","value":"{{x_auth}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"transactionId\": \"e44747ba-a816-4472-af50-522214818e77\",\n \"languageId\": \"en\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/api/transactions/status"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 10 Aug 2026 09:56:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"message\": \"transaction exist\",\n \"transactionstatus\": \"SUCCESSFUL\",\n \"referenceNo\": \"GHJEG1B875293A53346948E08913EBA98FA7B\",\n \"reason\": null,\n \"explanation\": null\n}"}],"_postman_id":"9f689718-1b38-422f-a32e-e03dc0bf148f"}],"id":"b0d31c84-cad3-4e84-94bc-f87bd2887390","description":"This folder contains the endpoint for checking the status of a transaction on the Eganow platform.
\nAuthentication: Requires both Bearer Token and x-Auth.
\nNotes
\ntransactionId is required and must match the ID used when the transaction was initiated.
Possible status values: SUCCESSFUL, FAILED, or PENDING.
The callback payload sent to your configured endpoint will include an additional field, ''FailureReason''. This field returns a descriptive reason whenever a collection transaction does not complete successfully.
\n-
\nSuccessful Transaction Callback:
When the Transaction Status is SUCCESSFUL, the FailureReason field will return empty or null.
Sample Response:
{
''EganowReferenceNo'':\"EG64B47DAEEA024A85B3376838A371405F\"
''PayPartnerTransactionId'':\"57069046060\"
''TransactionId'':\"61252df4-0d9a-4147-99f5-1ab795042e2a\"
''TransactionStatus'':\"SUCCESSFUL\"
''FailureReason'': \"\"
}
Failed Transaction Status Callback:
When the Transaction Status is FAILED, the FailureReason field will be populated with the reason for the failure on unsuccessful transactions.
Sample Response:
{
''EganowReferenceNo'':\"EG64B47DAEEA024A85B3376838A371405F\"
''PayPartnerTransactionId'':\"57069046060\"
''TransactionId'':\"61252df4-0d9a-4147-99f5-1ab795042e2a\"
''TransactionStatus'':\"FAILED\"
''FailureReason'': \"INSUFFICIENT FUNDS\"
}
-
\nResponse Fields
\n","_postman_id":"323f8f7b-aac4-4dd3-a37b-15728dd55976"},{"name":"Balance Enquiry","item":[{"name":"Total Account Balance Enquiry","item":[{"name":"/api/transactions/get-balances","id":"551dd976-e03a-40dc-bb37-2aced3bd1095","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-auth","value":"{{x_auth}}","type":"text"}],"url":"{{baseUrl}}/api/transactions/get-balances","description":"Response Codes:
\n200 OK: Success, returns balances
\n401 Unauthorized: Invalid/missing auth
\n403 Forbidden: Insufficient permissions
\n500 Internal Server Error: Server issue (retry with exponential backoff)
\nThis folder contains the endpoint for retrieving the total account balance across all wallet types associated with the authenticated merchant account on the Eganow platform.
\nMethod: GET
\nURL: {{baseUrl}}/api/transactions/get-balances https://developer.sandbox.egacoreapi.com/api/transactions/get-balances
\nHeaders:
\nContent-Type: application/json (optional for GET, but recommended)
\nx-Auth: {{your_encoded_credentials}}
\nBearer token
\nAuthentication: Requires both Bearer Token and x-Auth header.
\n","_postman_id":"663096d6-7e92-4ce1-9c67-2fe54d8d87ce"},{"name":"Payout Balance Enquiry","item":[{"name":"/api/transactions/payout/get-balance","id":"20e6ac8f-1af0-4acc-8560-834653237692","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-auth","value":"{{x_auth}}","type":"text"}],"url":"{{baseUrl}}/api/transactions/payout/get-balance","description":"*
\nResponse Codes:
\n200 OK: Success, returns payout balance
\n401 Unauthorized: Invalid/missing auth
\n403 Forbidden: Insufficient permissions (e.g., no payout access)
\n500 Internal Server Error: Server issue (retry with exponential backoff)
\nThis endpoint retrieves the available balance specifically for payout operations and disbursements to bank accounts and mobile money.
\nMethod: GET
\nURL: {{baseUrl}}/api/transactions/payout/get-balance https://developer.sandbox.egacoreapi.com/api/transactions/payout/get-balance
\nAuthentication: Requires both Bearer Token and x-Auth header.
\n","_postman_id":"e726f9b7-fa0f-444d-9e51-adfdb33a3aec"},{"name":"Collection Balance Enquiry","item":[{"name":"/api/transactions/collection/get-balance","id":"fdf57642-d7a8-44af-88c9-69da88bdc023","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-auth","value":"{{x_auth}}","type":"text"}],"url":"{{baseUrl}}/api/transactions/collection/get-balance","description":"Response Codes:
\n200 OK — Success, returns collection balance
\n401 Unauthorized — Invalid/missing auth
\n403 Forbidden — Insufficient permissions
\n500 Internal Server Error — Server issue (retry with exponential backoff)
\nThis endpoint retrieves the current balance of your collection account — i.e., all funds successfully received from customers via Mobile Money and Card.
\nMethod: GET
\nURL:{{baseUrl}}/api/transactions/collection/get-balance
https://developer.sandbox.egacoreapi.com/api/transactions/collection/get-balance
Headers:
\nContent-Type: application/json (optional for GET, but recommended)
\nx-Auth: {{your_encoded_credentials}}
\nThis folder contains requests that let you retrieve all available account balances associated with the authenticated user/merchant account. This includes:
\nTotal account balance enquiry
\nPayout balance enquiry
\nCollection balance enquiry
\nThis is a GET request (no request body required). Authentication is mandatory via the x-Auth header and Bearer token.
\n","_postman_id":"b8cc316c-d7bc-49f7-a63a-66578691deb9"}],"id":"084999b8-765e-48bf-9024-1d51881d81e2","description":"This folder manages Collections, Payouts, Status, History, Balance and Call back.
\nCollections are initiated on mobile money and Cards.
\nPayouts are initiated on mobile money and Banks.
\n","_postman_id":"084999b8-765e-48bf-9024-1d51881d81e2"},{"name":"vas","item":[{"name":"kyc","item":[{"name":"/api/vas/kyc","id":"6bcdf875-0288-49f2-85cd-3a6ba9dbc4e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-Auth","value":"{{x_auth}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paypartnerCode\": \"MTNGH\",\n \"accountNoOrCardNoOrMSISDN\": \"233244444444\",\n \"languageId\": \"en\",\n \"countryCode\": \"GH0233\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/api/vas/kyc","description":"Request parameters
\nHTTP Response Codes
\nTransaction Status Values (within the response body)
\n","urlObject":{"path":["api","vas","kyc"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"c9caa521-ad8f-4bcf-863c-abb74ffb00dc","name":"/api/vas/kyc","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-Auth","value":"{{x_auth}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paypartnerCode\": \"MTNGH\",\n \"accountNoOrCardNoOrMSISDN\": \"233532435701\",\n \"languageId\": \"en\",\n \"countryCode\": \"GH0233\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/api/vas/kyc"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 21 Oct 2025 09:28:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"public,max-age=300"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE"},{"key":"Access-Control-Allow-Headers","value":"x-language-id, x-country-code, x-ega-user-access-token, x-auth, Content-Type,Authorization"},{"key":"Access-Control-Max-Age","value":"1728000"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"accountName\": \"PAULINA MENSAH AGBOTA\"\n}"}],"_postman_id":"6bcdf875-0288-49f2-85cd-3a6ba9dbc4e2"}],"id":"45794397-fc21-4035-bc0e-059627415ecc","description":"This folder contains the KYC (Know Your Customer) endpoint used to perform name enquiry and verify the identification information of a beneficiary account before initiating a transaction.
\nAuthentication: Requires both Bearer Token and x-Auth.
\nNotes
\nUse this endpoint to validate a recipient's account details (e.g. mobile money wallet) before processing a payout or collection.
\npaypartnerCode must match the intended payment partner (e.g. MTNGH for MTN Ghana).
The account number or MSISDN must be provided in international format (e.g. 233XXXXXXXXX) or lead with zero (eg. 0244XXXXXX).