AfribaPAY provides two API environments: a production endpoint for live transactions and a sandbox endpoint, which also supports real payments, allowing you to test all available methods within your applications.
\nThe AfribaPAY API allows merchants to easily integrate payment capabilities into their systems. It supports key operations such as transaction processing, querying payment statuses, and receiving notifications on transaction updates. This ensures smooth and efficient payment flows, enhancing the overall user experience in your applications.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"18594422","collectionId":"0ef54ff5-df1c-479d-bbff-81897238977c","publishedId":"2sAXjSz8sm","public":true,"customColor":{"top-bar":"f9f9f9","right-sidebar":"f9f9f9","highlight":"E90E2B"},"publishDate":"2024-09-24T20:08:56.000Z"},"item":[{"name":"Access TOKEN","item":[{"name":"TOKEN","id":"1726f41e-ce3e-4437-8b22-6e9c7465e26f","protocolProfileBehavior":{"disableBodyPruning":true,"protocolVersion":"auto","followOriginalHttpMethod":true,"followAuthorizationHeader":true},"request":{"auth":{"type":"basic","basic":{"password":"Rf9wcMcA5w9v1yY7","username":"8a52bc2a-bba7-46c1-958a-f74ade6a7a0e"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.afribapay.com/v1/token","description":"You can obtain your API user (username) and API key (password) from your AfribaPAY merchant account or the email we sent you. Please note that API keys for the Sandbox environment are valid only in the Sandbox, while Production keys are exclusively valid for the Production environment.
\nThe generated token will remain valid for all supported countries until it expires, typically within 24 hours.
\n","urlObject":{"path":["v1","token"],"host":["https://api-sandbox.afribapay.com"],"query":[],"variable":[]}},"response":[{"id":"a3a3a2e3-4ba8-4683-b2b7-512445a3c335","name":"TOKEN","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic base64(api_user:api_key) // Api_user and Api_key from your merchand account","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.afribapay.com/v1/token"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"request_id\": \"24122604123627632385460792477073\",\n \"request_time\": 1735230936.189682,\n \"request_ip\": \"100.100.000.237\",\n \"data\": {\n \"access_token\": \"eyJhbGciOiJzaGEyNTYiLCJ0eXBlIjoiSldUIiwiaWF0IjoiMjAyNC0xMi0yNiAxNjozNTozNiIsImV4cCI6IjIwMjQtMTItMjcgMTc6MzU6MzYiLCJuYW1lIjoiQVBNMzE5MjM2MTMiLCJhcGlfa2V5Ijoic2tfTkEyNHhoTmtvN045NlhKUVp6QmQzMzdXMzNsNUZmNXE0alN2MTkwN20ifWQwYjI5NzcyY2I3MmI1YjlhMDkwYTVlN2IyMjg2NGQ0OWYzZWE3MjY5OGQ4N2E0OGEyYzUxM2MzNTk0Njc1ZTc=\",\n \"token_type\": \"bearer\",\n \"expires_in\": 90000\n }\n}"}],"_postman_id":"1726f41e-ce3e-4437-8b22-6e9c7465e26f"}],"id":"e81c97f9-65fb-4665-966b-7f98f501d2b8","description":"All transactions conducted on AfribaPAY require a valid security token to identify and connect the client to our APIs.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"31ba264a-c717-485e-a4fb-44b10ca3ef5e","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"85ec8b08-515a-48c7-a955-a127ff84277a","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"e81c97f9-65fb-4665-966b-7f98f501d2b8"},{"name":"PAYMENTS","item":[{"name":"AfribaPAY-IN","item":[{"name":"PAYIN","event":[{"listen":"test","script":{"id":"6cd60913-b4fd-4399-9587-85df354d1c67","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"d41c0241-14da-4bdd-bc26-3ed3fededa1f","protocolProfileBehavior":{"disableBodyPruning":true,"followOriginalHttpMethod":true,"followAuthorizationHeader":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"bearer","bearer":{"token":"Ib6UTX1s17vxBOx683446nCwO6VhCTAHS4oP0TlyvU1xktuY42RREX1plj"},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"BearerAfribaPAY-IN or PAYIN uses the POST method to initiate the process of receiving payments or deposits. In this process, a request is sent to the AfribaPAY API with the necessary details (such as the payer’s mobile wallet information, amount, and currency), which then processes the transaction, allowing the user to fund an account or complete a payment through mobile money platforms.
\n","urlObject":{"path":["v1","pay","payin"],"host":["https://api-sandbox.afribapay.com"],"query":[],"variable":[]}},"response":[{"id":"ce7d4a89-1df4-4186-9e56-e44cab7eff3c","name":"PAYIN","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerAfribaPAY-IN or PAYIN uses the POST method to initiate the process of receiving payments or deposits. In this process, a request is sent to the AfribaPAY API with the necessary details (such as the payer’s mobile wallet information, otp_code if required, amount, and currency), which then processes the transaction, allowing the user to fund an account or complete a payment through mobile money platforms.
\nOrange in some countries requires the OTP code before processing any transactions. Please refer to the list below for details.
\n","urlObject":{"path":["v1","pay","payin"],"host":["https://api-sandbox.afribapay.com"],"query":[],"variable":[]}},"response":[{"id":"9ce7cb90-42f5-41c4-9feb-1c76d706470b","name":"PAYIN With OTP","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerWith Wave Money, using our API, you need to redirect your customers to the payment link provided by the AfribaPAY API (provider_link), allowing them to scan and pay directly through their application, as shown in the example below.
\n","urlObject":{"path":["v1","pay","payin"],"host":["https://api-sandbox.afribapay.com"],"query":[],"variable":[]}},"response":[{"id":"ff095692-9b7e-4dc8-afd7-70ce8bfdeb1d","name":"PAYIN-Wave","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerAfribaPAY-IN or AfribaPAY Mobile Money PAYIN refers to the process of receiving payments or deposits from customers via mobile money platforms. It enables users to fund an account or make payments using their mobile wallets.
\n","auth":{"type":"bearer","bearer":{"token":"Ib6UTX1s17vxBOx683446nCwO6VhCTAHS4oP0TlyvU1xktuY42RREX1plj"},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"f8f8d37c-72b6-49f7-a775-576b1029e379","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"cb2feecc-d722-4a21-822d-7269c1475437","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"38cb9212-ec86-4db5-88af-16653f608a0a"},{"name":"AfribaPAY-IN-WALLET","item":[{"name":"OTP For Wallet","event":[{"listen":"test","script":{"id":"6cd60913-b4fd-4399-9587-85df354d1c67","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});","","","pm.test(\"Data object structure is valid\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.data).to.exist.and.to.be.an('object');"," pm.expect(responseData.data.transaction_id).to.exist.and.to.be.a('string');"," pm.expect(responseData.data.order_id).to.exist.and.to.be.a('string');"," pm.expect(responseData.data.operator).to.exist.and.to.be.a('string');"," pm.expect(responseData.data.phone_number).to.exist.and.to.be.a('string');"," pm.expect(responseData.data.amount).to.exist.and.to.be.a('number');"," pm.expect(responseData.data.taxes).to.exist.and.to.be.a('number');"," pm.expect(responseData.data.fees).to.exist.and.to.be.a('number');"," pm.expect(responseData.data.fees_taxes_ttc).to.exist.and.to.be.a('number');"," pm.expect(responseData.data.amount_total).to.exist.and.to.be.a('number');"," pm.expect(responseData.data.currency).to.exist.and.to.be.a('string');"," pm.expect(responseData.data.status).to.exist.and.to.be.a('string');"," pm.expect(responseData.data.country).to.exist.and.to.be.a('string');"," pm.expect(responseData.data.lang).to.exist.and.to.be.a('string');"," pm.expect(responseData.data.reference_id).to.exist.and.to.be.a('string');"," pm.expect(responseData.data.provider_id).to.exist.and.to.be.a('string');"," pm.expect(responseData.data.date_created).to.exist.and.to.be.a('string');","});","","","pm.test(\"All required fields are present in the 'data' object\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.data).to.be.an('object');"," pm.expect(responseData.data).to.include.all.keys("," 'transaction_id', 'order_id', 'operator', 'phone_number',"," 'amount', 'taxes', 'fees', 'fees_taxes_ttc', 'amount_total',"," 'currency', 'status', 'country', 'lang', 'reference_id',"," 'provider_id', 'date_created'"," );","});","","","pm.test(\"Request time is a non-negative integer and in a valid timestamp format\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.request_time).to.be.a('number').and.to.be.at.least(0, \"Request time should be non-negative\");"," pm.expect(responseData.request_time).to.satisfy(time => new Date(time).getTime() > 0, \"Request time should be in a valid timestamp format\");","});",""],"type":"text/javascript","packages":{}}}],"id":"d39da1da-2a1f-4fa8-b496-9a27919ac491","protocolProfileBehavior":{"disableBodyPruning":true,"followOriginalHttpMethod":true,"followAuthorizationHeader":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Ib6UTX1s17vxBOx683446nCwO6VhCTAHS4oP0TlyvU1xktuY42RREX1plj"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"operator\":\"wligdicash\",\r\n\"country\":\"BF\",\r\n\"phone_number\":\"04090000\",\r\n\"amount\":100,\r\n\"currency\":\"XOF\",\r\n\"merchant_key\": \"1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.afribapay.com/v1/pay/otp","description":"To access our wallet, you must first generate an OTP code following the example below. The customer will receive the OTP via SMS (or through another pre-configured notification channel), and that OTP is then used to complete the payin.
\n","urlObject":{"path":["v1","pay","otp"],"host":["https://api-sandbox.afribapay.com"],"query":[],"variable":[]}},"response":[{"id":"0bc28727-024d-4e9d-8a29-0b70dffad4c7","name":"OTP","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerOnce the OTP is generated, you can use it to complete the payin, as demonstrated in the example below.
\n","urlObject":{"path":["v1","pay","payin"],"host":["https://api-sandbox.afribapay.com"],"query":[],"variable":[]}},"response":[{"id":"564258a7-5c94-406d-b1ac-a840808d1523","name":"Wallet","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerAfribaPAY-IN supports partner wallets in several countries, regardless of the mobile carrier used. This capability allows users to fund accounts or make payments using mobile wallets that aren't tied to any specific phone operator.
\n","auth":{"type":"bearer","bearer":{"token":"Ib6UTX1s17vxBOx683446nCwO6VhCTAHS4oP0TlyvU1xktuY42RREX1plj"},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"f8f8d37c-72b6-49f7-a775-576b1029e379","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"cb2feecc-d722-4a21-822d-7269c1475437","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"a054be90-ee5e-44f9-8374-0bbf89d6c869"},{"name":"AfribaPAY-OUT","item":[{"name":"PAYOUT","event":[{"listen":"test","script":{"id":"cc1f143e-ae89-431d-9469-ee534550aa27","exec":[""],"type":"text/javascript","packages":{}}}],"id":"12de0d95-0e0e-4555-95a7-b936ceff0847","protocolProfileBehavior":{"disableBodyPruning":true,"followOriginalHttpMethod":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Ib6UTX1s17vxBOx683446nCwO6VhCTAHS4oP0TlyvU1xktuY42RREX1plj"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"operator\":\"wave\",\r\n\"country\":\"SN\",\r\n\"phone_number\":\"770000000\",\r\n\"amount\":100,\r\n\"currency\":\"X0F\",\r\n\"order_id\":\"payout-1775293718\",\r\n\"merchant_key\": \"1\",\r\n\"reference_id\":\"Your reference\",\r\n\"lang\":\"en\",\r\n\"return_url\" : \"https://example.com/success\",\r\n\"cancel_url\" : \"https://example.com/cancel\",\r\n\"notify_url\" : \"https://example.com/notification_ipn_webhook\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-payout-sandbox.afribapay.com/v1/pay/payout","description":"AfribaPAY-OUT or PAYOUT uses the POST method to initiate the process of disbursing funds. This typically involves sending a request with the necessary payment details (such as the recipient's mobile wallet or bank account information, amount, and currency) to the AfribaPAY API, which then processes the transaction and transfers the funds to the designated recipient.
\n","urlObject":{"path":["v1","pay","payout"],"host":["https://api-payout-sandbox.afribapay.com"],"query":[],"variable":[]}},"response":[{"id":"7fc22d1c-469a-472e-bd28-8aaffb5a1d82","name":"PAYOUT","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerAfribaPAY-OUT or PAYOUT refers to the process of disbursing funds from an account to customers or beneficiaries through various payment methods, including mobile money platforms, bank transfers, or other electronic payment systems. It allows businesses or individuals to send money to recipients' mobile wallets or bank accounts efficiently and securely.
\n","auth":{"type":"bearer","bearer":{"token":"Ib6UTX1s17vxBOx683446nCwO6VhCTAHS4oP0TlyvU1xktuY42RREX1plj"},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7735c417-4bd5-42fa-8bea-6c2e1d650c86","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"8186d7cd-fb93-4b08-b7dc-7eef9568ced4","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"2b087a5b-6c9c-4868-904b-d3f75e40ddf5"}],"id":"fa0867ad-33f5-44b4-b3fa-1fc5a1832fac","description":"The request body must be in JSON format and should include the following properties. These properties are applicable for AfribaPAY-IN (PAYIN), AfribaPAY-OUT (PAYOUT), and AfribaPAY-BANK (Bank Transfer).
\nHere is the rewritten table structure using Markdown:
\nThis Markdown version of the table is easy to read and can be used in most Markdown editors.
\nNote:
\nThe order_id field must be unique within the system for each transaction.
Your merchant account will be valid for all countries, but you must set the appropriate currency for each transaction based on the country. The generated token will remain valid across all countries until it expires.
\n","_postman_id":"fa0867ad-33f5-44b4-b3fa-1fc5a1832fac"},{"name":"TRANSACTIONS","item":[{"name":"Notification AfribaPAY","item":[{"name":"AfribaPAY Signature","item":[],"id":"c1c00b70-0f34-4162-ab12-9c4f54339071","description":"To verify that the webhook received is genuinely from the AfribaPAY API, it's important to validate the signature of the payload (body).
\nRetrieve the body content from the POST request sent by AfribaPAY without making any modifications. This will give you a string that must be signed using HMAC256 and your API_KEY
\n// Example with PHP\nfunction afribapay_sign($json, $api_key) {\n $hash = hash_hmac('sha256', $json, $api_key);\n return $hash;\n}\n\nThe request body should be in JSON format. Depending on the framework you're using, it may already return a JSON string. If not, you'll need to convert it into JSON using a function like json_encode() in PHP.
The signature computed using the payload (without any modification) must be compared to the signature provided by AfribaPAY in the POST request headers.
\nYou can retrieve the AfribaPAY signature from the request headers like this:
\n// Retrieve AfribaPAY signature from headers\n$afribaPaySignature = $_SERVER['HTTP_AFRIBAPAY_SIGN'];\n\nFor example, the header might look like this:
\nAfribapay-Sign: ABCD1223333425v3v345\n\nFinally, compare the computed signature (from step 1) with the signature received in the headers. If both signatures match, the webhook is indeed coming from AfribaPAY.
\n// Get the raw body of the request\n$payload = file_get_contents('php://input'); \n// Sign the payload using your api_key\n$computedSignature = afribapay_sign($payload, $api_key); \nif (hash_equals($computedSignature, $afribaPaySignature)) {\n // Signature is valid, the webhook is from AfribaPAY servers\n echo \"Valid webhook\";\n} else {\n // Signature mismatch, possibly not from AfribaPAY servers\n echo \"Invalid webhook\";\n}\n\nIn this example, the webhook is confirmed as valid if the signatures match. If not, it could be an unauthorized request.
\nThis is an example of a header to retrieve the AfribaPAY signature.
\nArray\n(\n [HTTP_CONTENT_LENGTH] => 520\n [HTTP_AFRIBAPAY_SIGN] => 4112666a21fba58854785ba8e27373e0808f923cfece6cfc8a961b2d5eac6509\n [HTTP_CONTENT_TYPE] => application/json\n [HTTP_ACCEPT] => */*\n [HTTP_HOST] => api-sandbox.afripayba.com\n [SERVER_NAME] => api-sandbox.afribapay.com\n [SERVER_PORT] => 443\n [SERVER_ADDR] => 10.18.0.24\n [REQUEST_SCHEME] => https\n ....\n)\n\nThe notification system is a mechanism designed to automatically synchronize payment updates with your merchant site with POST method. AfribaPAY will call this link after each status update to inform you of changes during a transaction. At the completion of a payment, AfribaPAY will automatically call the notification URL (notify_url) associated with the service. This call informs the merchant of the transaction status, allowing them to validate the order if the payment has been successfully verified or if it concludes with a status of SUCCESS or FAILED.
\nHere's an example of a basic webhook implementation in PHP using
\n$payload = file_get_contents(\"php://input\");
and decoding the JSON data using json_decode():
// This is sent to your notify_url with either SUCCESS or FAILED status for your transaction\n// Capture the raw POST data from the request body (Sent from AfribaPAY Servers)\n$payload = file_get_contents(\"php://input\");\n// Decode the JSON payload into a PHP associative array\n$data = json_decode($payload, true);\n// Check if the payload was successfully decoded\nif ($data === null) {\n // Handle the error if the JSON could not be decoded\n http_response_code(400); // Respond with a 400 Bad Request status\n echo \"Invalid JSON received.\"; // Output error message\n exit; // Stop further execution\n}\n// START Signature Verification\n// Retrieve AfribaPAY signature from headers\n$afribaPaySignature = $_SERVER['HTTP_AFRIBAPAY_SIGN'] ?? null;\n// Sign the payload using the merchant key (replace $api_key with your actual key)\n$computedSignature = afribapay_sign($payload, $api_key); \n// Compare the signature received with the computed one\nif (hash_equals($computedSignature, $afribaPaySignature)) {\n // Signature is valid, meaning the webhook is from AfribaPAY\n echo \"Valid webhook\";\n} else {\n // Signature mismatch, possibly indicating that the request did not originate from AfribaPAY\n http_response_code(403); // Respond with a 403 Forbidden status\n echo \"Invalid webhook\"; \n exit; // Stop further execution\n}\n// END Signature Verification\n// Extract important data from the decoded payload\n$orderId = $data['order_id'] ?? null;\n$status = $data['status'] ?? null;\n// Optional: Log the data for troubleshooting or record-keeping purposes\nfile_put_contents(\"webhook_log.txt\", date('Y-m-d H:i:s') . \" - Received webhook: \" . json_encode($data) . PHP_EOL, FILE_APPEND);\n// Process the transaction status\nif ($status === 'SUCCESS') {\n // Handle successful transaction (e.g., update order status in your database)\n http_response_code(200); // Respond with a 200 OK status\n echo \"Transaction successful!\";\n} elseif ($status === 'FAILED') {\n // Handle failed transaction\n http_response_code(200); // Respond with a 200 OK status\n echo \"Transaction failed.\";\n} else {\n // Handle any unexpected statuses\n http_response_code(400); // Respond with a 400 Bad Request status\n echo \"Unknown status.\";\n}\n// Helper function to compute the AfribaPAY signature\nfunction afribapay_sign($json, $api_key) {\n // Generate an HMAC SHA-256 hash of the JSON payload using your API KEY\n return hash_hmac('sha256', $json, $api_key);\n}\n?>\n\nfile_get_contents(\"php://input\"): This captures the raw POST data from AfribaPAY servers.
json_decode($payload, true): Decodes the JSON payload into a PHP associative array.
Transaction Handling: It checks the status of the transaction (e.g., SUCCESS or FAILED) and processes it accordingly. You can customize this part to fit your specific application logic.
\nLogging (Optional): The file_put_contents() function writes the received data into a log file (webhook_log.txt), which can be helpful for debugging or tracking incoming webhooks.
Response Codes: Sends HTTP response codes like 200 for success and 400 for errors.
\nMake sure your webhook URL is set up correctly in your payment provider's system.
\nThis is an example of a transaction result from the AfribaPAY webhook.
\nArray\n(\n [transaction_id] => PIM241190483336653177\n [order_id] => CI_trans_t1726014523\n [operator] => orange\n [phone_number] => 225070000\n [amount] => 10100\n [taxes] => 22\n [fees] => 122\n [fees_taxes_ttc] => 144\n [amount_total] => 10244\n [currency] => XOF\n [status] => SUCCESS\n [country] => CI\n [lang] => fr\n [reference_id] => CI_U7000_10100_XOF_fr\n [provider_id] => 241190483336653177\n [date_created] => 2024-09-11 01:30:54\n [operator_id] => MP240911.0030.A23232\n [status_date] => 2024-09-11 01:30:59\n)\n\nThis feature enables real-time tracking of a transaction's status. By using either the transaction_id (generated by our system) or the order_id (provided during your transaction), you can query the API to check whether the transaction is PENDING, SUCCESS, or FAILED. This is helpful for monitoring payment flows and ensuring successful processing.
\nIn addition to the Transaction Notification, you can use the Transaction Status feature to check the current status of a payment in real-time. This is particularly useful in cases where notifications are not received (for any reason).
\n","urlObject":{"path":["v1","status"],"host":["https://api-sandbox.afribapay.com"],"query":[{"key":"order_id","value":"order-1725999299"}],"variable":[]}},"response":[{"id":"d12afd96-bd94-42c8-87f1-4c4c2ee77ef5","name":"STATUS","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerThis feature enables real-time tracking of a transaction's status. By using either the transaction_id (generated by our system) or the order_id (provided during your transaction), you can query the API to check whether the transaction is PENDING, SUCCESS, or FAILED. This is helpful for monitoring payment flows and ensuring successful processing.
\nIn addition to the Transaction Notification, you can use the Transaction Status feature to check the current status of a payment in real-time. This is particularly useful in cases where notifications are not received (for any reason).
\n","urlObject":{"path":["v1","status"],"host":["https://api-sandbox.afribapay.com"],"query":[{"key":"transaction_id","value":"PIM241023212688248577"}],"variable":[]}},"response":[{"id":"48d4bcec-4fd6-4d83-81c0-1ca95ed72b75","name":"STATUS","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerThe Get Balance feature enables you to check the available balance in your AfribaPAY account. This balance can represent the amount of funds available for withdrawals, transfers, or other operations. The request is typically made using the AfribaPAY API, allowing real-time access to account balances.
\n","urlObject":{"path":["v1","balance"],"host":["https://api-sandbox.afribapay.com"],"query":[],"variable":[]}},"response":[{"id":"d527c2fa-7ace-4894-b2e4-d891462abdad","name":"BALANCE","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerAfribaPAY’s Transaction History feature enables businesses to retrieve a complete log of all past transactions processed through the platform.
Each transaction record includes key details such as:
Transaction Date
\nAmount
\nCurrency
\nRecipient / Phone Number
\nTransaction ID / Order ID / Reference ID
\nStatus (SUCCESS, FAILED, PENDING, etc.)
\nThis history helps merchants keep accurate records, monitor payments, and analyze transaction activity over time for reporting and reconciliation.
\nYou can filter the transaction history using any of the following parameters:
\ndate_start (YYYY-MM-DD) → Start date (inclusive)
Default: today - 3 months
date_end (YYYY-MM-DD) → End date (inclusive)
Default: today
✅ Maximum allowed window: 6 months
transaction_id → Exact match
order_id → Exact match
phone_number → Partial match (digits-only search)\"7701\" can match \"221770112233\"type → Allowed values: payin | payoutq)q → Global quick search value
It supports:
✅ Exact match on: transaction_id, order_id, reference_id
🔍 Partial match on: phone_number (digits-only)
GET /v1/history\n\nGET /v1/history?date_start=2025-01-01&date_end=2025-01-31\n\nGET /v1/history?transaction_id=PIM20250101000001\n\nGET /v1/history?order_id=ORD-839392\n\nGET /v1/history?type=payin\n\nGET /v1/history?phone_number=7701\n\nq (recommended)✅ Search by transaction_id / order_id / reference_id (exact)
🔍 Also supports partial phone search
GET /v1/history?q=PIM20250101000001\n\nOr:
\nGET /v1/history?q=ORD-839392\n\nOr:
\nGET /v1/history?q=7701\n\ndate au format Y-m-d
\n","type":"text/plain"},"key":"date_start","value":"2008-12-10"},{"key":"date_end","value":"2024-12-10"}],"variable":[]}},"response":[{"id":"ac06cc46-1732-4e5f-a10b-3a678451e256","name":"HISTORY","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerAfribaPAY provides various features for managing and tracking transactions, including getting transaction information, checking balances, viewing transaction status, and retrieving transaction history. Here's a brief overview of each:
\n","auth":{"type":"bearer","bearer":{"token":"Ib6UTX1s17vxBOx683446nCwO6VhCTAHS4oP0TlyvU1xktuY42RREX1plj"},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d0b87674-fba5-4969-8d17-d528585ab259","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"04f805d9-f768-411a-9b09-bc8f57d23a63","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"fe3f7f87-774d-4c11-a6f9-f2d5e0f20c77"},{"name":"ACCOUNT","item":[{"name":"INFOS","id":"1db5c275-0a6e-4c14-86c6-45a74f15fd6f","protocolProfileBehavior":{"disableBodyPruning":true,"followAuthorizationHeader":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Ib6UTX1s17vxBOx683446nCwO6VhCTAHS4oP0TlyvU1xktuY42RREX1plj"},"isInherited":false},"method":"GET","header":[],"url":"https://api-sandbox.afribapay.com/v1/infos","description":"AfribaPAY's Get Account Info feature allows users to retrieve key details about their account
\n","urlObject":{"path":["v1","infos"],"host":["https://api-sandbox.afribapay.com"],"query":[],"variable":[]}},"response":[{"id":"0b9fc81d-0d51-4cf3-b80a-f39f02e29b90","name":"INFOS","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerThis table outlines various HTTP status codes and their corresponding messages related to transaction outcomes used by AfribaPAY. It indicates whether a transaction was successfully processed, failed, or is still pending, along with specific failure reasons.
\n","_postman_id":"fe1d0fce-9093-47cb-943a-91d5bb040b29"},{"name":"PAYMENT METHODS","item":[],"id":"31e46708-d721-4715-a576-c5c249bce9a1","description":"This table provides an overview of mobile payment services used by AfribaPAY available across various African countries, including the supported operators, phone codes, and payment methods. It lists whether payin (deposit) and payout (withdrawal) services are available for each operator and their associated payment method (e.g., Orange, MTN, Moov), along with the currency used in each country. The table also notes upcoming services marked as \"Soon\" for certain regions.
\n","_postman_id":"31e46708-d721-4715-a576-c5c249bce9a1"},{"name":"COUNTRIES","item":[{"name":"COUNTRIES","id":"128dd450-b2d8-483d-8d81-c9d3e38695d7","protocolProfileBehavior":{"disableBodyPruning":true,"followAuthorizationHeader":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Ib6UTX1s17vxBOx683446nCwO6VhCTAHS4oP0TlyvU1xktuY42RREX1plj"},"isInherited":false},"method":"GET","header":[],"url":"https://api-sandbox.afribapay.com/v1/countries","description":"Data about countries, their currencies, and mobile operators within those countries usied by AfribaPAY. The specific information being selected includes:
\ncountry_code: The unique code identifying the country.
country_name: The name of the country.
currency: The currency used in the country.
prefix: The telephone prefix for the country.
taxes: The tax rate or information related to the country.
operator_code: The code of the mobile operator within the country.
operator_name: The name of the mobile operator.
otp_required: A flag indicating whether the operator supports OTP (One-Time Password) services.
ussd_code: The text message sent as part of the OTP process or simply the USSD to validate the transaction.
This data is used to manage and support mobile payment services through AfribaPAY.
\n","_postman_id":"ff18037a-262c-4873-85da-864492ce7148"},{"name":"TEST PHONE NUMBERS","item":[],"id":"f88c0c55-7a1f-4756-876d-5e1f0cceeb60","description":"This is the list of phone numbers and currencies for AfribaPay sandbox, along with their respective statuses.
\nSome providers require an OTP (One-Time Password) after you initiate a transaction.
\nIn sandbox mode, you can enter any 6-digit code to simulate a successful verification — except for a reserved set of test codes that always return a FAILED status.
\nThis allows you to test both happy paths (OTP success) and negative scenarios (OTP failure).
\nWhen using the following codes, the API will always respond with FAILED:
\n❌ Reserved failure codes (000000 → 444444) guarantee a deterministic FAILED response.
✅ All other 6-digit codes (e.g. 123456, 987654) will succeed (status=SUCCESS).