This integration document outlines the expected format for exchange of data\nbetween Remita and Third Party Service Providers for FIRS tax payment initiation via REST APIs.
\nTo utilize this service, the Merchant to whom an RRR is being generated in favour of will need to be registered on Remita.
\nRegister a profile on Remita: You can visit www.remita.net to sign-up if you are not already registered as a merchant/biller on the platform.
\nSend an email to infrastructure@systemspecs.com.ng in order to receive your demo credentials for this integration.
\nBASE URL\nGenerate RRR- https://remitademo.net/remita/exapp/api/v1/send/api\nCheck Transaction Status- https://login.remita.net/remita/ecomm\n\nCREDENTIALS\n- merchantId: 2547916\n- apiKey: 1946\nBASE URL\nGenerate RRR- https://login.remita.net/remita/exapp/api/v1/send/api\nCheck Transaction Status- https://login.remita.net/remita/exapp/api/v1/send/api\n\nCREDENTIALS\nWill be provisioned upon successful UAT with Remita\nTo undertake UAT, kindly reach out to us at infrastructure@systemspecs.com.ng
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting started","slug":"getting-started"},{"content":"Environments","slug":"environments"}],"owner":"3613789","collectionId":"d4c8cd82-04f6-4858-963d-92cf1f71b9a2","publishedId":"T1LHFpCD","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"0E8C73","highlight":"DD5226"},"publishDate":"2020-08-06T12:05:48.000Z"},"item":[{"name":"APIs","item":[{"name":"Generate RRR (with Custom Field)","event":[{"listen":"prerequest","script":{"id":"c0ea57b7-8b7a-48ec-a59a-b858d47579ef","exec":["var merchantId = \"2547916\";","var apiKey = \"1946\"","var serviceTypeId = \"4430731\"","var d = new Date();","var orderId = d.getTime();","var totalAmount = \"20000\";","","var apiHash = CryptoJS.SHA512(merchantId+ serviceTypeId+ orderId+totalAmount+apiKey);","","postman.setEnvironmentVariable('merchantId', merchantId);","postman.setEnvironmentVariable('apiKey', apiKey);","postman.setEnvironmentVariable('serviceTypeId', serviceTypeId);","postman.setEnvironmentVariable('orderId', orderId);","postman.setEnvironmentVariable('totalAmount', totalAmount);","postman.setEnvironmentVariable('apiHash', apiHash);"],"type":"text/javascript"}}],"id":"b9fe353a-e179-43e8-a11e-46070058cf48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"remitaConsumerKey={{merchantId}},remitaConsumerToken={{apiHash}}"}],"body":{"mode":"raw","raw":"{ \n\t\"serviceTypeId\": \"{{serviceTypeId}}\",\n\t\"amount\": \"{{totalAmount}}\",\n\t\"orderId\": \"{{orderId}}\",\n\t\"payerName\": \"Michael Alozie\",\n\t\"payerEmail\": \"alozie@systemspecs.com.ng\",\n\t\"payerPhone\": \"09062067384\",\n\t\"description\": \"Payment for Donation 3\",\n\t\"customFields\": [{\n\t\t\"name\": \"Payer TIN\",\n\t\t\"value\": \"1234567890\",\n\t\t\"type\": \"ALL\"\n\t\t},\n\t\t {\n\t\t \"name\": \"Contract Date\",\n\t\t\"value\": \"2018/06/27\",\n\t\t\"type\": \"ALL\"\n\t\t},\n\t\t {\n\t\t \"name\": \"Tax Period\",\n\t\t\"value\": \"2018/06/20\",\n\t\t\"type\": \"ALL\"\n\t\t}]\n}"},"url":"{{baseUrl}}/echannelsvc/merchant/api/paymentinit","description":"You can use our Generate RRR (with Custom Field) API to generate an RRR with custom field values. Custom fields are additional fields associated with the service type for which the RRR is being generated. Please note that Custom fields will have to have been added to the service type on Remita prior to utilizing them for RRR generation.
\n","urlObject":{"path":["echannelsvc","merchant","api","paymentinit"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"18cdbbe5-3225-436e-a971-9abeb01b61c8","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"remitaConsumerKey={{merchantId}},remitaConsumerToken={{apiHash}}"}],"body":{"mode":"raw","raw":"{ \n\t\"serviceTypeId\": \"{{serviceTypeId}}\",\n\t\"amount\": \"{{totalAmount}}\",\n\t\"orderId\": \"{{orderId}}\",\n\t\"payerName\": \"Michael Alozie\",\n\t\"payerEmail\": \"alozie@systemspecs.com.ng\",\n\t\"payerPhone\": \"09062067384\",\n\t\"description\": \"Payment for Donation 3\",\n\t\"customFields\": [{\n\t\t\"name\": \"Payer TIN\",\n\t\t\"value\": \"1234567890\",\n\t\t\"type\": \"ALL\"\n\t\t},\n\t\t {\n\t\t \"name\": \"Contract Date\",\n\t\t\"value\": \"2018/06/27\",\n\t\t\"type\": \"ALL\"\n\t\t},\n\t\t {\n\t\t \"name\": \"Tax Period\",\n\t\t\"value\": \"2018/06/20\",\n\t\t\"type\": \"ALL\"\n\t\t}]\n}"},"url":"{{gateway-url}}/echannelsvc/merchant/api/paymentinit"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 21 Jul 2020 11:52:52 GMT"},{"key":"Server","value":"Apache/2.4.35 (Unix) OpenSSL/1.0.2l"},{"key":"X-Application-Context","value":"channel-gateway:remita.monitor:6200"},{"key":"Content-Type","value":"text/plain;charset=UTF-8"},{"key":"Content-Length","value":"88"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"jsonp ({\"statuscode\":\"025\",\"RRR\":\"130007846382\",\"status\":\"Payment Reference generated\"})"}],"_postman_id":"b9fe353a-e179-43e8-a11e-46070058cf48"},{"name":"Check Transaction Status (using RRR)","event":[{"listen":"prerequest","script":{"id":"6a942ea3-75e1-46d2-abfa-2c6e0aa7a9b5","exec":["var merchantId = \"2547916\";","var apiKey = \"1946\"","var rrr = \"260007689516\"","","var apiHash = CryptoJS.SHA512(rrr + apiKey + merchantId);","","postman.setEnvironmentVariable('merchantId', merchantId);","postman.setEnvironmentVariable('rrr', rrr);","postman.setEnvironmentVariable('apiKey', apiKey);","postman.setEnvironmentVariable('apiHash', apiHash);"],"type":"text/javascript"}}],"id":"2d166a9a-5c65-4e12-8417-3905e1ce3ddf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"remitaConsumerKey={{merchantId}},remitaConsumerToken={{apiHash}}","description":"See Environment details for sample merchantId. apiHash = SHA512 hashing of (rrr + apiKey + merchantId)
\n"}],"url":"{{baseUrl_Get}}/{{merchantId}}/{{rrr}}/{{apiHash}}/status.reg","description":"You can use this API to validate the status of your transaction using the Remita Retrieval Reference (RRR).
\n\n\n","urlObject":{"path":["{{merchantId}}","{{rrr}}","{{apiHash}}","status.reg"],"host":["{{baseUrl_Get}}"],"query":[],"variable":[]}},"response":[{"id":"6ef98670-4591-41f7-b11e-2d480a9f7175","name":"Successful Sample","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"remitaConsumerKey={{merchantId}},remitaConsumerToken={{apiHash}}","description":"See Environment details for sample merchantId. apiHash = SHA512 hashing of (rrr + apiKey + merchantId)"}],"url":"{{baseUrl_Get}}/{{merchantId}}/{{rrr}}/{{apiHash}}/status.reg"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Aug 2020 13:26:39 GMT"},{"key":"Server","value":"Apache/2.4.35 (Unix) OpenSSL/1.0.2l"},{"key":"X-Application-Context","value":"channel-gateway:remita.monitor:6200"},{"key":"Content-Disposition","value":"inline;filename=f.txt"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"amount\": 3500,\n \"RRR\": \"260007689516\",\n \"orderId\": \"5b16ee7969080\",\n \"message\": \"Successful\",\n \"paymentDate\": \"2018-06-08 06:02:06 PM\",\n \"transactiontime\": \"2018-06-05 12:00:00 AM\",\n \"status\": \"00\"\n}"}],"_postman_id":"2d166a9a-5c65-4e12-8417-3905e1ce3ddf"},{"name":"Check Transaction Status (using Order ID)","event":[{"listen":"prerequest","script":{"id":"c9ced2fa-733e-4040-bbb0-d550085b380b","exec":["var merchantId = \"2547916\";","var apiKey = \"1946\"","var orderId = \"5b16ee7969080\"","","var apiHash = CryptoJS.SHA512(orderId + apiKey + merchantId);","","postman.setEnvironmentVariable('merchantId', merchantId);","postman.setEnvironmentVariable('orderId', orderId);","postman.setEnvironmentVariable('apiKey', apiKey);","postman.setEnvironmentVariable('apiHash', apiHash);"],"type":"text/javascript"}}],"id":"fd5a0197-cea3-4425-9a23-204c335562de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{baseUrl_Get}}/querypaymentbyorderid/{{merchantId}}/{{orderId}}/{{apiHash}}","description":"Note:
\nStatus code '00' and '01' denote successful transactions and you can consider RRR as paid upon receiving either of these response codes. See full list of response codes here
\n
You can use this API to validate the status of your transaction using your Order ID provided when generating RRR for your transaction.
\n\n\n","urlObject":{"path":["querypaymentbyorderid","{{merchantId}}","{{orderId}}","{{apiHash}}"],"host":["{{baseUrl_Get}}"],"query":[],"variable":[]}},"response":[{"id":"0fbbd3ab-59ce-463d-a649-10bf5ffd2f24","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"remitaConsumerKey={{merchantId}},remitaConsumerToken={{apiHash}}","disabled":true}],"url":"{{baseUrl_Get}}/querypaymentbyorderid/{{merchantId}}/{{orderId}}/{{apiHash}}"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Thu, 06 Aug 2020 12:56:00 GMT"},{"key":"Server","value":"Apache/2.4.35 (Unix) OpenSSL/1.0.2l"},{"key":"X-Application-Context","value":"channel-gateway:remita.monitor:6200"},{"key":"Content-Type","value":"text/plain;charset=UTF-8"},{"key":"Content-Length","value":"628"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"00\",\"message\":\"Successful\",\"rrr\":\"260007689516\",\"billerName\":\"SYSTIMSPICS LIMITID\",\"channel\":\"POS\",\"amount\":3500.00,\"chargeFee\":0.00,\"transactionDate\":\"2018-06-05 00:00:00\",\"paymentDate\":\"2018-06-08 18:02:06\",\"bank\":\"232\",\"bankName\":\"KEYSTONE\",\"serviceTypeId\":\"4430731\",\"orderId\":\"5b16ee7969080\",\"payerName\":\"RemitaTest\",\"payerPhoneNumber\":\"12345678\",\"payerEmail\":\"remita@remita.com\",\"terminalId\":\"3263883646\",\"customFields\":[{\"name\":\"Contract Date\",\"value\":\"2018/06/20\"},{\"name\":\"Tin\",\"value\":\"T-RemitaTest\"},{\"name\":\"Tax Period\",\"value\":\"2018/05/31\"}],\"lineItems\":[],\"paymentDescription\":\"VAT subscription payment\"}"}],"_postman_id":"fd5a0197-cea3-4425-9a23-204c335562de"},{"name":"Payments Notification","event":[{"listen":"prerequest","script":{"id":"4c4b1244-da8d-4427-9119-392dc381c1fb","exec":["var yourListeningUrl = \"https://demo4320917.mockable.io/demonotify\";","var serviceTypeId = \"4430731\";","var rrr = \"260007689516\";","var orderRef = Math.floor(Math.random()*1101233);","var amount = 3500.00;","","var d = new Date();","var dd = d.getDate();","var mm = d.getMonth()+1; //January is 0!","var yyyy = d.getFullYear();","if(dd<10){"," dd='0'+dd;","} ","if(mm<10){"," mm='0'+mm;","} ","var date = dd + '/' + mm + '/' + yyyy;","","var payerName = \"RemitaTest\";","var payerPhoneNumber = \"12345678\";","var payerEmail = \"remita@remita.com\";","","postman.setEnvironmentVariable('yourListeningUrl', yourListeningUrl);","postman.setEnvironmentVariable('rrr', rrr);","postman.setEnvironmentVariable('orderRef', orderRef);","postman.setEnvironmentVariable('serviceTypeId', serviceTypeId);","postman.setEnvironmentVariable('amount', amount);","postman.setEnvironmentVariable('date', date);","postman.setEnvironmentVariable('payerName', payerName);","postman.setEnvironmentVariable('payerPhoneNumber', payerPhoneNumber);","postman.setEnvironmentVariable('payerEmail', payerEmail);",""],"type":"text/javascript"}}],"id":"8743fb05-fa20-44a5-8db0-fb352ec1113a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\r\n { \r\n \"rrr\":\"{{rrr}}\",\r\n \"channel\":\"BRANCH\",\r\n \"amount\":\"{{amount}}\",\r\n \"transactiondate\":\"{{date}}\",\r\n \"debitdate\":\"{{date}}\",\r\n \"bank\":\"011\",\r\n \"branch\":\"011152387\",\r\n \"serviceTypeId\":\"{{serviceTypeId}}\",\r\n \"dateRequested\":\"{{date}}\",\r\n \"orderRef\":\"{{orderRef}}\",\r\n \"payerName\":\"{{payerName}}\",\r\n \"payerPhoneNumber\":\"{{payerPhoneNumber}}\",\r\n \"payerEmail\":\"{{payerEmail}}\",\r\n \"uniqueIdentifier\":\"\"\r\n }\r\n]\r\n"},"url":"{{yourListeningUrl}}","description":"Note:
\nStatus code '00' and '01' denote successful transactions and you can consider RRR as paid upon receiving either of these response codes. See full list of response codes here
\n
This webhook notifies you when a payment has been made in your favour.
\n","urlObject":{"host":["{{yourListeningUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8743fb05-fa20-44a5-8db0-fb352ec1113a"}],"id":"ca8f0e17-1d7d-4e59-bbda-2bd8dcffc53d","description":"The following APIs will show you hoe to generate a Remita Retrieval Reference for payment as well as how you can receive notification on paid RRRs via our Check Status API and our Payment Notification Webhook.
\n","_postman_id":"ca8f0e17-1d7d-4e59-bbda-2bd8dcffc53d"},{"name":"Appendix","item":[{"name":"Response Codes","item":[],"id":"47e0ca2b-0260-48d7-8bde-50c90a4756ca","description":"","_postman_id":"47e0ca2b-0260-48d7-8bde-50c90a4756ca"},{"name":"Bank Codes","item":[],"id":"abee2da9-8926-49ba-b3e8-f22b8c916e86","description":"","_postman_id":"abee2da9-8926-49ba-b3e8-f22b8c916e86"}],"id":"a5ac7438-08f5-49a2-a9a0-e3d7d25c1247","_postman_id":"a5ac7438-08f5-49a2-a9a0-e3d7d25c1247","description":""}],"event":[{"listen":"prerequest","script":{"id":"fffe714d-6353-4c55-b18d-08d3d2ddaaa1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8bce7880-3842-431f-b304-deee45a37c41","type":"text/javascript","exec":[""]}}]}