SabiPays is a comprehensive payment solution designed to assist businesses in collecting payments from customers across Africa. We take pride in offering a robust set of APIs that empower you to seamlessly create payment transactions and verify payments.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"21239609","collectionId":"983308a9-a00e-4ac0-ae4d-6b7acf7b485e","publishedId":"2sA3kVn2Qt","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-11-11T13:25:47.000Z"},"item":[{"name":"Introduction","item":[],"id":"864f6425-b5e1-4b37-ad27-caddb0d6e669","description":"Here is an overview of the SabiPays API, along with detailed documentation:
\nPayment Transaction Creation: Our API allows you to effortlessly generate payment transactions, enabling your customers to make payments conveniently and securely. With simple integration, you can initiate transactions and provide your customers with a seamless payment experience.
\nPayment Verification: We understand the importance of ensuring accurate payment verification. Our API provides a reliable mechanism to verify payments, giving you peace of mind and enabling you to reconcile transactions efficiently.
\nTo proceed with integrating any of our services, you will need to create your corporate profile by visiting SabiPays. Creating your profile gives you access to your credentials for integration on the live environment.
\nTo retrieve your credentials, please follow the steps below:
\nLogin to your SabiPays account
\nGo to the \"Profile\" tab
\nSelect 'API Keys and Webhooks'
\nYou would find your Merchant ID and API key
\nIts important to note that you must pass your Merchant ID and API key on every call you make
\nThe Base URL for the endpoints can be found in your SabiPays Dashboard
\n","_postman_id":"3f8c0a66-77f2-4c2d-9735-e549222928a7"},{"name":"Create Payment","item":[{"name":"Create New Transaction","event":[{"listen":"prerequest","script":{"id":"b71f89c0-fbd6-44ef-9297-f336b6f66e82","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"19beafc8-f302-4ff8-92a0-a4ab86e5e1da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-business-id","value":"SBP-669367698963-CL","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"100\",\n \"customerEmail\": \"mundia@getsparco.com\",\n \"order_id\": \"\", //optional, used only when passing custom reference\n \"currency\": \"NGN\", // must be of UGX or NGN or ZMW\n \"details\": {\n // \"phone_number\": \"0961453688\",\n // \"operator\": \"airtel\" //or \"mtn\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"http://[::1]:8080/api/v1/core/transaction/create","description":"Pass your Merchant ID and API KEY to create a new transaction or payment request, basically to generate an account number for customers. Its important to save the transaction reference in your database, as you would need it to check the payment status
\n","urlObject":{"path":["core","transaction","create"],"host":["http://[::1]:8080/api/v1"],"query":[],"variable":[]}},"response":[{"id":"eb645c3c-869e-442a-a224-a5319a333246","name":"success","originalRequest":{"method":"POST","header":[{"key":"x-merchant-id","value":"d9053d42-8279-4ea7-b604-1813dd394aef","type":"text"},{"key":"x-api-key","value":"776a5779-d36b-405b-86a3-40ad636f5faf","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5\",\n \"customerEmail\": \"mundia@getsparco.com\",\n \"currency\": \"ZMW\", // must be of RMB or NGN or ZMW\n \"details\": {\n \"operator\": \"airtel\", //operator must be either 'airtel' or 'mtn'\n \"phone_number\": \"0976540728\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8080/v1/api/core/transaction/create"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"199"},{"key":"Date","value":"Fri, 23 Aug 2024 08:47:25 GMT"},{"key":"X-RateLimit-Reset","value":"1724402904"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"214"},{"key":"ETag","value":"W/\"d6-fwW2SEgtVU/qA0WS1wGi4FNUykA\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"create new transaction data\",\n \"result\": {\n \"message\": \"\",\n \"amount\": 5,\n \"amountUSD\": 0.23,\n \"currency\": \"ZMW\",\n \"ref\": \"105ec431-79af-47e5-b8ca-9040e776b445\",\n \"expires_at\": \"2024-08-23T09:47:34.599Z\"\n }\n}"}],"_postman_id":"19beafc8-f302-4ff8-92a0-a4ab86e5e1da"}],"id":"6d098fa0-a885-4f49-b4a1-0f4a63592afa","description":"Our innovative solution enables you to effortlessly collect payments from your valued customers through our streamlined payment request feature.
\n","_postman_id":"6d098fa0-a885-4f49-b4a1-0f4a63592afa"},{"name":"Create Disbursement","item":[{"name":"Get wallet balances","id":"6bf6dd6b-9d69-4ace-a925-6c4419f89e93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-merchant-id","value":"--- merchant id here ---","type":"text"},{"key":"x-api-key","value":"--- api key here --","type":"text"}],"url":"http://127.0.0.1:8080/v1/api/core/disburse/balance","description":"Pass your Merchant ID and API KEY to create a new transaction or payment request, basically to generate an account number for customers. Its important to save the transaction reference in your database, as you would need it to check the payment status
\n","urlObject":{"path":["core","disburse","balance"],"host":["http://127.0.0.1:8080/v1/api"],"query":[],"variable":[]}},"response":[{"id":"bf7396a8-c7ea-43a4-ab2a-84cb0774edcc","name":"success","originalRequest":{"method":"GET","header":[{"key":"x-merchant-id","value":"d9053d42-8279-4ea7-b604-1813dd394aef","type":"text"},{"key":"x-api-key","value":"776a5779-d36b-405b-86a3-40ad636f5faf","type":"text"}],"url":"http://127.0.0.1:8080/v1/api/core/disburse/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"199"},{"key":"Date","value":"Tue, 01 Oct 2024 08:45:13 GMT"},{"key":"X-RateLimit-Reset","value":"1727772367"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"122"},{"key":"ETag","value":"W/\"7a-EOq9CRkrxfQtMJqjHZXRvuw5048\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"wallet balances\",\n \"result\": [\n {\n \"currency\": \"NGN\",\n \"balance\": 0\n },\n {\n \"currency\": \"ZMW\",\n \"balance\": 15\n }\n ]\n}"}],"_postman_id":"6bf6dd6b-9d69-4ace-a925-6c4419f89e93"},{"name":"Create New Disbursement","id":"2eaf1235-3810-4d0c-9857-20ba1fcfafe2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-merchant-id","value":"d9053d42-8279-4ea7-b604-1813dd394aef","type":"text"},{"key":"x-api-key","value":"776a5779-d36b-405b-86a3-40ad636f5faf","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5\",\n \"currency\": \"ZMW\", // must be of RMB or NGN or ZMW,\n \"order_id\": \"\", //optional, used only when passing custom reference\n \"details\": {\n \"email\": \"mundia@getsparco.com\",\n \"operator\": \"airtel\",\n \"phone_number\": \"260976540728\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8080/v1/api/core/disburse/create","description":"Pass your Merchant ID and API KEY to create a new transaction or payment request, basically to generate an account number for customers. Its important to save the transaction reference in your database, as you would need it to check the payment status
\n","urlObject":{"path":["core","disburse","create"],"host":["http://127.0.0.1:8080/v1/api"],"query":[],"variable":[]}},"response":[{"id":"63160b1d-d43d-4de2-89d7-d5a0eaa19678","name":"Create New Disburse","originalRequest":{"method":"POST","header":[{"key":"x-merchant-id","value":"--- merchant id here ---","type":"text"},{"key":"x-api-key","value":"--- api key here --","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"5\",\n \"currency\": \"ZMW\", // must be of RMB or NGN or ZMW\n \"details\": {\n \"email\": \"mundia@getsparco.com\",\n \"first_name\": \"Mundia\",\n \"last_name\": \"Mwala\",\n \"phone_number\": \"0961453688\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8080/v1/api/core/disburse/create"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"199"},{"key":"Date","value":"Wed, 26 Jun 2024 16:53:35 GMT"},{"key":"X-RateLimit-Reset","value":"1719420857"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"162"},{"key":"ETag","value":"W/\"a2-GLriBmYQ0CX9N46XrNgJuIh2ZfM\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"create new disbursement data\",\n \"result\": {\n \"amount\": 5,\n \"amountUSD\": 0.23,\n \"currency\": \"ZMW\",\n \"ref\": \"7b616a05-b477-4733-a276-1aebf0de2922\"\n }\n}"}],"_postman_id":"2eaf1235-3810-4d0c-9857-20ba1fcfafe2"}],"id":"84195e2b-00b5-43a1-be51-bd45bb338534","description":"Our innovative solution enables you to effortlessly disburse funds to your beneficiaries through our streamlined disbursement feature.
\n","_postman_id":"84195e2b-00b5-43a1-be51-bd45bb338534"},{"name":"Verify Payment","item":[{"name":"Verify Transaction","id":"68b59a67-7faf-4283-b6db-1a70d30fe476","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-business-id","value":"SBP-669367698963-CL","type":"text"}],"url":"http://127.0.0.1:8080/v1/api/core/transaction/:ref","description":"Fetch status of payment for a transaction, you need to pass the transaction reference to get the transaction status and other information
\n","urlObject":{"path":["core","transaction",":ref"],"host":["http://127.0.0.1:8080/v1/api"],"query":[],"variable":[{"type":"any","value":"374cd571-0ccd-466e-9d0c-8118fce1f648","key":"ref"}]}},"response":[{"id":"67ca5d82-7f34-4fd5-9bf9-0f83f8e2d1a5","name":"get transaction details","originalRequest":{"method":"GET","header":[{"key":"x-merchant-id","value":"--- merchant id here ---","type":"text"},{"key":"x-api-key","value":"--- api key here ---","type":"text"}],"url":{"raw":"http://[::1]:80/v1/api/core/transaction/:ref","protocol":"http","host":["[::1]"],"port":"80","path":["v1","api","core","transaction",":ref"],"variable":[{"key":"ref","value":"374cd571-0ccd-466e-9d0c-8118fce1f648"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"200"},{"key":"X-RateLimit-Remaining","value":"199"},{"key":"Date","value":"Tue, 14 Mar 2023 23:17:51 GMT"},{"key":"X-RateLimit-Reset","value":"1678835877"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"466"},{"key":"ETag","value":"W/\"1d2-2W8A8dBNK9nrL8Bfas1eZe0WFWM\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"transaction data\",\n \"result\": {\n \"id\": \"374cd571-0ccd-466e-9d0c-8118fce1f648\",\n \"amountNGN\": \"500\",\n \"amountRMD\": \"7.14\",\n \"amountUSD\": \"0.68\",\n \"paymentType\": \"bank-transfer\",\n \"paymentInfo\": {\n \"bank\": \"BANK NAME\",\n \"holder\": \"SaBi Technology/ COMPANY NAME\",\n \"account\": \"XXXXXXXXXX\"\n },\n \"customerEmail\": \"-- customer email --\",\n \"status\": \"pending\",\n \"expires\": \"2023-03-15T01:52:30.101Z\",\n \"created\": \"2023-03-14T21:52:30.418Z\",\n \"updated\": \"2023-03-14T21:52:30.418Z\"\n }\n}"}],"_postman_id":"68b59a67-7faf-4283-b6db-1a70d30fe476"}],"id":"ec29c0bf-fa4f-4ff9-89d1-a47d6232f343","description":"The Payment Verification endpoint provides various response parameters that give you detailed information about the payment, including the transaction status, payment amount, date and time of the transaction, and any additional relevant data.
\nBy leveraging this information, you can reconcile your payment records, update your internal systems, and provide accurate and up-to-date payment information to your customers.
\n","_postman_id":"ec29c0bf-fa4f-4ff9-89d1-a47d6232f343"},{"name":"Webhook","item":[{"name":"squadco -- notification","id":"38e7fb1c-ad7c-4340-b374-d046cb2206c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://[::1]:8080/api/v1/core/webhook/b7f5e2d13c4a4b8e9f8e2d1b3c4a4b8e","urlObject":{"path":["core","webhook","b7f5e2d13c4a4b8e9f8e2d1b3c4a4b8e"],"host":["http://[::1]:8080/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"38e7fb1c-ad7c-4340-b374-d046cb2206c1"}],"id":"90524721-33ce-42b1-b392-3447ec0e79fc","_postman_id":"90524721-33ce-42b1-b392-3447ec0e79fc","description":""}],"event":[{"listen":"prerequest","script":{"id":"8e6775a5-eef5-4bde-967b-8c4fc7361647","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c7f7a316-2029-4b7c-9f76-063b75d44915","type":"text/javascript","exec":[""]}}],"variable":[{"key":"MERCHANT_API","value":"http://127.0.0.1:8080/v1/api","type":"string"},{"key":"merchantBaseURL","value":"http://[::1]:8080/api/v1","type":"default"}]}