HTTP Status Codes - All API requests will return HTTP status codes. If the status code is 200, this means the request has been validated and processed by the Server and you can proceed to examine the api response from the Server. The statusCode param in the API response will indicate whether the Server was able to process the request successfully or not. If the HTTP status code is not 200, this indicates an issue with the request and you can consult the table below for possible reasons and how to remediate.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9150148","collectionId":"3abcea43-53e9-4021-871e-c5cf324b374d","publishedId":"UVsQs4NC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-04-08T17:43:24.000Z"},"item":[{"name":"v1.0","item":[{"name":"health","item":[{"name":"/v1.0/health","id":"04a6968f-ff7a-4948-b98d-459a557291bc","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.elevygh.org/uat/v1.0/health","description":"Check E-Levy Platform Health. Ideal for platform monitoring etc. It is not intended to be used prior to making API calls.
\nResponse:
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}},"urlObject":{"path":["v1.0","health"],"host":["https://api.elevygh.org/uat"],"query":[],"variable":[]}},"response":[{"id":"0a9e6150-742f-40a1-8516-6111f6b411b9","name":"E-Levy API Health Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.elevygh.org/uat/v1.0/health"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"406bdf83-f2e7-43ae-974e-da10a4ab33ee"},{"key":"x-amz-apigw-id","value":"PVoQ_H1xjoEFgEQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62388739-72610190ee9783630c96320e;Sampled=0"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"99"},{"key":"date","value":"Mon, 21 Mar 2022 14:10:00 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"00\",\n \"statusMessage\": \"Success\",\n \"stage\": \"uat\",\n \"serverTimestamp\": \"2022-03-21 14:10:01\"\n}"}],"_postman_id":"04a6968f-ff7a-4948-b98d-459a557291bc"}],"id":"3aa2e04d-950d-4005-8e40-8a0fd486f4c3","_postman_id":"3aa2e04d-950d-4005-8e40-8a0fd486f4c3","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}}},{"name":"reserve","item":[{"name":"/v1.0/reserve","event":[{"listen":"test","script":{"id":"2f654b81-b7ad-4d1e-ae7e-388a76c4e246","exec":["let response = pm.response.json();","","pm.collectionVariables.set(\"elevyID\", response['elevyID']);"],"type":"text/javascript"}}],"id":"774f63a7-c966-4d1d-a087-8eb67fc01284","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientTimestamp\": \"2022-02-15 09:00:00\",\n \"clientTransactionID\": \"aafef232366\",\n \"chargingPartyID\": \"1\",\n \"currency\": \"GHS\",\n \"receiverAccountNumber\": \"233244124124\",\n \"receiverInstitutionID\": \"1\",\n \"senderAccountNumber\": \"233244125127\",\n \"senderIssuerID\": \"1\",\n \"senderPhoneNumber\": \"233244125125\",\n \"transferAmount\": 159.50,\n \"senderTIN\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.elevygh.org/uat/v1.0/reserve","description":"E-Levy reservation request.
\nRequest:
\nAll fields 'Required' unless explicitly stated as 'Optional'.
\nResponse:
\nGIP Routing Codes:
\nCodes for senderIssuerID and receiverInstitutionID. If Charging Party is a Bank and the transaction originates from a Bank account the senderIssuerID must be the sort code of the Bank branch where the Bank account resides. If charging party is a PSP initiating transaction on behalf of a Bank, the PSP can use Bank's GIP code as senderIssuerID.
\nBIN Length / Masked PAN Format
\nService Types
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}},"urlObject":{"path":["v1.0","reserve"],"host":["https://api.elevygh.org/uat"],"query":[],"variable":[]}},"response":[{"id":"c6a17136-a6d8-4faf-ac14-a857471a903d","name":"E-Levy Response Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientTimestamp\": \"2022-02-15 09:00:00\",\n \"clientTransactionID\": \"aafef232366\",\n \"chargingPartyID\": \"1\",\n \"currency\": \"GHS\",\n \"receiverAccountNumber\": \"233244124124\",\n \"receiverInstitutionID\": \"300594\",\n \"senderAccountNumber\": \"233244125127\",\n \"senderIssuerID\": \"300591\",\n \"senderPhoneNumber\": \"233244125125\",\n \"transferAmount\": 159.50,\n \"senderTIN\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.elevygh.org/uat/v1.0/reserve"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"e5d1c548-4821-4b42-9280-ee90a40bac08"},{"key":"x-amz-apigw-id","value":"PVowRHwtjoEFo0Q="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62388801-1f3dda82c5459490e7604c81;Sampled=0"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"186"},{"key":"date","value":"Mon, 21 Mar 2022 14:13:20 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"00\",\n \"statusMessage\": \"Success\",\n \"elevyID\": \"8279957744022071\",\n \"taxableAmount\":300,\n \"clientTransactionID\": \"aafef232366\",\n \"currency\": \"GHS\",\n \"serverTimestamp\": \"2022-03-21 14:13:21\"\n}"}],"_postman_id":"774f63a7-c966-4d1d-a087-8eb67fc01284"}],"id":"cdf89d68-25f2-4352-8761-ef3bb437bb7a","_postman_id":"cdf89d68-25f2-4352-8761-ef3bb437bb7a","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}}},{"name":"cancel","item":[{"name":"/v1.0/cancel/:e-levy-id","id":"cf5d2696-f868-4228-82fc-62e45dc59edd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.elevygh.org/uat/v1.0/cancel/:e-levy-id","description":"Cancel an E-levy reservation using e-levy-id. Only transactions with status \"RESERVED\" can be canceled.
\nCancel is an idempotent operation. An Elevy-id can only be canceled once. Multiple cancel attempts will return the results of the first successful cancel.
\nResponse:
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}},"urlObject":{"path":["v1.0","cancel",":e-levy-id"],"host":["https://api.elevygh.org/uat"],"query":[],"variable":[{"description":{"content":"(Required) E-Levy id received from successful reservation
\n","type":"text/plain"},"type":"any","value":"","key":"e-levy-id"}]}},"response":[{"id":"1a2ba2ad-45d5-46b9-ac24-8e514f0fd64a","name":"Cancel E-Levy reservation response","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.elevygh.org/uat/v1.0/cancel/:e-levy-id","host":["https://api.elevygh.org/uat"],"path":["v1.0","cancel",":e-levy-id"],"variable":[{"key":"e-levy-id","value":"","description":"(Required) E-Levy id received from successful reservation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"a9c4cb62-1086-486a-92de-ed93acd564db"},{"key":"x-amz-apigw-id","value":"PVo8KFWTjoEFdUw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6238884d-96a618d34de227f64a943672;Sampled=0"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"150"},{"key":"date","value":"Mon, 21 Mar 2022 14:14:37 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"00\",\n \"statusMessage\": \"Success\",\n \"elevyID\": \"8279957744022071\",\n \"clientTransactionID\": \"aafef232366\",\n \"serverTimestamp\": \"2022-03-21 14:14:37\"\n}"}],"_postman_id":"cf5d2696-f868-4228-82fc-62e45dc59edd"}],"id":"2d22ee11-c0e0-494a-8f32-660d5c2721ac","_postman_id":"2d22ee11-c0e0-494a-8f32-660d5c2721ac","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}}},{"name":"confirm","item":[{"name":"/v1.0/confirm","event":[{"listen":"test","script":{"id":"24c70fdc-febf-4eba-8690-c25803c1afc0","exec":["let response = pm.response.json();","","pm.collectionVariables.set(\"elevyID\", response['elevyID']);"],"type":"text/javascript"}}],"id":"dfefeffb-9387-44f6-8be0-eba2ecb8f2c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientTimestamp\": \"2022-02-15 09:00:00\",\n \"clientTransactionID\": \"12599877320\",\n \"chargingPartyID\": \"1\",\n \"currency\": \"GHS\",\n \"elevyAmount\":2.00,\n \"issuerDebitTransactionID\": \"deadbeefbeef\",\n \"receiverAccountNumber\": \"233244124124\",\n \"receiverInstitutionID\": \"1\",\n \"senderAccountNumber\": \"233244125127\",\n \"senderIssuerID\": \"1\",\n \"senderPhoneNumber\": \"233244125125\",\n \"transferAmount\":300,\n \"senderTIN\": \"\",\n \"issuerDebitTransactionTimestamp\" : \"2022-02-06 09:00:00\",\n \"transferTransactionID\": \"foobarxxxx\",\n \"transferTransactionTimestamp\" : \"2022-02-07 08:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.elevygh.org/uat/v1.0/confirm","description":"E-Levy confirm without a prior successful reservation. Charging party will compute E-Levy amount using default policy rules. An E-Levy ID will be returned on successful confirmation.
\nRequest:
\nAll fields 'Required' unless explicitly stated as 'Optional'.
\nResponse:
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}},"urlObject":{"path":["v1.0","confirm"],"host":["https://api.elevygh.org/uat"],"query":[],"variable":[]}},"response":[{"id":"58f1dfe7-473c-4c19-a3f5-db3ba40d166a","name":"E-Levy confirm response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientTimestamp\": \"2022-02-15 09:00:00\",\n \"clientTransactionID\": \"12599877320\",\n \"chargingPartyID\": \"1\",\n \"currency\": \"GHS\",\n \"elevyAmount\": 4.50,\n \"issuerDebitTransactionID\": \"deadbeefbeef\",\n \"receiverAccountNumber\": \"233244124124\",\n \"receiverInstitutionID\": \"300591\",\n \"senderAccountNumber\": \"233244125127\",\n \"senderIssuerID\": \"300594\",\n \"senderPhoneNumber\": \"233244125125\",\n \"transferAmount\": 300,\n \"senderTIN\": \"\",\n \"issuerDebitTransactionTimestamp\" : \"2022-02-06 09:00:00\",\n \"transferTransactionID\": \"foobarxxxx\",\n \"transferTransactionTimestamp\" : \"2022-02-07 08:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.elevygh.org/uat/v1.0/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"d22917ad-2338-4d87-9b50-c2a02aa5c1c7"},{"key":"x-amz-apigw-id","value":"PVpawFgnDoEFxLg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62388911-b191e7202d84c8f4af5c552c;Sampled=0"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"150"},{"key":"date","value":"Mon, 21 Mar 2022 14:17:53 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"00\",\n \"statusMessage\": \"Success\",\n \"elevyID\": \"6903060681320645\",\n \"taxableAmount\": 200,\n \"clientTransactionID\": \"12599877320\",\n \"serverTimestamp\": \"2022-03-21 14:17:53\"\n}"}],"_postman_id":"dfefeffb-9387-44f6-8be0-eba2ecb8f2c4"},{"name":"/v1.0/confirm/:e-levy-id","id":"95e87f18-79e7-4268-bbe8-91523716bec8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientTimestamp\": \"2022-02-07 09:00:00\",\n \"issuerDebitTransactionID\": \"aafef231366\",\n \"issuerDebitTransactionTimestamp\" : \"2022-02-06 09:00:00\",\n \"transferTransactionID\": \"foobarxxxx\",\n \"elevyAmount\":0.45,\n \"currency\": \"GHS\",\n \"transferTransactionTimestamp\" : \"2022-02-07 08:00:00\"\n \n}","options":{"raw":{"language":"json"}}},"url":"https://api.elevygh.org/uat/v1.0/confirm/:e-levy-id","description":"E-Levy Confirm reservation using e-levy-id
\nRequest Body: All fields required unless explicitly stated as optional.
\nResponse:
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}},"urlObject":{"path":["v1.0","confirm",":e-levy-id"],"host":["https://api.elevygh.org/uat"],"query":[],"variable":[{"description":{"content":"(Required) E-Levy ID of prior successful reservation
\n","type":"text/plain"},"type":"any","value":"","key":"e-levy-id"}]}},"response":[{"id":"2e9ecc00-1fec-49c8-b3d3-68f1b7da89d8","name":"E-Levy confirm response","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientTimestamp\": \"2022-02-07 09:00:00\",\n \"issuerDebitTransactionID\": \"aafef231366\",\n \"issuerDebitTransactionTimestamp\" : \"2022-02-06 09:00:00\",\n \"elevyAmount\" : 0.45,\n \"currency\": \"GHS\",\n \"transferTransactionID\": \"foobarxxxx\",\n \"transferTransactionTimestamp\" : \"2022-02-07 08:00:00\"\n \n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.elevygh.org/uat/v1.0/confirm/:e-levy-id","protocol":"https","host":["api","elevygh","org"],"path":["uat","v1.0","confirm",":e-levy-id"],"variable":[{"key":"e-levy-id","value":"","description":"(Required) E-Levy ID of prior successful reservation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"d851229c-500e-4c87-b2d6-591fb58b0c9c"},{"key":"x-amz-apigw-id","value":"PVqaxFhDDoEFV_Q="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62388aab-fad56c9ee94a9f7efb937897;Sampled=0"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"150"},{"key":"date","value":"Mon, 21 Mar 2022 14:24:42 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"00\",\n \"statusMessage\": \"Success\",\n \"elevyID\": \"2108828471582038\",\n \"clientTransactionID\": \"aafef231366\",\n \"serverTimestamp\": \"2022-03-21 14:24:43\"\n}"}],"_postman_id":"95e87f18-79e7-4268-bbe8-91523716bec8"}],"id":"8874f31d-b9a1-4849-95c6-08509d3b5067","description":"There are two distinct ways to confirm a transaction depending on the status of the reservation:
\nConfirm PATCH is an idempotent operation. An Elevy-id can only be confirmed once. Multiple confirmation attempts will return the results of the first successful confirmation.
\n","_postman_id":"8874f31d-b9a1-4849-95c6-08509d3b5067","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}}},{"name":"reversal","item":[{"name":"/v1.0/reversal/:e-levy-id","id":"881ac7ad-305e-40c8-a496-294e5137a1fc","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.elevygh.org/uat/v1.0/reversal/:e-levy-id","description":"E-Levy Reversal using assigned e-levy-id. Reversal of E-Levy can only occur before End-of-Day. Use Refund API for all reversals after End-of-Day. End-of-Day cutoff is 23:59:59 UTC. Only confirmed E-Levy and Full E-Levy amount can be reversed.
\nResponse:
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}},"urlObject":{"path":["v1.0","reversal",":e-levy-id"],"host":["https://api.elevygh.org/uat"],"query":[],"variable":[{"description":{"content":"(Required) E-Levy ID to be reversed.
\n","type":"text/plain"},"type":"any","value":"","key":"e-levy-id"}]}},"response":[{"id":"e0528cc5-01ff-4638-b9f2-bd8002aaf3c0","name":"E-Levy reversal response","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.elevygh.org/uat/v1.0/reversal/:e-levy-id","host":["https://api.elevygh.org/uat"],"path":["v1.0","reversal",":e-levy-id"],"variable":[{"key":"e-levy-id","value":"","description":"(Required) E-Levy ID to be reversed."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"3ad7c64b-0097-4f0f-b7ff-d3aba6dcbdb6"},{"key":"x-amz-apigw-id","value":"PVqlsGyfDoEF2ag="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62388af1-69233cd22c563dbf82e2e291;Sampled=0"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"150"},{"key":"date","value":"Mon, 21 Mar 2022 14:25:52 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"00\",\n \"statusMessage\": \"Success\",\n \"elevyID\": \"2108828471582038\",\n \"clientTransactionID\": \"aafef231366\",\n \"serverTimestamp\": \"2022-03-21 14:25:53\"\n}"}],"_postman_id":"881ac7ad-305e-40c8-a496-294e5137a1fc"}],"id":"ba2c2482-f625-437c-9038-8da1cf2a3be1","description":"Reversal vs. Refund Matrix.
\n","_postman_id":"ba2c2482-f625-437c-9038-8da1cf2a3be1","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}}},{"name":"refund","item":[{"name":"/v1.0/refund/:e-levy-id","id":"52dd6825-8bab-47df-9120-09afeb5ebd9b","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"currency\": \"GHS\",\n\"elevyRefundAmount\": 0.10\n}","options":{"raw":{"language":"json"}}},"url":"https://api.elevygh.org/uat/v1.0/refund/:e-levy-id","description":"E-Levy Refund using assigned e-levy-id. Refunds of E-Levy charged can be requested at any time after confirmation. Partial refunds of E-Levy amount charged is supported by specifying the amount to refund.
\nRequest:
\nAll fields 'Required' unless explicitly stated as 'Optional'.
\nResponse:
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}},"urlObject":{"path":["v1.0","refund",":e-levy-id"],"host":["https://api.elevygh.org/uat"],"query":[],"variable":[{"description":{"content":"(Required) E-Levy ID to be refunded.
\n","type":"text/plain"},"type":"any","value":"","key":"e-levy-id"}]}},"response":[{"id":"13240eec-5ed5-4bae-b394-3c5cbc16e7c6","name":"E-Levy refund response","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"currency\": \"GHS\",\n\"elevyRefundAmount\": 0.10\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.elevygh.org/uat/v1.0/refund/:e-levy-id","host":["https://api.elevygh.org/uat"],"path":["v1.0","refund",":e-levy-id"],"variable":[{"key":"e-levy-id","value":"","description":"(Required) E-Levy ID to be refunded."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"5b384b97-cdcf-480e-979f-1c84594b3b69"},{"key":"x-amz-apigw-id","value":"Qa-oMEGNjoEF1UA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6254449a-c89aa45c6447a73b2c6be822;Sampled=0"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"150"},{"key":"date","value":"Mon, 11 Apr 2022 15:09:14 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"00\",\n \"statusMessage\": \"Success\",\n \"elevyID\": \"8552662175177717\",\n \"clientTransactionID\": \"aafef231311\",\n \"serverTimestamp\": \"2022-04-11 15:09:14\"\n}"}],"_postman_id":"52dd6825-8bab-47df-9120-09afeb5ebd9b"}],"id":"69e6402b-8c0e-4d96-92d8-b06f210bc692","description":"Refund vs. Reversal Matrix.
\n","_postman_id":"69e6402b-8c0e-4d96-92d8-b06f210bc692","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}}},{"name":"status","item":[{"name":"/v1.0/status","id":"a5746627-9de2-4bfd-a0e5-15bbbc19c4c5","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.elevygh.org/uat/v1.0/status?clientTransactionID=aafef231366","description":"Check E-Levy transaction status
\nResponse:
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}},"urlObject":{"path":["v1.0","status"],"host":["https://api.elevygh.org/uat"],"query":[{"description":{"content":"(Required) Check transaction status using unique transaction ID of charging party
\n","type":"text/plain"},"key":"clientTransactionID","value":"aafef231366"}],"variable":[]}},"response":[{"id":"bfec41dd-65a8-4c11-a920-3c96c6a25883","name":"/v1.0/status","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.elevygh.org/uat/v1.0/status?clientTransactionID=aafef231366","host":["https://api.elevygh.org/uat"],"path":["v1.0","status"],"query":[{"key":"clientTransactionID","value":"aafef231366","description":"(Required) Check transaction status using unique transaction ID of charging party"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"dff86cb6-38b3-4e16-873f-caf13c59792f"},{"key":"x-amz-apigw-id","value":"PVq7LG02joEFTkg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62388b7a-ad037bec9d3c383233660849;Sampled=0"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"278"},{"key":"date","value":"Mon, 21 Mar 2022 14:28:10 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"00\",\n \"statusMessage\": \"Success\",\n \"transactionStatus\": \"REVERSED\",\n \"transactionStatusTimestamp\": null,\n \"elevyID\": \"2108828471582038\",\n \"elevyAmount\":1.5,\n \"taxableAmount\":100,\n \"transferAmount\":159.5,\n \"elevyRefundAmount\":0,\n \"currency\": \"GHS\",\n \"clientTransactionID\": \"aafef231366\",\n \"serverTimestamp\": \"2022-03-21 14:28:10\"\n}"}],"_postman_id":"a5746627-9de2-4bfd-a0e5-15bbbc19c4c5"},{"name":"/v1.0/status/:e-levy-id","id":"fa85e64a-f998-49e9-b828-95a5f9841153","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.elevygh.org/uat/v1.0/status/:e-levy-id","description":"Check E-Levy transaction stauts using assigned e-levy-id
\nResponse:
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}},"urlObject":{"path":["v1.0","status",":e-levy-id"],"host":["https://api.elevygh.org/uat"],"query":[],"variable":[{"description":{"content":"(Required) Assigned E-Levy ID
\n","type":"text/plain"},"type":"any","value":"","key":"e-levy-id"}]}},"response":[{"id":"b6a1709a-9d3a-46d2-911b-41b6b647af54","name":"E-Levy status response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.elevygh.org/uat/v1.0/status/:e-levy-id","host":["https://api.elevygh.org/uat"],"path":["v1.0","status",":e-levy-id"],"variable":[{"key":"e-levy-id","value":"","description":"(Required) Assigned E-Levy ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"46e486fb-fc6c-4640-9c53-2f3c42636508"},{"key":"x-amz-apigw-id","value":"PVrAkFvqjoEFkGA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62388b9d-2e10b61f82b2c6aa486e9b48;Sampled=0"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"278"},{"key":"date","value":"Mon, 21 Mar 2022 14:28:44 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"00\",\n \"statusMessage\": \"Success\",\n \"transactionStatus\": \"REVERSED\",\n \"transactionStatusTimestamp\": null,\n \"elevyID\": \"2108828471582038\",\n \"elevyAmount\":1.5,\n \"taxableAmount\":100,\n \"transferAmount\":159.5,\n \"elevyRefundAmount\":0,\n \"currency\": \"GHS\",\n \"clientTransactionID\": \"aafef231366\",\n \"serverTimestamp\": \"2022-03-21 14:28:45\"\n}"}],"_postman_id":"fa85e64a-f998-49e9-b828-95a5f9841153"}],"id":"3cc606ba-375b-46dd-a0ab-4bcab1780140","_postman_id":"3cc606ba-375b-46dd-a0ab-4bcab1780140","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}}},{"name":"query","item":[{"name":"/v1.0/query/elevy","id":"35da7e1f-6cd3-47ea-a854-eb71193feb97","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Query charging party E-Levy transactions
\nResponse:
\nE-Levy Object:
\n","urlObject":{"path":["v1.0","query","elevy"],"host":["https://api.elevygh.org/uat"],"query":[{"description":{"content":"(Required) Start date for query request. format YYYY-MM-DD HH:MM:SS
\n","type":"text/plain"},"key":"startDateTime","value":"(Required) End date for query request. format YYYY-MM-DD HH:MM:SS
\n","type":"text/plain"},"key":"endDateTime","value":"Maximum number of items to return. A cursor is returned if there are more items available than requested
\n","type":"text/plain"},"key":"limit","value":"A filter to the query request. Only transactions with matching transaction status will be returned. status options are \"RESERVED\",\"CANCELED\",\"CONFIRMED\", and \"REVERSED\"
\n","type":"text/plain"},"key":"transactionStatus","value":"Optional cursor returned from previous query request to assist with paging. Do not set cursor on Initial request.
\n","type":"text/plain"},"key":"cursor","value":"Query list of exempt sender accounts at charging party to fallback on when platform is offline. Transactions originating from these accounts at charging party should not attract E-Levy during offline computation.
\nResponse:
\nAccount Object:
\n","urlObject":{"path":["v1.0","query","exempt","senders"],"host":["https://api.elevygh.org/uat"],"query":[{"description":{"content":"Optional Maximum number of items to return. A cursor is returned if there are more items available than requested
\n","type":"text/plain"},"key":"limit","value":"Optional cursor returned from previous query request to assist with paging. Do not set cursor on Initial request.
\n","type":"text/plain"},"key":"cursor","value":"Query to check the exempt status of a sender
\nResponse:
\n","urlObject":{"path":["v1.0","query","exempt","sender",":issuer-id",":account-number"],"host":["https://api.elevygh.org/uat"],"query":[],"variable":[{"description":{"content":"Required ID of account number issuer. Gip code for mobile-money accounts & sort code for bank accounts
\n","type":"text/plain"},"type":"any","value":"{{issuerID}}","key":"issuer-id"},{"description":{"content":"Required sender account number
\n","type":"text/plain"},"type":"any","value":"{{accountNumber}}","key":"account-number"}]}},"response":[{"id":"d7f27327-6908-4b5f-92cc-23bccd45b795","name":"E-Levy Query Exempt Sender response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.elevygh.org/uat/v1.0/query/exempt/sender/:issuer-id/:account-number","host":["https://api.elevygh.org/uat"],"path":["v1.0","query","exempt","sender",":issuer-id",":account-number"],"variable":[{"key":"issuer-id","value":"300594","description":"Required Issuer ID. Gip code for mobile-money accounts & sort code for bank accounts"},{"key":"account-number","value":"233241231234","description":"Required account number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"00\",\n \"statusMessage\": \"Success\",\n \"issuerID\": \"300594\",\n \"accountNumber\": \"233241231234\",\n \"exempt\": true,\n \"TIN\": \"GH-1234-323233\",\n \"issuer\": \"Vodafone\",\n \"serverTimestamp\": \"2022-04-18 08:21:16\"\n}"}],"_postman_id":"3beb4916-7372-40a8-be82-02d6f8dc50a3"},{"name":"/v1.0/exempt/merchant/:issuer-id/:account-number","id":"78f2cfe6-6ec9-4167-8459-9ac5d695439f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Query to check the exempt status of a Merchant
\nResponse:
\n","urlObject":{"path":["v1.0","query","exempt","merchant",":issuer-id",":account-number"],"host":["https://api.elevygh.org/uat"],"query":[],"variable":[{"description":{"content":"Required ID of account number issuer. Gip code for mobile-money accounts & sort code for bank accounts
\n","type":"text/plain"},"type":"any","value":"{{issuerID}}","key":"issuer-id"},{"description":{"content":"Required merchant account number
\n","type":"text/plain"},"type":"any","value":"{{accountNumber}}","key":"account-number"}]}},"response":[{"id":"19f1e293-845e-4f65-a40e-c7329e0ea270","name":"E-Levy Exempt Merchant response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.elevygh.org/uat/v1.0/query/exempt/merchant/:issuer-id/:account-number","host":["https://api.elevygh.org/uat"],"path":["v1.0","query","exempt","merchant",":issuer-id",":account-number"],"variable":[{"key":"issuer-id","value":"300594","description":"Required Issuer ID. Gip code for mobile-money accounts & sort code for bank accounts."},{"key":"account-number","value":"233241231234","description":"Required merchant account number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"00\",\n \"statusMessage\": \"Success\",\n \"issuerID\": \"300594\",\n \"accountNumber\": \"233241231234\",\n \"exempt\": true,\n \"TIN\": \"GH-1234-323233\",\n \"issuer\": \"Vodafone\",\n \"serverTimestamp\": \"2022-04-18 08:21:16\"\n}"}],"_postman_id":"78f2cfe6-6ec9-4167-8459-9ac5d695439f"}],"id":"09cdc081-560e-4a8c-af7b-3dc6803fbdb5","_postman_id":"09cdc081-560e-4a8c-af7b-3dc6803fbdb5","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}}},{"name":"identity","item":[{"name":"/v1.0/identity","id":"cd55679f-526f-42b9-a24e-a33088978b12","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Add/Update identity. i.e account number to TIN map.
\nRequest:
\nAll fields Required.
\nResponse:
\n","urlObject":{"path":["v1.0","identity"],"host":["https://api.elevygh.org/uat"],"query":[],"variable":[]}},"response":[{"id":"11c30747-1645-4d19-88bb-b300c7b983c8","name":"E-Levy Add/Update Identity Response","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"issuerID\": \"300591\",\n \"accountNumber\": \"233241231234\",\n \"accountType\": \"CUSTOMER\",\n \"TIN\": \"GHA-1234512345\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.elevygh.org/uat/v1.0/identity"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amzn-RequestId","value":"0bad2614-3854-4c8b-9d83-6fa5a1078f04"},{"key":"x-amz-apigw-id","value":"PVr0kGwvDoEFTFw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62388ce9-a5f37c8179811b7333a481fe;Sampled=0"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"579"},{"key":"date","value":"Mon, 21 Mar 2022 14:34:17 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"00\",\n \"statusMessage\": \"Success\",\n \"serverTimestamp\": \"2022-04-12 07:56:14\"\n}"}],"_postman_id":"cd55679f-526f-42b9-a24e-a33088978b12"},{"name":"/v1.0/identity/:issuer-id/:account-number","id":"e68aa609-6fc0-40df-bdac-cce4d7f422f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Get Identity info. i.e get account number to TIN map.
\nResponse:
\n","urlObject":{"path":["v1.0","identity",":issuer-id",":account-number"],"host":["https://api.elevygh.org/uat"],"query":[],"variable":[{"description":{"content":"Required ID of account number issuer. Gip code for mobile-money accounts & sort code for bank accounts
\n","type":"text/plain"},"type":"any","value":"{{issuerID}}","key":"issuer-id"},{"description":{"content":"Required account number
\n","type":"text/plain"},"type":"any","value":"{{accountNumber}}","key":"account-number"}]}},"response":[{"id":"317e6c38-bc5a-4423-8e55-9df7999764b4","name":"E-Levy Get Identity response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.elevygh.org/uat/v1.0/identity/:issuer-id/:account-number","host":["https://api.elevygh.org/uat"],"path":["v1.0","identity",":issuer-id",":account-number"],"variable":[{"key":"issuer-id","value":"300591","description":"Required Issuer ID. Gip code for mobile-money accounts & sort code for bank accounts"},{"key":"account-number","value":"233241231234","description":"Required account number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"00\",\n \"statusMessage\": \"Success\",\n \"issuerID\": \"300591\",\n \"accountNumber\": \"233241231234\",\n \"accountType\": \"CUSTOMER\",\n \"TIN\": \"GHA-1234512345\",\n \"issuer\": \"Vodafone\",\n \"serverTimestamp\": \"2022-04-18 08:21:16\"\n}"}],"_postman_id":"e68aa609-6fc0-40df-bdac-cce4d7f422f4"},{"name":"/v1.0/identity/:issuer-id/:account-number","id":"49ba10ce-e7e7-4148-95ae-d72002cc3e93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"Delete Identity Info. ie Delete account number to TIN map.
\nResponse:
\n","urlObject":{"path":["v1.0","identity",":issuer-id",":account-number"],"host":["https://api.elevygh.org/uat"],"query":[],"variable":[{"description":{"content":"Required ID of account number issuer. Gip code for mobile-money accounts & sort code for bank accounts
\n","type":"text/plain"},"type":"any","value":"{{issuerID}}","key":"issuer-id"},{"description":{"content":"Required account number
\n","type":"text/plain"},"type":"any","value":"{{accountNumber}}","key":"account-number"}]}},"response":[{"id":"41b49a5f-d0e9-4b6c-a9fc-3e3e6c85c01b","name":"E-Levy Delete Identity response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.elevygh.org/uat/v1.0/identity/:issuer-id/:account-number","host":["https://api.elevygh.org/uat"],"path":["v1.0","identity",":issuer-id",":account-number"],"variable":[{"key":"issuer-id","value":"300594","description":"Required Issuer ID. Gip code for mobile-money accounts & sort code for bank accounts."},{"key":"account-number","value":"233241231234","description":"Required merchant account number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": \"00\",\n \"statusMessage\": \"Success\",\n \"serverTimestamp\": \"2022-04-18 08:21:16\"\n}"}],"_postman_id":"49ba10ce-e7e7-4148-95ae-d72002cc3e93"}],"id":"7ca7919e-132e-4493-8acf-9c68f8dd553f","_postman_id":"7ca7919e-132e-4493-8acf-9c68f8dd553f","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}}}],"id":"582a7988-ccab-46b1-b03f-d4a1424a738e","_postman_id":"582a7988-ccab-46b1-b03f-d4a1424a738e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3abcea43-53e9-4021-871e-c5cf324b374d","id":"3abcea43-53e9-4021-871e-c5cf324b374d","name":"GRA E-Levy API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"394b5055-4847-4ef2-8085-60b456e2dda1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ca2ff6ea-794f-483e-a656-9f59547d8d81","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.elevygh.org/uat","type":"string"},{"key":"elevyID","value":""},{"key":"key","value":"","type":"string"},{"key":"api-key","value":"","type":"string"}]}