Digital Payment Collections infrastructure for merchants, businesses and developers that simplifies the process of enabling digital payment for their customers across Africa.
\nWith single integration through RESTFUL APIs or SDKs, we provide infrastructure that empowers you to receive payments and payout in your mobile or web applications.
\nBase URL: {{base-url}} = https://merchants.leadremitpayments.com/api/v1
\nx-api-key = secret key, you can get it from your settings configurations. NB this should kept secret/hidden
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11355566","collectionId":"09befe7d-0d0d-448d-9240-9c90cc1148cb","publishedId":"2sA3e498as","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-10T13:49:30.000Z"},"item":[{"name":"Checkouts","item":[{"name":"Get checkout transactions","id":"65af0c0a-e0ab-4179-b79e-f0b06d90d437","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{merchantAuthToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base-url}}/api/v1/checkout/transactions","urlObject":{"path":["api","v1","checkout","transactions"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"65af0c0a-e0ab-4179-b79e-f0b06d90d437"},{"name":"Get checkout transaction status","id":"5d011a01-1304-478f-bb93-7b28f0570f66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{merchantAuthToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base-url}}/api/v1/checkout/status/39OFI1QIB","urlObject":{"path":["api","v1","checkout","status","39OFI1QIB"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"ee8898b9-68c5-4e56-a0c1-823500726f80","name":"Get checkout transaction status","originalRequest":{"method":"GET","header":[],"url":"{{base-url}}/api/v1/checkout/status/EcawonJ4R"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"110"},{"key":"ETag","value":"W/\"6e-XPXea1Egzkq9d6mLek2nVmrVRnA\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Mon, 26 Sep 2022 20:18:16 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Checkout status fetched Successfully\",\n \"data\": {\n \"status\": \"initiating\",\n \"amount\": 4000\n }\n}"}],"_postman_id":"5d011a01-1304-478f-bb93-7b28f0570f66"},{"name":"Initialize checkout","id":"550a516e-92e4-4ec4-a778-7c5c3f7af24b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{merchantPublicKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"amount\": 200,\r\n \"walletId\": \"master\",\r\n \"currency\": \"USD\",\r\n \"metadata\": {}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/checkout/initialize","urlObject":{"path":["checkout","initialize"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"c44330cd-d033-4436-bb0d-ddd8fa5401df","name":"Initialize checkout","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"walletId\": \"master\",\r\n \"returnUrl\": \"https://blusalt.net\",\r\n \"currency\": \"NGN\",\r\n \"amount\": 4000,\r\n \"metadata\": {}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v1/checkout/initialize"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"177"},{"key":"ETag","value":"W/\"b1-TpQI/X79zkkBEdXP99YRIsee2Ng\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 09 Jun 2022 11:56:37 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Initialized Successfully\",\n \"data\": {\n \"authorization_url\": \"https://merchants.leadremitpayments.com/payments/LPCMQuiX2\",\n \"currency\": \"NGN\",\n \"reference\": \"LPCMQuiX2\"\n }\n}"}],"_postman_id":"550a516e-92e4-4ec4-a778-7c5c3f7af24b"},{"name":"Get checkout","id":"84e163b8-5d9a-4ac9-80ea-36deee501abe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{merchantAuthToken}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/api/v1/checkout/Jqhn4BDx3","urlObject":{"path":["api","v1","checkout","Jqhn4BDx3"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"84e163b8-5d9a-4ac9-80ea-36deee501abe"}],"id":"f2025247-417c-4044-b5b0-2f45de665b57","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"max 3
\n","type":"file","src":"/Users/austin/Documents/Epic Lion.jpg"},{"key":"wallet_reference","value":"jfhsdiefun","type":"text"}]},"url":"{{base-url}}/api/v1/disputes/create","urlObject":{"path":["api","v1","disputes","create"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"a17a20e5-3323-4168-b2fb-0cac24277bb8","name":"create dispute","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"description","value":"balablu bulabala instead of lorem ipsum","type":"text"},{"key":"type","value":"fraud","type":"text"},{"key":"payment_reference","value":"kZvJ_5B9FJDyU-z-vuKHe","type":"text"},{"key":"category","value":"payment-links","type":"text"},{"key":"proof","description":"max 3","type":"file","src":"/Users/austin/Documents/Epic Lion.jpg"},{"key":"wallet_reference","value":"jfhsdiefun","type":"text"}]},"url":"{{localhost}}/api/v1/disputes/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"943"},{"key":"ETag","value":"W/\"3af-WQk8RRTFGTh1iVrq1tFrTjyMpYw\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 20 Apr 2023 10:54:03 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Dispute created successfully\",\n \"data\": {\n \"status\": \"pending\",\n \"id\": 4,\n \"payment_reference\": \"kZvJ_5B9FJDyU-z-vuKHe\",\n \"description\": \"balablu bulabala instead of lorem ipsum\",\n \"type\": \"fraud\",\n \"category\": \"payment-links\",\n \"wallet_reference\": \"jfhsdiefun\",\n \"proof\": {\n \"1681988041438-Epic Lion.jpg\": {\n \"proof_url\": \"https://blusalt-merchant.s3.eu-west-1.amazonaws.com/disputes-proof/1681988041438-Epic%20Lion.jpg?AWSAccessKeyId=AKIAVQWZXWZNHTYRSVJ2&Expires=1681988242&Signature=yr1AoOqxmeMlnoiNq5gJr3G0RQE%3D\",\n \"urlExpiresAt\": \"2023-04-20T10:57:22.977Z\",\n \"filename\": \"Epic Lion.jpg\"\n }\n },\n \"reference\": \"DPTSZK6VZFV2JCR6S9\",\n \"MerchantRef\": \"MER-Q46CHVB1QO7K\",\n \"MerchantId\": \"220\",\n \"customer_reference\": \"CT_PMWLS_2D4SSX-\",\n \"CustomerId\": 1,\n \"TransactionId\": 31,\n \"amount\": \"12.00\",\n \"currency\": \"NGN\",\n \"transaction_date\": \"2021-08-05T00:00:00.000Z\",\n \"AggregatorId\": 1,\n \"updatedAt\": \"2023-04-20T10:54:02.978Z\",\n \"createdAt\": \"2023-04-20T10:54:02.978Z\",\n \"last_escalated_at\": null\n }\n}"}],"_postman_id":"1741e870-2201-43cc-9919-0777ede0bb00"},{"name":"Get single Dispute","id":"b43576e5-d72c-4fde-aab4-1c33e49b587d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"version","value":"2","type":"text"},{"key":"x-api-key","value":"","type":"text"}],"url":"{{localhost}}/api/v1/disputes/DPTSZK6VZFV2JCR6S9","urlObject":{"path":["api","v1","disputes","DPTSZK6VZFV2JCR6S9"],"host":["{{localhost}}"],"query":[],"variable":[]}},"response":[{"id":"3e80055c-aa22-4640-8aca-db696087f7d7","name":"Get single Dispute","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"},{"key":"version","value":"2","type":"text"}],"url":"{{localhost}}/api/v1/disputes/DPTPCEIQI0OE63CJOT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"7be-/+9uE8VvPlsYfw56EpgcdrJETOA\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Date","value":"Thu, 19 Jan 2023 14:24:54 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Dispute fetched successfully\",\n \"data\": {\n \"id\": 4,\n \"customer_reference\": \"CUS_JERNWE4UD\",\n \"payment_reference\": \"kZvJ_5B9FJDyU-z-vuKHe\",\n \"TransactionId\": 1,\n \"CustomerId\": 1,\n \"amount\": \"10000\",\n \"currency\": \"NGN\",\n \"reference\": \"DPTPCEIQI0OE63CJOT\",\n \"description\": \"balablu bulabala instead of lorem ipsum\",\n \"type\": \"fraud\",\n \"category\": \"payment-links\",\n \"proof\": [\n \"https://blusalt-merchant.s3.eu-west-1.amazonaws.com/disputes-proof/1674137897970-balablu_bula.jpg?AWSAccessKeyId=AKIAVQWZXWZNHTYRSVJ2&Expires=1674138494&Signature=AKtXIgLs12vrSEcXyGC1g4wlNYA%3D\",\n \"https://blusalt-merchant.s3.eu-west-1.amazonaws.com/disputes-proof/1674137899241-Epic%20Lion.jpg?AWSAccessKeyId=AKIAVQWZXWZNHTYRSVJ2&Expires=1674138494&Signature=34e%2Bqdq3ysEND5vS5zRUhNPrXEY%3D\",\n \"https://blusalt-merchant.s3.eu-west-1.amazonaws.com/disputes-proof/1674137900562-townhall_with_agbado.webp?AWSAccessKeyId=AKIAVQWZXWZNHTYRSVJ2&Expires=1674138494&Signature=w3qbVPCZ6enh5%2BPjjUVirv4nNLs%3D\"\n ],\n \"status\": \"pending\",\n \"MerchantId\": 144,\n \"createdAt\": \"2023-01-19T14:18:25.529Z\",\n \"updatedAt\": \"2023-01-19T14:18:25.529Z\",\n \"Customer\": {\n \"id\": 1,\n \"first_name\": \"Austin\",\n \"last_name\": \"Ume\",\n \"business\": false,\n \"business_details\": null,\n \"email\": \"augustine@blusalt.net\",\n \"phone\": \"553467899282\",\n \"dob\": \"1999-08-05T13:27:02.890Z\",\n \"address\": \"Balablu bala avenue\",\n \"state\": \"lagos\",\n \"country\": \"Nigeria\",\n \"reference\": \"CUS_JERNWE4UD\",\n \"category\": \"Lorem\",\n \"metadata\": null,\n \"createdAt\": \"2021-08-05T13:27:02.890Z\",\n \"updatedAt\": \"2021-08-05T13:27:02.890Z\"\n },\n \"Transaction\": {\n \"id\": 1,\n \"MerchantId\": 144,\n \"WalletId\": 1,\n \"PayoutId\": null,\n \"CustomerId\": 1,\n \"SplitPaymentId\": null,\n \"client_reference\": null,\n \"external_reference\": null,\n \"reference\": \"kZvJ_5B9FJDyU-z-vuKHe\",\n \"narration\": null,\n \"amount\": 10000,\n \"charges\": 10,\n \"settled_amount\": 0,\n \"currency\": \"NGN\",\n \"settled\": true,\n \"settlement_date\": null,\n \"source\": \"bank_transfer\",\n \"type\": \"wallet\",\n \"action\": \"debit\",\n \"status\": \"successful\",\n \"client_metadata\": null,\n \"metadata\": null,\n \"createdAt\": \"2021-08-05T13:27:02.890Z\",\n \"updatedAt\": \"2021-08-05T13:27:02.890Z\"\n }\n }\n}"}],"_postman_id":"b43576e5-d72c-4fde-aab4-1c33e49b587d"},{"name":"Toggle dispute status","id":"ef10f4d0-4d2e-4093-b99d-6615b9a503f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"version","value":"2","type":"text"},{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"resolved\"\n}","options":{"raw":{"language":"json"}}},"url":"{{localhost}}/api/v1/disputes/DPTSZK6VZFV2JCR6S9","urlObject":{"path":["api","v1","disputes","DPTSZK6VZFV2JCR6S9"],"host":["{{localhost}}"],"query":[],"variable":[]}},"response":[{"id":"063ddbf0-8814-4afc-82c1-ecf6e6d2ebf7","name":"Toggle dispute status","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"test_5515b396456a6a2b13a0a70bf4cc8f7551549e2dea4e4494ca026c93b8e00dac2f9f7f030bb6ee343686caa9f171caa81663835914159sk","type":"text"},{"key":"version","value":"2","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"resolved\"\n}","options":{"raw":{"language":"json"}}},"url":"{{localhost}}/api/v1/disputes/DPTITE4YKR0PZMDDQ7"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"69"},{"key":"ETag","value":"W/\"45-WRvnd58csExQapFremst+WMPGC8\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Date","value":"Thu, 12 Jan 2023 22:47:56 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Dispute updated successfully\",\n \"data\": null\n}"}],"_postman_id":"ef10f4d0-4d2e-4093-b99d-6615b9a503f7"}],"id":"f1ff7076-fa39-4a15-a331-52d6b1bcb3b8","_postman_id":"f1ff7076-fa39-4a15-a331-52d6b1bcb3b8","description":""},{"name":"Refund","item":[{"name":"Get Refunds","id":"38e71c65-50bd-4041-8fdd-ea9c1c6f946b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"url":"{{base-url}}/api/v1/refunds","urlObject":{"path":["api","v1","refunds"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"38e71c65-50bd-4041-8fdd-ea9c1c6f946b"},{"name":"Get Refunds Statistics","id":"cf21510a-de96-45a1-a8f1-4350bd98aa64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"","type":"text"}],"url":"{{base-url}}/api/v1/refunds/statistics?to=2023-10-10&from=2023-09-10","urlObject":{"path":["api","v1","refunds","statistics"],"host":["{{base-url}}"],"query":[{"key":"to","value":"2023-10-10"},{"key":"from","value":"2023-09-10"}],"variable":[]}},"response":[],"_postman_id":"cf21510a-de96-45a1-a8f1-4350bd98aa64"}],"id":"c57ae190-46ba-4c6e-96d3-66cc7e976687","_postman_id":"c57ae190-46ba-4c6e-96d3-66cc7e976687","description":""},{"name":"Webhooks","item":[],"id":"df7db686-12b0-4c8f-95f1-21095e9338a4","description":"It is advised to verify that webhook events originate from our environment to avoid suspicious delivering of webhook data.
\nValidate the Signature - Valid events are raised with an header signature which is essentially a HMAC SHA512 signature of the event payload signed using your api key.
const crypto = require('crypto');\nconst apiKey = process.env.API_KEY;\n// Using Express app\napp.post(\"your-webhook-url\",(req, res) => {\n //validate event\n const hash = crypto.createHmac('sha512', apiKey).update(JSON.stringify(req.body)).digest('hex');\n if (hash == req.headers['signature']) {\n // Retrieve the request's body\n const event = req.body;\n // Do something with event...\n }\n res.send(200);\n});\n\n{\n \"service\": \"wallet\",\n \"type\": \"transfer\",\n \"data\": {\n \"amount\": 200,\n \"currency\": \"NGN\",\n \"reference\": \"gmPYQhiKOl35am-sXJbaX\",\n \"MerchantId\": 4,\n \"wallet\": {\n \"wallet_id\": \"of795ppdta\",\n \"reference\": \"36\",\n \"balance\": 3800\n }\n }\n}\n\n{\n \"service\": \"payments\",\n \"type\": \"reserved_account\",\n \"data\": {\n \"amount\": 200,\n \"currency\": \"NGN\",\n \"reference\": \"td33fDjkDe3-sXJbaX\",\n \"narration\": \"NIBSS:9013785855:JOHN DOE:TEST:0902672112034444444460847\" ,\n \"source_account\": {\n \"account_name\": \"John Doe\"\n },\n \"reserved_account\": {\n \"account_number\": \"0202022222\",\n \"account_name\": \"John Nnamdi\",\n \"bank_name\": \"Bank LTD\",\n \"bank_code\": \"011\",\n },\n \"reference\": \"gmPYQhiKOl35am-sXJbaX\"\n }\n}\n\nPayment Collections
\n{\n \"service\": \"payments\",\n \"type\": 'collection',\n \"data\": {\n \"reference\": \"441o299ci3izddo\",\n \"account_number\": \"9048816781\",\n \"account_name\": \"John Doe\",\n \"bank_code\": \"076\",\n \"bank_name\": \"Polaris Bank\",\n \"amount\": 15000,\n \"charges\": 30,\n \"currency\": \"NGN\",\n \"status\": \"successful\",\n \"metadata\": null,\n \"split\": null,\n \"createdAt\": \"2021-12-16T13:28:39.961Z\",\n \"updatedAt\": \"2021-12-16T13:28:39.961Z\"\n }\n}\n\nCard Payments
\n{\n \"service\":\"payments\",\n \"type\":\"card\",\n \"data\":{\n \"status\":\"successful\",\n \"card\":{\n \"bin\":\"4999082\",\n \"cardholder\":\"\",\n \"last4\":\"9373\",\n \"scheme\":\"visa\"\n },\n \"reference\":\"ad3Dkneyjda2\",\n \"client_reference\":\"your_reference\",\n \"client_metadata\":{\n \"description\": \"your_metada\"\n },\n \"amount\":5000\n }\n}\n\nBank Account Payment
\n{\n \"service\": \"payments\",\n \"type\": \"bank_account_payment\",\n \"data\": {\n \"amount\": 500,\n \"charges\": 8.0625,\n \"settled_amount\": 491.9375,\n \"currency\": \"NGN\",\n \"source\": \"bank_account\",\n \"reference\": \"ZiVGuqcrpbQMbgTrCHG9O\",\n \"client_reference\": \"02USDYL050056B1988\",\n \"metadata\": {\n \"source_account\":\n {\n \"account_name\":\"John Doe\",\n \"account_number\":\"0039375746\",\n \"bank_code\":\"044\",\n \"bank_name\":\"ACCESS\"\n }\n },\n \"createdAt\": \"2023-08-06T08:28:39.961Z\",\n \"updatedAt\": \"2023-08-06T08:28:39.961Z\"\n }\n}\n\nPoS Collection
\n{\n \"service\": \"payments\",\n \"type\": \"collection\",\n \"data\": {\n \"amount\": 250,\n \"settled_amount\": 230,\n \"charges\": 20,\n \"status\": \"successful\",\n \"currency\": \"NGN\",\n \"narration\": \"pos payment\",\n \"channel\": \"terminal\",\n \"source\": \"pos\",\n \"metadata\": null,\n \"reference\": \"AnYQ4_lFMj5NB7uV1Jngb\",\n \"createdAt\": \"2023-07-16T13:28:39.961Z\",\n \"updatedAt\": \"2023-07-16T13:28:39.961Z\"\n }\n }\n\nFunds Transfer
\n{\n \"service\": \"payments\",\n \"type\": \"fund_transfer\",\n \"data\": {\n \"statusCode\": \"T100\",\n \"transactionReference\": \"TRF-3sdcc5a7-dee1-4a61-80dc-a30b33d3rdas\",\n \"amount\": 505,\n \"bankCodeUsed\": \"035\",\n \"bankNameUsed\": \"Wema Bank Plc\",\n \"currency\": \"NGN\",\n \"sessionId\": \"000017250624124342342833527103974\",\n \"receiverBankCode\": \"100004\",\n \"receiverAccountNumber\": \"0123456789\",\n \"narration\": \"test\",\n \"customerReference\": null,\n \"statusMessage\": \"Transaction processed successfully\",\n \"walletId\": \"5pnumzdmdz\",\n \"charges\": 16.125,\n \"clientRef\": null\n }\n}\n\n