{ "info": { "_postman_id": "d1034a3a-efa8-4115-a160-3f58f8ccec98", "name": "Payment Hub APIs", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "21253421" }, "item": [ { "name": "Operations App APIs", "item": [ { "name": "Authorization", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " pm.expect(pm.response.text).not.equal(null)", "});", "var jsonData = JSON.parse(responseBody);", "postman.setEnvironmentVariable(\"access_token\", jsonData.access_token);", "", "if(postman.getEnvironmentVariable(\"AutoTest\") == \"true\"){", " var nextTextIndex = Number(postman.getEnvironmentVariable(\"NextTestIndex\"));", " var apis = pm.environment.get('TestApiList');", " var testList = JSON.parse(apis);", " if(testList.length>nextTextIndex){", " postman.setEnvironmentVariable(\"NextTestIndex\", 1+ nextTextIndex);", " postman.setNextRequest(testList[nextTextIndex]); ", " }else{", " postman.setNextRequest(null); ", " }", "}" ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": [ "postman.setEnvironmentVariable(\"NextTestIndex\", 1);" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:96.0) Gecko/20100101 Firefox/96.0", "disabled": true }, { "key": "Accept", "value": "application/json, text/plain, */*", "disabled": true }, { "key": "Accept-Language", "value": "en-US,en;q=0.5", "disabled": true }, { "key": "Accept-Encoding", "value": "gzip, deflate", "disabled": true }, { "key": "Platform-TenantId", "value": "{{TenantName}}" }, { "key": "Authorization", "value": "Basic Y2xpZW50Og==" }, { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "Origin", "value": "http://localhost:4200", "disabled": true }, { "key": "Connection", "value": "keep-alive", "disabled": true }, { "key": "Referer", "value": "http://localhost:4200/", "disabled": true } ], "body": { "mode": "raw", "raw": "{}" }, "url": { "raw": "{{OperationsHostName}}/oauth/token?username=mifos&password=password&grant_type=password", "host": [ "{{OperationsHostName}}" ], "path": [ "oauth", "token" ], "query": [ { "key": "username", "value": "mifos" }, { "key": "password", "value": "password" }, { "key": "grant_type", "value": "password" } ] } }, "response": [] }, { "name": "Filter Transaction Request", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"errorDescription\": [\"Ams local is disabled\"],\n \"transactionId\": [],\n \"payerId\": [],\n \"payeeId\": [],\n \"externalId\": [],\n \"workflowInstanceKey\": [],\n \"state\": []\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests?startTo=2022-08-19 16:16:33&command=export", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests" ], "query": [ { "key": "startTo", "value": "2022-08-19 16:16:33", "description": "YYYY:MM:DD HH:mm:ss" }, { "key": "state", "value": "FAILED", "disabled": true }, { "key": "startFrom", "value": "2022-09-14 10:29:33", "description": "YYYY:MM:DD HH:mm:ss", "disabled": true }, { "key": "command", "value": "export" } ] } }, "response": [ { "name": "Filter Transaction Request by transactionId and startTo", "originalRequest": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"transactionId\": [\"8c2358be640c4BtABNeY\", \"dd2183f3ac5d5leU5nz3\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/export?startTo=2022-06-10 10:17:18", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "export" ], "query": [ { "key": "startTo", "value": "2022-06-10 10:17:18", "description": "Supported filter\nTRANSACTIONID\nPAYERID \nPAYEEID\nEXTERNALID\nWORKFLOWINSTANCEKEY" }, { "key": "state", "value": "ACCEPTED", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "Content-Disposition", "value": "attachment; filename=transactionRequest_2022-07-08_10-09-02.csv" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "text/csv;charset=ISO-8859-1" }, { "key": "Content-Length", "value": "450" }, { "key": "Date", "value": "Fri, 08 Jul 2022 10:09:02 GMT" } ], "cookie": [], "body": "WORKFLOWINSTANCEKEY,TRANSACTIONID,STARTEDAT,COMPLETEDAT,STATE,PAYEEDFSPID,PAYEEPARTYID,PAYEEPARTYIDTYPE,PAYEEFEE,PAYEEQUOTECODE,PAYERDFSPID,PAYERPARTYID,PAYERPARTYIDTYPE,PAYERFEE,PAYERQUOTECODE,AMOUNT,CURRENCY,DIRECTION,AUTHTYPE,INITIATORTYPE,SCENARIO,VARIABLES\r\n2251799816099637,8c2358be640c4BtABNeY,Thu Jun 09 10:17:18 UTC 2022,,ACCEPTED,,24450523,ACCOUNTID,,,,254708374149,MSISDN,,,1,USD,INCOMING,,BUSINESS,MPESA,{IndirectList: not instantiated}\r\n" }, { "name": "Filter Transaction Request by transactionId", "originalRequest": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"transactionId\": [\"8c2358be640c4BtABNeY\", \"dd2183f3ac5d5leU5nz3\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/export", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "export" ], "query": [ { "key": "startTo", "value": "2022-06-10 10:17:18", "description": "Supported filter\nTRANSACTIONID\nPAYERID \nPAYEEID\nEXTERNALID\nWORKFLOWINSTANCEKEY", "disabled": true }, { "key": "state", "value": "ACCEPTED", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "Content-Disposition", "value": "attachment; filename=transactionRequest_2022-07-08_10-10-36.csv" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "text/csv;charset=ISO-8859-1" }, { "key": "Content-Length", "value": "637" }, { "key": "Date", "value": "Fri, 08 Jul 2022 10:10:36 GMT" } ], "cookie": [], "body": "WORKFLOWINSTANCEKEY,TRANSACTIONID,STARTEDAT,COMPLETEDAT,STATE,PAYEEDFSPID,PAYEEPARTYID,PAYEEPARTYIDTYPE,PAYEEFEE,PAYEEQUOTECODE,PAYERDFSPID,PAYERPARTYID,PAYERPARTYIDTYPE,PAYERFEE,PAYERQUOTECODE,AMOUNT,CURRENCY,DIRECTION,AUTHTYPE,INITIATORTYPE,SCENARIO,VARIABLES\r\n2251799816729405,dd2183f3ac5d5leU5nz3,Sun Jun 12 00:22:28 UTC 2022,,ACCEPTED,,24450523,ACCOUNTID,,,,254708374149,MSISDN,,,1,ASD,INCOMING,,BUSINESS,MPESA,{IndirectList: not instantiated}\r\n2251799816099637,8c2358be640c4BtABNeY,Thu Jun 09 10:17:18 UTC 2022,,ACCEPTED,,24450523,ACCOUNTID,,,,254708374149,MSISDN,,,1,USD,INCOMING,,BUSINESS,MPESA,{IndirectList: not instantiated}\r\n" }, { "name": "Filter Transaction Request by transactionId and errorDescription", "originalRequest": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"transactionId\": [\"8c2358be640c4BtABNeY\"],\n \"errorDescription\": [\"Ams local is disabled\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/export", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "export" ], "query": [ { "key": "startTo", "value": "2022-06-10 10:17:18", "description": "Supported filter\nTRANSACTIONID\nPAYERID \nPAYEEID\nEXTERNALID\nWORKFLOWINSTANCEKEY", "disabled": true }, { "key": "state", "value": "ACCEPTED", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "Content-Disposition", "value": "attachment; filename=transactionRequest_2022-07-08_10-11-51.csv" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "text/csv;charset=ISO-8859-1" }, { "key": "Content-Length", "value": "824" }, { "key": "Date", "value": "Fri, 08 Jul 2022 10:11:51 GMT" } ], "cookie": [], "body": "WORKFLOWINSTANCEKEY,TRANSACTIONID,STARTEDAT,COMPLETEDAT,STATE,PAYEEDFSPID,PAYEEPARTYID,PAYEEPARTYIDTYPE,PAYEEFEE,PAYEEQUOTECODE,PAYERDFSPID,PAYERPARTYID,PAYERPARTYIDTYPE,PAYERFEE,PAYERQUOTECODE,AMOUNT,CURRENCY,DIRECTION,AUTHTYPE,INITIATORTYPE,SCENARIO,VARIABLES\r\n2251799816099637,8c2358be640c4BtABNeY,Thu Jun 09 10:17:18 UTC 2022,,ACCEPTED,,24450523,ACCOUNTID,,,,254708374149,MSISDN,,,1,USD,INCOMING,,BUSINESS,MPESA,{IndirectList: not instantiated}\r\n2251799816729405,dd2183f3ac5d5leU5nz3,Sun Jun 12 00:22:28 UTC 2022,,ACCEPTED,,24450523,ACCOUNTID,,,,254708374149,MSISDN,,,1,ASD,INCOMING,,BUSINESS,MPESA,{IndirectList: not instantiated}\r\n2251799816099637,8c2358be640c4BtABNeY,Thu Jun 09 10:17:18 UTC 2022,,ACCEPTED,,24450523,ACCOUNTID,,,,254708374149,MSISDN,,,1,USD,INCOMING,,BUSINESS,MPESA,{IndirectList: not instantiated}\r\n" }, { "name": "Filter Transaction Request by state", "originalRequest": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"state\": [\"ACCEPTED\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/export", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "export" ], "query": [ { "key": "startTo", "value": "2022-06-10 10:17:18", "description": "Supported filter\nTRANSACTIONID\nPAYERID \nPAYEEID\nEXTERNALID\nWORKFLOWINSTANCEKEY", "disabled": true }, { "key": "state", "value": "ACCEPTED", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "Content-Disposition", "value": "attachment; filename=transactionRequest_2022-07-08_10-12-40.csv" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "text/csv;charset=ISO-8859-1" }, { "key": "Content-Length", "value": "637" }, { "key": "Date", "value": "Fri, 08 Jul 2022 10:12:40 GMT" } ], "cookie": [], "body": "WORKFLOWINSTANCEKEY,TRANSACTIONID,STARTEDAT,COMPLETEDAT,STATE,PAYEEDFSPID,PAYEEPARTYID,PAYEEPARTYIDTYPE,PAYEEFEE,PAYEEQUOTECODE,PAYERDFSPID,PAYERPARTYID,PAYERPARTYIDTYPE,PAYERFEE,PAYERQUOTECODE,AMOUNT,CURRENCY,DIRECTION,AUTHTYPE,INITIATORTYPE,SCENARIO,VARIABLES\r\n2251799816729405,dd2183f3ac5d5leU5nz3,Sun Jun 12 00:22:28 UTC 2022,,ACCEPTED,,24450523,ACCOUNTID,,,,254708374149,MSISDN,,,1,ASD,INCOMING,,BUSINESS,MPESA,{IndirectList: not instantiated}\r\n2251799816099637,8c2358be640c4BtABNeY,Thu Jun 09 10:17:18 UTC 2022,,ACCEPTED,,24450523,ACCOUNTID,,,,254708374149,MSISDN,,,1,USD,INCOMING,,BUSINESS,MPESA,{IndirectList: not instantiated}\r\n" }, { "name": "Filter Transaction Request by workflowInstanceKey", "originalRequest": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"workflowInstanceKey\": [\"2251799816099637\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/export", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "export" ], "query": [ { "key": "startTo", "value": "2022-06-10 10:17:18", "description": "Supported filter\nTRANSACTIONID\nPAYERID \nPAYEEID\nEXTERNALID\nWORKFLOWINSTANCEKEY", "disabled": true }, { "key": "state", "value": "ACCEPTED", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "Content-Disposition", "value": "attachment; filename=transactionRequest_2022-07-08_10-14-21.csv" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "text/csv;charset=ISO-8859-1" }, { "key": "Content-Length", "value": "450" }, { "key": "Date", "value": "Fri, 08 Jul 2022 10:14:21 GMT" } ], "cookie": [], "body": "WORKFLOWINSTANCEKEY,TRANSACTIONID,STARTEDAT,COMPLETEDAT,STATE,PAYEEDFSPID,PAYEEPARTYID,PAYEEPARTYIDTYPE,PAYEEFEE,PAYEEQUOTECODE,PAYERDFSPID,PAYERPARTYID,PAYERPARTYIDTYPE,PAYERFEE,PAYERQUOTECODE,AMOUNT,CURRENCY,DIRECTION,AUTHTYPE,INITIATORTYPE,SCENARIO,VARIABLES\r\n2251799816099637,8c2358be640c4BtABNeY,Thu Jun 09 10:17:18 UTC 2022,,ACCEPTED,,24450523,ACCOUNTID,,,,254708374149,MSISDN,,,1,USD,INCOMING,,BUSINESS,MPESA,{IndirectList: not instantiated}\r\n" }, { "name": "Filter Transaction Request bu errorDescription", "originalRequest": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"errorDescription\": [\"Ams local is disabled\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/export", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "export" ], "query": [ { "key": "startTo", "value": "2022-06-10 10:17:18", "description": "Supported filter\nTRANSACTIONID\nPAYERID \nPAYEEID\nEXTERNALID\nWORKFLOWINSTANCEKEY", "disabled": true }, { "key": "state", "value": "FAILED", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "Content-Disposition", "value": "attachment; filename=transactionRequest_2022-07-08_10-18-27.csv" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "text/csv;charset=ISO-8859-1" }, { "key": "Content-Length", "value": "637" }, { "key": "Date", "value": "Fri, 08 Jul 2022 10:18:27 GMT" } ], "cookie": [], "body": "WORKFLOWINSTANCEKEY,TRANSACTIONID,STARTEDAT,COMPLETEDAT,STATE,PAYEEDFSPID,PAYEEPARTYID,PAYEEPARTYIDTYPE,PAYEEFEE,PAYEEQUOTECODE,PAYERDFSPID,PAYERPARTYID,PAYERPARTYIDTYPE,PAYERFEE,PAYERQUOTECODE,AMOUNT,CURRENCY,DIRECTION,AUTHTYPE,INITIATORTYPE,SCENARIO,VARIABLES\r\n2251799816729405,dd2183f3ac5d5leU5nz3,Sun Jun 12 00:22:28 UTC 2022,,ACCEPTED,,24450523,ACCOUNTID,,,,254708374149,MSISDN,,,1,ASD,INCOMING,,BUSINESS,MPESA,{IndirectList: not instantiated}\r\n2251799816099637,8c2358be640c4BtABNeY,Thu Jun 09 10:17:18 UTC 2022,,ACCEPTED,,24450523,ACCOUNTID,,,,254708374149,MSISDN,,,1,USD,INCOMING,,BUSINESS,MPESA,{IndirectList: not instantiated}\r\n" }, { "name": "Filter Transaction Request by errorDescription and startFrom", "originalRequest": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"errorDescription\": [\"Ams local is disabled\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/export?startFrom=2022-06-10 10:17:18", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "export" ], "query": [ { "key": "startTo", "value": "2022-06-10 10:17:18", "description": "Supported filter\nTRANSACTIONID\nPAYERID \nPAYEEID\nEXTERNALID\nWORKFLOWINSTANCEKEY", "disabled": true }, { "key": "state", "value": "FAILED", "disabled": true }, { "key": "startFrom", "value": "2022-06-10 10:17:18" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "Content-Disposition", "value": "attachment; filename=transactionRequest_2022-07-08_10-19-18.csv" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "text/csv;charset=ISO-8859-1" }, { "key": "Content-Length", "value": "450" }, { "key": "Date", "value": "Fri, 08 Jul 2022 10:19:18 GMT" } ], "cookie": [], "body": "WORKFLOWINSTANCEKEY,TRANSACTIONID,STARTEDAT,COMPLETEDAT,STATE,PAYEEDFSPID,PAYEEPARTYID,PAYEEPARTYIDTYPE,PAYEEFEE,PAYEEQUOTECODE,PAYERDFSPID,PAYERPARTYID,PAYERPARTYIDTYPE,PAYERFEE,PAYERQUOTECODE,AMOUNT,CURRENCY,DIRECTION,AUTHTYPE,INITIATORTYPE,SCENARIO,VARIABLES\r\n2251799816729405,dd2183f3ac5d5leU5nz3,Sun Jun 12 00:22:28 UTC 2022,,ACCEPTED,,24450523,ACCOUNTID,,,,254708374149,MSISDN,,,1,ASD,INCOMING,,BUSINESS,MPESA,{IndirectList: not instantiated}\r\n" }, { "name": "Filter Transaction Request empty response", "originalRequest": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"errorDescription\": [\"Ams local is disabled\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/export?startTo=2022-06-10 10:17:18&startFrom=2022-06-10 10:17:18", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "export" ], "query": [ { "key": "startTo", "value": "2022-06-10 10:17:18", "description": "YYYY:MM:DD HH:mm:ss" }, { "key": "state", "value": "FAILED", "disabled": true }, { "key": "startFrom", "value": "2022-06-10 10:17:18", "description": "YYYY:MM:DD HH:mm:ss" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Fri, 08 Jul 2022 10:20:01 GMT" } ], "cookie": [], "body": "{\n \"developerMessage\": \"Empty response\",\n \"errorDescription\": \"Empty response\",\n \"errorCode\": \"404\"\n}" } ] }, { "name": "Get all error codes", "request": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/errorcode/", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "errorcode", "" ] } }, "response": [ { "name": "Get all error codes 200", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{operationsAppIngress}}/api/v1/errorcode/", "host": [ "{{operationsAppIngress}}" ], "path": [ "api", "v1", "errorcode", "" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Date", "value": "Mon, 07 Feb 2022 16:39:05 GMT" }, { "key": "vary", "value": "Origin" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "X-Kong-Upstream-Latency", "value": "15" }, { "key": "X-Kong-Proxy-Latency", "value": "4" }, { "key": "Via", "value": "kong/2.2.1" } ], "cookie": [], "body": "[\n {\n \"id\": 1,\n \"transactionType\": \"COLLECTION-MPESA\",\n \"errorMessage\": \"DS timeout.\",\n \"errorCode\": \"1037\",\n \"recoverable\": true\n }\n]" } ] }, { "name": "Get error code by id", "request": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/errorcode/1", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "errorcode", "1" ] } }, "response": [ { "name": "Get error code by id 200", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{operationsAppIngress}}/api/v1/errorcode/1", "host": [ "{{operationsAppIngress}}" ], "path": [ "api", "v1", "errorcode", "1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Date", "value": "Mon, 07 Feb 2022 16:40:29 GMT" }, { "key": "vary", "value": "Origin" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "X-Kong-Upstream-Latency", "value": "24" }, { "key": "X-Kong-Proxy-Latency", "value": "5" }, { "key": "Via", "value": "kong/2.2.1" } ], "cookie": [], "body": "{\n \"id\": 1,\n \"transactionType\": \"COLLECTION-MPESA\",\n \"errorMessage\": \"DS timeout.\",\n \"errorCode\": \"1037\",\n \"recoverable\": true\n}" } ] }, { "name": "Filter error codes", "request": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/errorcode/filter?value=1037&by=errorCode", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "errorcode", "filter" ], "query": [ { "key": "value", "value": "1037" }, { "key": "by", "value": "errorCode" } ] } }, "response": [ { "name": "Filter error code by transactionType", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{operationsAppIngress}}/api/v1/errorcode/filter?by=transactionType&value=COLLECTION-MPESA", "host": [ "{{operationsAppIngress}}" ], "path": [ "api", "v1", "errorcode", "filter" ], "query": [ { "key": "by", "value": "transactionType" }, { "key": "value", "value": "COLLECTION-MPESA" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Date", "value": "Mon, 07 Feb 2022 16:43:34 GMT" }, { "key": "vary", "value": "Origin" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "X-Kong-Upstream-Latency", "value": "10" }, { "key": "X-Kong-Proxy-Latency", "value": "3" }, { "key": "Via", "value": "kong/2.2.1" } ], "cookie": [], "body": "[\n {\n \"id\": 1,\n \"transactionType\": \"COLLECTION-MPESA\",\n \"errorMessage\": \"DS timeout.\",\n \"errorCode\": \"1037\",\n \"recoverable\": true\n }\n]" }, { "name": "Filter error code by is recoverable or not", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{operationsAppIngress}}/api/v1/errorcode/filter?by=recoverable&value=true", "host": [ "{{operationsAppIngress}}" ], "path": [ "api", "v1", "errorcode", "filter" ], "query": [ { "key": "by", "value": "recoverable" }, { "key": "value", "value": "true" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Date", "value": "Mon, 07 Feb 2022 16:42:57 GMT" }, { "key": "vary", "value": "Origin" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "X-Kong-Upstream-Latency", "value": "8" }, { "key": "X-Kong-Proxy-Latency", "value": "3" }, { "key": "Via", "value": "kong/2.2.1" } ], "cookie": [], "body": "[\n {\n \"id\": 1,\n \"transactionType\": \"COLLECTION-MPESA\",\n \"errorMessage\": \"DS timeout.\",\n \"errorCode\": \"1037\",\n \"recoverable\": true\n }\n]" }, { "name": "Filter error code by errorCode", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{operationsAppIngress}}/api/v1/errorcode/filter?by=errorCode&value=1037", "host": [ "{{operationsAppIngress}}" ], "path": [ "api", "v1", "errorcode", "filter" ], "query": [ { "key": "by", "value": "errorCode" }, { "key": "value", "value": "1037" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Date", "value": "Mon, 07 Feb 2022 16:42:13 GMT" }, { "key": "vary", "value": "Origin" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "X-Kong-Upstream-Latency", "value": "17" }, { "key": "X-Kong-Proxy-Latency", "value": "4" }, { "key": "Via", "value": "kong/2.2.1" } ], "cookie": [], "body": "[\n {\n \"id\": 1,\n \"transactionType\": \"COLLECTION-MPESA\",\n \"errorMessage\": \"DS timeout.\",\n \"errorCode\": \"1037\",\n \"recoverable\": true\n }\n]" } ] }, { "name": "Add error code", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"transactionType\": \"COLLECTION-MPESA\",\n \"errorMessage\": \"Request cancelled by user\",\n \"errorCode\": \"1031\",\n \"recoverable\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{OperationsHostName}}/api/v1/errorcode/", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "errorcode", "" ] } }, "response": [ { "name": "Add error code 200", "originalRequest": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"transactionType\": \"COLLECTION-MPESA\",\n \"errorMessage\": \"DS timeout.\",\n \"errorCode\": 1037,\n \"recoverable\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{operationsAppIngress}}/api/v1/errorcode/", "host": [ "{{operationsAppIngress}}" ], "path": [ "api", "v1", "errorcode", "" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Date", "value": "Mon, 07 Feb 2022 16:38:38 GMT" }, { "key": "vary", "value": "Origin" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "X-Kong-Upstream-Latency", "value": "136" }, { "key": "X-Kong-Proxy-Latency", "value": "23" }, { "key": "Via", "value": "kong/2.2.1" } ], "cookie": [], "body": "{\n \"id\": 1,\n \"transactionType\": \"COLLECTION-MPESA\",\n \"errorMessage\": \"DS timeout.\",\n \"errorCode\": \"1037\",\n \"recoverable\": true\n}" } ] }, { "name": "Transfers", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "User-Agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:90.0) Gecko/20100101 Firefox/90.0", "disabled": true }, { "key": "Accept", "value": "application/json, text/plain, */*", "disabled": true }, { "key": "Accept-Language", "value": "en-US,en;q=0.5", "disabled": true }, { "key": "Platform-TenantId", "value": "{{TenantName}}" }, { "key": "Authorization", "value": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiaWRlbnRpdHktcHJvdmlkZXIiLCJvYWYiXSwidXNlcl9uYW1lIjoibWlmb3MiLCJzY29wZSI6WyJpZGVudGl0eSJdLCJleHAiOjE2NDI2NzA0MTcsImF1dGhvcml0aWVzIjpbIlJFRlVORCIsIkFMTF9GVU5DVElPTlMiXSwianRpIjoiQStsajFsRVNsWW9YMU9uNjdyTlNRbFhHY05VPSIsImNsaWVudF9pZCI6ImNsaWVudCJ9.flZD_GlQJ2w8P_cU0DC2hojJLUA9WS_Bc3yy9X-1v8hR1xhJZjdHUKfBl-TqNdwPnWHEvuKNdsGSEzNCP8CYR71n3J33gzEpcKVZ0P7d2bOOLX6EgtSjDdjSLU_IGRxmOZEGES9p-UPAARbj24vIM3kugG6jBbVTJ08DksnLRXP0MdWjAmW6JNq0Y2VAJq_0LSCdab5XZT-vQsRL5PdrKvPT1w28jDFklWCrft6G-6SQbqkJPGR_oQPwYBmaZOx5ateE6JDMZN5CVmejExRVPYgE-tMxXRh7GZFTDaSW1DiMzNriBeDSu3NUkuwOCC4B4Z-XmzQJw36uE6pvqGT-Pg" }, { "key": "Origin", "value": "http://localhost:4200", "disabled": true }, { "key": "Connection", "value": "keep-alive", "disabled": true }, { "key": "Referer", "value": "http://localhost:4200/", "disabled": true } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transfers?size=1&page=0&clientCorrelationId=123456789", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transfers" ], "query": [ { "key": "direction", "value": "OUTGOING", "description": "INCOMING or OUTGOING direction", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Transaction Status. Values can be COMPLETED, FAILED, IN_PROGRESS and ALL. By default set to ALL.", "disabled": true }, { "key": "size", "value": "1" }, { "key": "page", "value": "0" }, { "key": "clientCorrelationId", "value": "123456789" } ] } }, "response": [] }, { "name": "Variables", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "User-Agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:90.0) Gecko/20100101 Firefox/90.0", "disabled": true }, { "key": "Accept", "value": "application/json, text/plain, */*", "disabled": true }, { "key": "Accept-Language", "value": "en-US,en;q=0.5", "disabled": true }, { "key": "Platform-TenantId", "value": "{{TenantName}}" }, { "key": "Authorization", "value": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiaWRlbnRpdHktcHJvdmlkZXIiLCJvYWYiXSwidXNlcl9uYW1lIjoibWlmb3MiLCJzY29wZSI6WyJpZGVudGl0eSJdLCJleHAiOjE2NDI2NzA0MTcsImF1dGhvcml0aWVzIjpbIlJFRlVORCIsIkFMTF9GVU5DVElPTlMiXSwianRpIjoiQStsajFsRVNsWW9YMU9uNjdyTlNRbFhHY05VPSIsImNsaWVudF9pZCI6ImNsaWVudCJ9.flZD_GlQJ2w8P_cU0DC2hojJLUA9WS_Bc3yy9X-1v8hR1xhJZjdHUKfBl-TqNdwPnWHEvuKNdsGSEzNCP8CYR71n3J33gzEpcKVZ0P7d2bOOLX6EgtSjDdjSLU_IGRxmOZEGES9p-UPAARbj24vIM3kugG6jBbVTJ08DksnLRXP0MdWjAmW6JNq0Y2VAJq_0LSCdab5XZT-vQsRL5PdrKvPT1w28jDFklWCrft6G-6SQbqkJPGR_oQPwYBmaZOx5ateE6JDMZN5CVmejExRVPYgE-tMxXRh7GZFTDaSW1DiMzNriBeDSu3NUkuwOCC4B4Z-XmzQJw36uE6pvqGT-Pg", "disabled": true }, { "key": "Origin", "value": "http://localhost:4200", "disabled": true }, { "key": "Connection", "value": "keep-alive", "disabled": true }, { "key": "Referer", "value": "http://localhost:4200/", "disabled": true } ], "url": { "raw": "{{OperationsHostName}}/api/v1/variables/21037e77-7227-4757-8e45-5c356f369b11", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "variables", "21037e77-7227-4757-8e45-5c356f369b11" ], "query": [ { "key": "direction", "value": "OUTGOING", "description": "INCOMING or OUTGOING direction", "disabled": true }, { "key": "status", "value": "{{status}}", "description": "Transaction Status. Values can be COMPLETED, FAILED, IN_PROGRESS and ALL. By default set to ALL.", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "clientCorrelationId", "value": "123456789", "disabled": true } ] } }, "response": [] }, { "name": "Get Transaction Request", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?clientCorrelationId=123", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "state", "value": "ACCEPTED", "description": "IN_PROGRESS, RECEIVED, ACCEPTED, REJECTED, FAILED", "disabled": true }, { "key": "amount", "value": "1", "disabled": true }, { "key": "currency", "value": "USD", "disabled": true }, { "key": "direction", "value": "INCOMING", "disabled": true }, { "key": "payerPartyId", "value": "254708374149", "disabled": true }, { "key": "payeePartyId", "value": "24450523", "disabled": true }, { "key": "payeeDfspId", "value": "null", "disabled": true }, { "key": "payerDfspId", "value": "null", "disabled": true }, { "key": "startFrom", "value": "2022-06-09 10:00:00", "description": "yyyy-MM-dd HH:mm:ss", "disabled": true }, { "key": "startTo", "value": "2022-06-09 11:00:00", "description": "yyyy-MM-dd HH:mm:ss", "disabled": true }, { "key": "sortedBy", "value": "currency", "disabled": true }, { "key": "sortedOrder", "value": "ASC", "description": "DESC, ASC", "disabled": true }, { "key": "clientCorrelationId", "value": "123" } ] } }, "response": [ { "name": "Get Transaction Request by transactionId", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?transactionId=8c2358be640c4BtABNeY", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY" }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Tue, 05 Jul 2022 16:00:23 GMT" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"id\": 1,\n \"workflowInstanceKey\": \"2251799816099637\",\n \"transactionId\": \"8c2358be640c4BtABNeY\",\n \"startedAt\": 1654769838000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n }\n ],\n \"totalPages\": 1,\n \"totalElements\": 1,\n \"last\": true,\n \"numberOfElements\": 1,\n \"sort\": [\n {\n \"direction\": \"DESC\",\n \"property\": \"startedAt\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": true,\n \"ascending\": false\n }\n ],\n \"first\": true,\n \"size\": 20,\n \"number\": 0\n}" }, { "name": "Get Transaction Request by state", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?state=ACCEPTED", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "state", "value": "ACCEPTED" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Tue, 05 Jul 2022 16:02:51 GMT" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"id\": 2,\n \"workflowInstanceKey\": \"2251799816729405\",\n \"transactionId\": \"dd2183f3ac5d5leU5nz3\",\n \"startedAt\": 1654993348000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n },\n {\n \"id\": 1,\n \"workflowInstanceKey\": \"2251799816099637\",\n \"transactionId\": \"8c2358be640c4BtABNeY\",\n \"startedAt\": 1654769838000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n }\n ],\n \"totalPages\": 1,\n \"totalElements\": 2,\n \"last\": true,\n \"numberOfElements\": 2,\n \"sort\": [\n {\n \"direction\": \"DESC\",\n \"property\": \"startedAt\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": true,\n \"ascending\": false\n }\n ],\n \"first\": true,\n \"size\": 20,\n \"number\": 0\n}" }, { "name": "Get Transaction Request by amount", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?amount=1", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "state", "value": "ACCEPTED", "disabled": true }, { "key": "amount", "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Tue, 05 Jul 2022 16:05:13 GMT" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"id\": 2,\n \"workflowInstanceKey\": \"2251799816729405\",\n \"transactionId\": \"dd2183f3ac5d5leU5nz3\",\n \"startedAt\": 1654993348000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n },\n {\n \"id\": 1,\n \"workflowInstanceKey\": \"2251799816099637\",\n \"transactionId\": \"8c2358be640c4BtABNeY\",\n \"startedAt\": 1654769838000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n }\n ],\n \"totalPages\": 1,\n \"totalElements\": 2,\n \"last\": true,\n \"numberOfElements\": 2,\n \"sort\": [\n {\n \"direction\": \"DESC\",\n \"property\": \"startedAt\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": true,\n \"ascending\": false\n }\n ],\n \"first\": true,\n \"size\": 20,\n \"number\": 0\n}" }, { "name": "Get Transaction Request by currency", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?currency=USD", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "state", "value": "ACCEPTED", "disabled": true }, { "key": "amount", "value": "1", "disabled": true }, { "key": "currency", "value": "USD" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Tue, 05 Jul 2022 16:06:00 GMT" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"id\": 2,\n \"workflowInstanceKey\": \"2251799816729405\",\n \"transactionId\": \"dd2183f3ac5d5leU5nz3\",\n \"startedAt\": 1654993348000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n },\n {\n \"id\": 1,\n \"workflowInstanceKey\": \"2251799816099637\",\n \"transactionId\": \"8c2358be640c4BtABNeY\",\n \"startedAt\": 1654769838000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n }\n ],\n \"totalPages\": 1,\n \"totalElements\": 2,\n \"last\": true,\n \"numberOfElements\": 2,\n \"sort\": [\n {\n \"direction\": \"DESC\",\n \"property\": \"startedAt\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": true,\n \"ascending\": false\n }\n ],\n \"first\": true,\n \"size\": 20,\n \"number\": 0\n}" }, { "name": "Get Transaction Request by direction", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?direction=INCOMING", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "state", "value": "ACCEPTED", "disabled": true }, { "key": "amount", "value": "1", "disabled": true }, { "key": "currency", "value": "USD", "disabled": true }, { "key": "direction", "value": "INCOMING" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Tue, 05 Jul 2022 16:07:07 GMT" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"id\": 2,\n \"workflowInstanceKey\": \"2251799816729405\",\n \"transactionId\": \"dd2183f3ac5d5leU5nz3\",\n \"startedAt\": 1654993348000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n },\n {\n \"id\": 1,\n \"workflowInstanceKey\": \"2251799816099637\",\n \"transactionId\": \"8c2358be640c4BtABNeY\",\n \"startedAt\": 1654769838000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n }\n ],\n \"totalPages\": 1,\n \"totalElements\": 2,\n \"last\": true,\n \"numberOfElements\": 2,\n \"sort\": [\n {\n \"direction\": \"DESC\",\n \"property\": \"startedAt\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": true,\n \"ascending\": false\n }\n ],\n \"first\": true,\n \"size\": 20,\n \"number\": 0\n}" }, { "name": "Get Transaction Request by payerPartyId", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?payerPartyId=254708374149", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "state", "value": "ACCEPTED", "disabled": true }, { "key": "amount", "value": "1", "disabled": true }, { "key": "currency", "value": "USD", "disabled": true }, { "key": "direction", "value": "INCOMING", "disabled": true }, { "key": "payerPartyId", "value": "254708374149" }, { "key": "payeePartyId", "value": "0", "disabled": true }, { "key": "payeeDfspId", "value": "0", "disabled": true }, { "key": "payerDfspId", "value": "0", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Tue, 05 Jul 2022 16:08:39 GMT" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"id\": 2,\n \"workflowInstanceKey\": \"2251799816729405\",\n \"transactionId\": \"dd2183f3ac5d5leU5nz3\",\n \"startedAt\": 1654993348000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n },\n {\n \"id\": 1,\n \"workflowInstanceKey\": \"2251799816099637\",\n \"transactionId\": \"8c2358be640c4BtABNeY\",\n \"startedAt\": 1654769838000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n }\n ],\n \"totalPages\": 1,\n \"totalElements\": 2,\n \"last\": true,\n \"numberOfElements\": 2,\n \"sort\": [\n {\n \"direction\": \"DESC\",\n \"property\": \"startedAt\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": true,\n \"ascending\": false\n }\n ],\n \"first\": true,\n \"size\": 20,\n \"number\": 0\n}" }, { "name": "Get Transaction Request by payeePartyId", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?payeePartyId=24450523", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "state", "value": "ACCEPTED", "disabled": true }, { "key": "amount", "value": "1", "disabled": true }, { "key": "currency", "value": "USD", "disabled": true }, { "key": "direction", "value": "INCOMING", "disabled": true }, { "key": "payerPartyId", "value": "254708374149", "disabled": true }, { "key": "payeePartyId", "value": "24450523" }, { "key": "payeeDfspId", "value": "0", "disabled": true }, { "key": "payerDfspId", "value": "0", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Tue, 05 Jul 2022 16:09:53 GMT" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"id\": 2,\n \"workflowInstanceKey\": \"2251799816729405\",\n \"transactionId\": \"dd2183f3ac5d5leU5nz3\",\n \"startedAt\": 1654993348000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n },\n {\n \"id\": 1,\n \"workflowInstanceKey\": \"2251799816099637\",\n \"transactionId\": \"8c2358be640c4BtABNeY\",\n \"startedAt\": 1654769838000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n }\n ],\n \"totalPages\": 1,\n \"totalElements\": 2,\n \"last\": true,\n \"numberOfElements\": 2,\n \"sort\": [\n {\n \"direction\": \"DESC\",\n \"property\": \"startedAt\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": true,\n \"ascending\": false\n }\n ],\n \"first\": true,\n \"size\": 20,\n \"number\": 0\n}" }, { "name": "Get Transaction Request by payeeDfspId", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?payeeDfspId=null", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "state", "value": "ACCEPTED", "disabled": true }, { "key": "amount", "value": "1", "disabled": true }, { "key": "currency", "value": "USD", "disabled": true }, { "key": "direction", "value": "INCOMING", "disabled": true }, { "key": "payerPartyId", "value": "254708374149", "disabled": true }, { "key": "payeePartyId", "value": "24450523", "disabled": true }, { "key": "payeeDfspId", "value": "null" }, { "key": "payerDfspId", "value": "0", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Tue, 05 Jul 2022 16:11:26 GMT" } ], "cookie": [], "body": "{\n \"content\": [],\n \"totalPages\": 0,\n \"totalElements\": 0,\n \"last\": true,\n \"numberOfElements\": 0,\n \"sort\": [\n {\n \"direction\": \"DESC\",\n \"property\": \"startedAt\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": true,\n \"ascending\": false\n }\n ],\n \"first\": true,\n \"size\": 20,\n \"number\": 0\n}" }, { "name": "Get Transaction Request by payerDfspId", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?payerDfspId=null", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "state", "value": "ACCEPTED", "disabled": true }, { "key": "amount", "value": "1", "disabled": true }, { "key": "currency", "value": "USD", "disabled": true }, { "key": "direction", "value": "INCOMING", "disabled": true }, { "key": "payerPartyId", "value": "254708374149", "disabled": true }, { "key": "payeePartyId", "value": "24450523", "disabled": true }, { "key": "payeeDfspId", "value": "null", "disabled": true }, { "key": "payerDfspId", "value": "null" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Tue, 05 Jul 2022 16:12:21 GMT" } ], "cookie": [], "body": "{\n \"content\": [],\n \"totalPages\": 0,\n \"totalElements\": 0,\n \"last\": true,\n \"numberOfElements\": 0,\n \"sort\": [\n {\n \"direction\": \"DESC\",\n \"property\": \"startedAt\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": true,\n \"ascending\": false\n }\n ],\n \"first\": true,\n \"size\": 20,\n \"number\": 0\n}" }, { "name": "Get Transaction Request before a date", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?startTo=2022-06-10 10:17:18", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "state", "value": "ACCEPTED", "description": "IN_PROGRESS, RECEIVED, ACCEPTED, REJECTED, FAILED", "disabled": true }, { "key": "amount", "value": "1", "disabled": true }, { "key": "currency", "value": "USD", "disabled": true }, { "key": "direction", "value": "INCOMING", "disabled": true }, { "key": "payerPartyId", "value": "254708374149", "disabled": true }, { "key": "payeePartyId", "value": "24450523", "disabled": true }, { "key": "payeeDfspId", "value": "null", "disabled": true }, { "key": "payerDfspId", "value": "null", "disabled": true }, { "key": "startFrom", "value": "2022-06-10 10:17:18", "description": "yyyy-MM-dd HH:mm:ss", "disabled": true }, { "key": "startTo", "value": "2022-06-10 10:17:18", "description": "yyyy-MM-dd HH:mm:ss" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Wed, 06 Jul 2022 10:14:37 GMT" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"id\": 1,\n \"workflowInstanceKey\": \"2251799816099637\",\n \"transactionId\": \"8c2358be640c4BtABNeY\",\n \"startedAt\": 1654769838000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n }\n ],\n \"totalPages\": 1,\n \"totalElements\": 1,\n \"last\": true,\n \"numberOfElements\": 1,\n \"sort\": [\n {\n \"direction\": \"DESC\",\n \"property\": \"startedAt\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": true,\n \"ascending\": false\n }\n ],\n \"first\": true,\n \"size\": 20,\n \"number\": 0\n}" }, { "name": "Get Transaction Request after a date", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?startFrom=2022-06-10 10:17:18", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "state", "value": "ACCEPTED", "description": "IN_PROGRESS, RECEIVED, ACCEPTED, REJECTED, FAILED", "disabled": true }, { "key": "amount", "value": "1", "disabled": true }, { "key": "currency", "value": "USD", "disabled": true }, { "key": "direction", "value": "INCOMING", "disabled": true }, { "key": "payerPartyId", "value": "254708374149", "disabled": true }, { "key": "payeePartyId", "value": "24450523", "disabled": true }, { "key": "payeeDfspId", "value": "null", "disabled": true }, { "key": "payerDfspId", "value": "null", "disabled": true }, { "key": "startFrom", "value": "2022-06-10 10:17:18", "description": "yyyy-MM-dd HH:mm:ss" }, { "key": "startTo", "value": "2022-06-10 10:17:18", "description": "yyyy-MM-dd HH:mm:ss", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Wed, 06 Jul 2022 10:15:01 GMT" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"id\": 2,\n \"workflowInstanceKey\": \"2251799816729405\",\n \"transactionId\": \"dd2183f3ac5d5leU5nz3\",\n \"startedAt\": 1654993348000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n }\n ],\n \"totalPages\": 1,\n \"totalElements\": 1,\n \"last\": true,\n \"numberOfElements\": 1,\n \"sort\": [\n {\n \"direction\": \"DESC\",\n \"property\": \"startedAt\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": true,\n \"ascending\": false\n }\n ],\n \"first\": true,\n \"size\": 20,\n \"number\": 0\n}" }, { "name": "Get Transaction Request between a date", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?startFrom=2022-06-09 10:00:00&startTo=2022-06-09 11:00:00", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "state", "value": "ACCEPTED", "description": "IN_PROGRESS, RECEIVED, ACCEPTED, REJECTED, FAILED", "disabled": true }, { "key": "amount", "value": "1", "disabled": true }, { "key": "currency", "value": "USD", "disabled": true }, { "key": "direction", "value": "INCOMING", "disabled": true }, { "key": "payerPartyId", "value": "254708374149", "disabled": true }, { "key": "payeePartyId", "value": "24450523", "disabled": true }, { "key": "payeeDfspId", "value": "null", "disabled": true }, { "key": "payerDfspId", "value": "null", "disabled": true }, { "key": "startFrom", "value": "2022-06-09 10:00:00", "description": "yyyy-MM-dd HH:mm:ss" }, { "key": "startTo", "value": "2022-06-09 11:00:00", "description": "yyyy-MM-dd HH:mm:ss" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Wed, 06 Jul 2022 10:16:06 GMT" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"id\": 1,\n \"workflowInstanceKey\": \"2251799816099637\",\n \"transactionId\": \"8c2358be640c4BtABNeY\",\n \"startedAt\": 1654769838000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n }\n ],\n \"totalPages\": 1,\n \"totalElements\": 1,\n \"last\": true,\n \"numberOfElements\": 1,\n \"sort\": [\n {\n \"direction\": \"DESC\",\n \"property\": \"startedAt\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": true,\n \"ascending\": false\n }\n ],\n \"first\": true,\n \"size\": 20,\n \"number\": 0\n}" }, { "name": "Get Transaction Request by sortedBy", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?sortedBy=currency", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "state", "value": "ACCEPTED", "description": "IN_PROGRESS, RECEIVED, ACCEPTED, REJECTED, FAILED", "disabled": true }, { "key": "amount", "value": "1", "disabled": true }, { "key": "currency", "value": "USD", "disabled": true }, { "key": "direction", "value": "INCOMING", "disabled": true }, { "key": "payerPartyId", "value": "254708374149", "disabled": true }, { "key": "payeePartyId", "value": "24450523", "disabled": true }, { "key": "payeeDfspId", "value": "null", "disabled": true }, { "key": "payerDfspId", "value": "null", "disabled": true }, { "key": "startFrom", "value": "2022-06-09 10:00:00", "description": "yyyy-MM-dd HH:mm:ss", "disabled": true }, { "key": "startTo", "value": "2022-06-09 11:00:00", "description": "yyyy-MM-dd HH:mm:ss", "disabled": true }, { "key": "sortedBy", "value": "currency" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Wed, 06 Jul 2022 10:20:16 GMT" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"id\": 1,\n \"workflowInstanceKey\": \"2251799816099637\",\n \"transactionId\": \"8c2358be640c4BtABNeY\",\n \"startedAt\": 1654769838000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n },\n {\n \"id\": 2,\n \"workflowInstanceKey\": \"2251799816729405\",\n \"transactionId\": \"dd2183f3ac5d5leU5nz3\",\n \"startedAt\": 1654993348000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n }\n ],\n \"totalPages\": 1,\n \"totalElements\": 2,\n \"last\": true,\n \"numberOfElements\": 2,\n \"sort\": [\n {\n \"direction\": \"DESC\",\n \"property\": \"currency\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": true,\n \"ascending\": false\n }\n ],\n \"first\": true,\n \"size\": 20,\n \"number\": 0\n}" }, { "name": "Get Transaction Request in ascending order", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/transactionRequests/?sortedOrder=ASC", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "transactionRequests", "" ], "query": [ { "key": "transactionId", "value": "8c2358be640c4BtABNeY", "disabled": true }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "1", "disabled": true }, { "key": "state", "value": "ACCEPTED", "description": "IN_PROGRESS, RECEIVED, ACCEPTED, REJECTED, FAILED", "disabled": true }, { "key": "amount", "value": "1", "disabled": true }, { "key": "currency", "value": "USD", "disabled": true }, { "key": "direction", "value": "INCOMING", "disabled": true }, { "key": "payerPartyId", "value": "254708374149", "disabled": true }, { "key": "payeePartyId", "value": "24450523", "disabled": true }, { "key": "payeeDfspId", "value": "null", "disabled": true }, { "key": "payerDfspId", "value": "null", "disabled": true }, { "key": "startFrom", "value": "2022-06-09 10:00:00", "description": "yyyy-MM-dd HH:mm:ss", "disabled": true }, { "key": "startTo", "value": "2022-06-09 11:00:00", "description": "yyyy-MM-dd HH:mm:ss", "disabled": true }, { "key": "sortedBy", "value": "currency", "disabled": true }, { "key": "sortedOrder", "value": "ASC", "description": "DESC, ASC" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Date", "value": "Wed, 06 Jul 2022 10:23:03 GMT" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"id\": 1,\n \"workflowInstanceKey\": \"2251799816099637\",\n \"transactionId\": \"8c2358be640c4BtABNeY\",\n \"startedAt\": 1654769838000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"USD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n },\n {\n \"id\": 2,\n \"workflowInstanceKey\": \"2251799816729405\",\n \"transactionId\": \"dd2183f3ac5d5leU5nz3\",\n \"startedAt\": 1654993348000,\n \"completedAt\": null,\n \"state\": \"ACCEPTED\",\n \"payeeDfspId\": null,\n \"payeePartyId\": \"24450523\",\n \"payeePartyIdType\": \"ACCOUNTID\",\n \"payeeFee\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": null,\n \"payerPartyId\": \"254708374149\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerQuoteCode\": null,\n \"amount\": 1,\n \"currency\": \"ASD\",\n \"direction\": \"INCOMING\",\n \"authType\": null,\n \"initiatorType\": \"BUSINESS\",\n \"scenario\": \"MPESA\"\n }\n ],\n \"totalPages\": 1,\n \"totalElements\": 2,\n \"last\": true,\n \"numberOfElements\": 2,\n \"sort\": [\n {\n \"direction\": \"ASC\",\n \"property\": \"startedAt\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": false,\n \"ascending\": true\n }\n ],\n \"first\": true,\n \"size\": 20,\n \"number\": 0\n}" } ] }, { "name": "Generate x-signature (dev utility)", "event": [ { "listen": "test", "script": { "exec": [ "postman.setEnvironmentVariable(\"x-signature\", responseBody);", "postman.setEnvironmentVariable(\"X-CorrelationId\", pm.request.headers.get(\"X-CorrelationID\"));" ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "X-CorrelationID", "value": "{{$guid}}", "type": "text" }, { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "privateKey", "value": "{{privateKey}}", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "data", "type": "file", "src": "/Users/ankitagarwal/fynarfin/ph-ee-bulk-demo-7.csv" } ] }, "url": { "raw": "{{OperationsHostName}}/api/v1/util/x-signature", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "util", "x-signature" ] } }, "response": [] } ] }, { "name": "Account Management", "item": [ { "name": "Account Statement by Identifier", "request": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "ibank-usa", "type": "text" } ], "url": { "raw": "{{ChannelHostName}}/channel/accounts/{{IdentifierType}}/{{IdentifierId}}/statemententries", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "accounts", "{{IdentifierType}}", "{{IdentifierId}}", "statemententries" ] } }, "response": [] }, { "name": "Account Balance", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "ibank-usa", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{ChannelHostName}}/channel/accounts/{{IdentifierType}}/{{IdentifierId}}/balance", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "accounts", "{{IdentifierType}}", "{{IdentifierId}}", "balance" ] } }, "response": [] }, { "name": "Account Status", "request": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "ibank-usa", "type": "text" } ], "url": { "raw": "{{ChannelHostName}}/channel/accounts/{{IdentifierType}}/{{IdentifierId}}/status", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "accounts", "{{IdentifierType}}", "{{IdentifierId}}", "status" ] } }, "response": [] }, { "name": "Account Name", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "ibank-usa", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{ChannelHostName}}/channel/accounts/{{IdentifierType}}/{{IdentifierId}}/accountname", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "accounts", "{{IdentifierType}}", "{{IdentifierId}}", "accountname" ] } }, "response": [] }, { "name": "Account Transactions", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "ibank-usa", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{ChannelHostName}}/channel/accounts/{{IdentifierType}}/{{IdentifierId}}/transactions", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "accounts", "{{IdentifierType}}", "{{IdentifierId}}", "transactions" ] } }, "response": [] }, { "name": "Deposit Money Copy", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "ibank-usa", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"304\",\n \"type\": \"transfer\",\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+919900878571\"\n }\n ],\n \"currency\": \"USD\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/deposit", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "deposit" ] } }, "response": [] } ] }, { "name": "Customer Management", "item": [ { "name": "Customer Set PIN", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "ibank-usa", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"existingPin\": \"String\",\n \"pin\": \"String\"\n}" }, "url": { "raw": "{{ChannelHostName}}/channel/customers/{{IdentifierType}}/{{IdentifierId}}/cpin", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "customers", "{{IdentifierType}}", "{{IdentifierId}}", "cpin" ] } }, "response": [] }, { "name": "Customer Creation", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "ibank-usa", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"identifierType\": \"String\",\n \"IdentifierId\": \"String\"\n}" }, "url": { "raw": "{{ChannelHostName}}/channel/customers", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "customers" ] } }, "response": [] } ] }, { "name": "Miscellaneous", "item": [ { "name": "Heartbeat", "request": { "method": "GET", "header": [], "url": { "raw": "{{ChannelHostName}}/channel/heartbeat", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "heartbeat" ] } }, "response": [] } ] }, { "name": "Mojaloop APIs", "item": [ { "name": "Transfer Details", "request": { "method": "GET", "header": [], "url": { "raw": "{{ChannelHostName}}/channel/transfer/{{transactionId}}", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "transfer", "{{transactionId}}" ] } }, "response": [] }, { "name": "Transfer", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"payer\": {\n \"partyIdInfo\": {\n \"partyIdType\": \"MSISDN\",\n \"partyIdentifier\": \"27710101999\"\n }\n },\n \"payee\": {\n \"partyIdInfo\": {\n \"partyIdType\": \"MSISDN\",\n \"partyIdentifier\": \"27710102999\"\n }\n },\n \"amount\": {\n \"amount\": 230,\n \"currency\": \"TZS\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/transfer", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "transfer" ] } }, "response": [] }, { "name": "Transfer Request", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"payer\": {\n \"partyIdInfo\": {\n \"partyIdType\": \"MSISDN\",\n \"partyIdentifier\": \"27710203999\"\n }\n },\n \"payee\": {\n \"partyIdInfo\": {\n \"partyIdType\": \"MSISDN\",\n \"partyIdentifier\": \"27710305999\"\n }\n },\n \"amount\": {\n \"amount\": 77,\n \"currency\": \"TZS\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/transactionRequest", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "transactionRequest" ] } }, "response": [] }, { "name": "Party Registration", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"accountId\":\"9062b90de19b43989005\",\n \"idType\": \"EMAIL\",\n \"idValue\": \"test@test.hu\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/partyRegistration", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "partyRegistration" ] } }, "response": [] } ] }, { "name": "Channel APIs", "item": [ { "name": "GSMA Stub", "item": [ { "name": "transactions", "item": [ { "name": "{transaction Reference}", "item": [ { "name": "View A Transaction", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/transactions/{{transactionReference}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "transactions", "{{transactionReference}}" ] }, "description": "This endpoint returns the details of a transaction" }, "response": [ { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionReference", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionReference" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Transaction response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionReference", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionReference" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"amount\": \"15.21\",\n \"currency\": \"\",\n \"type\": \"\",\n \"transactionReference\": \"\",\n \"transactionStatus\": \"\",\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"subType\": \"\",\n \"descriptionText\": \"\",\n \"requestDate\": \"\",\n \"requestingOrganisationTransactionReference\": \"\",\n \"oneTimeCode\": \"\",\n \"geoCode\": \"37.423825,-122.082900\",\n \"senderKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"recipientKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"originalTransactionReference\": \"\",\n \"servicingIdentity\": \"\",\n \"fees\": [\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n },\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n }\n ],\n \"requestingLei\": \"54930084UKLVMY22DS16\",\n \"receivingLei\": \"5493000IBP32UQZ0KL24\",\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\",\n \"transactionReceipt\": \"\",\n \"internationalTransferInformation\": {\n \"originCountry\": \"\",\n \"quotationReference\": \"\",\n \"quoteId\": \"\",\n \"receivingCountry\": \"\",\n \"remittancePurpose\": \"\",\n \"relationshipSender\": \"\",\n \"deliveryMethod\": \"\",\n \"senderBlockingReason\": \"\",\n \"recipientBlockingReason\": \"\"\n }\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionReference", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionReference" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionReference", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionReference" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionReference", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionReference" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionReference", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionReference" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "Create A Reversal", "request": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Callback-URL", "value": "", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestingOrganisationTransactionReference\": \"string\",\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"type\": \"reversal\",\n \"subType\": \"string\",\n \"amount\": \"15.21\",\n \"currency\": \"AED\",\n \"descriptionText\": \"string\",\n \"fees\": [\n {\n \"feeType\": \"string\",\n \"feeAmount\": \"15.21\",\n \"feeCurrency\": \"AED\"\n }\n ],\n \"geoCode\": \"37.423825,-122.082900\",\n \"requestingOrganisation\": {\n \"requestingOrganisationIdentifierType\": \"lei\",\n \"requestingOrganisationIdentifier\": \"string\"\n },\n \"servicingIdentity\": \"string\",\n \"requestDate\": \"2022-09-29T00:38:52.909Z\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ]\n}" }, "url": { "raw": "{{ChannelGSMAHostName}}/transactions/{{transactionReference}}/reversals", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "transactions", "{{transactionReference}}", "reversals" ] }, "description": "Provided with a valid object representation, this endpoint allows for a new reversal to be created" }, "response": [ { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionReference/reversals", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionReference", "reversals" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionReference/reversals", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionReference", "reversals" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionReference/reversals", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionReference", "reversals" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionReference/reversals", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionReference", "reversals" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents a Transaction Reversal response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionReference/reversals", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionReference", "reversals" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"reversal\",\n \"originalTransactionReference\": \"\",\n \"transactionReference\": \"\",\n \"transactionStatus\": \"\",\n \"amount\": \"15.21\",\n \"currency\": \"\",\n \"subType\": \"\",\n \"descriptionText\": \"\",\n \"requestDate\": \"\",\n \"geoCode\": \"37.423825,-122.082900\",\n \"requestingOrganisationTransactionReference\": \"\",\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"requestingLei\": \"54930084UKLVMY22DS16\",\n \"receivingLei\": \"5493000IBP32UQZ0KL24\",\n \"servicingIdentity\": \"\",\n \"fees\": [\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n },\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\",\n \"transactionReceipt\": \"\"\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionReference/reversals", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionReference", "reversals" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionReference/reversals", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionReference", "reversals" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "Create a Transaction", "request": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Callback-URL", "value": "", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestingOrganisationTransactionReference\": \"string\",\n \"originalTransactionReference\": \"string\",\n \"subType\": \"string\",\n \"type\": \"transfer\",\n \"amount\": \"15.21\",\n \"currency\": \"AED\",\n \"descriptionText\": \"string\",\n \"fees\": [\n {\n \"feeType\": \"string\",\n \"feeAmount\": \"15.21\",\n \"feeCurrency\": \"AED\"\n }\n ],\n \"geoCode\": \"37.423825,-122.082900\",\n \"internationalTransferInformation\": {\n \"quotationReference\": \"string\",\n \"quoteId\": \"string\",\n \"originCountry\": \"AD\",\n \"deliveryMethod\": \"directtoaccount\",\n \"receivingCountry\": \"AD\",\n \"relationshipSender\": \"string\",\n \"remittancePurpose\": \"string\",\n \"sendingServiceProviderCountry\": \"AD\"\n },\n \"oneTimeCode\": \"string\",\n \"recipientKyc\": {\n \"birthCountry\": \"AD\",\n \"contactPhone\": \"string\",\n \"dateOfBirth\": \"2000-11-20\",\n \"emailAddress\": \"string\",\n \"employerName\": \"string\",\n \"gender\": \"m\",\n \"idDocument\": [\n {\n \"idType\": \"passport\",\n \"idNumber\": \"string\",\n \"issueDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"expiryDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"issuer\": \"string\",\n \"issuerPlace\": \"string\",\n \"issuerCountry\": \"AD\",\n \"otherIddescription\": \"string\"\n }\n ],\n \"nationality\": \"AD\",\n \"occupation\": \"string\",\n \"postalAddress\": {\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\",\n \"city\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"AD\"\n },\n \"subjectName\": {\n \"title\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"fullName\": \"string\",\n \"nativeName\": \"string\"\n }\n },\n \"senderKyc\": {\n \"birthCountry\": \"AD\",\n \"contactPhone\": \"string\",\n \"dateOfBirth\": \"2022-09-28T12:51:19.260+00:00\",\n \"emailAddress\": \"string\",\n \"employerName\": \"string\",\n \"gender\": \"m\",\n \"idDocument\": [\n {\n \"idType\": \"passport\",\n \"idNumber\": \"string\",\n \"issueDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"expiryDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"issuer\": \"string\",\n \"issuerPlace\": \"string\",\n \"issuerCountry\": \"AD\",\n \"otherIddescription\": \"string\"\n }\n ],\n \"nationality\": \"AD\",\n \"occupation\": \"string\",\n \"postalAddress\": {\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\",\n \"city\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"AD\"\n },\n \"subjectName\": {\n \"title\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"fullName\": \"string\",\n \"nativeName\": \"string\"\n }\n },\n \"requestingOrganisation\": {\n \"requestingOrganisationIdentifierType\": \"lei\",\n \"requestingOrganisationIdentifier\": \"string\"\n },\n \"servicingIdentity\": \"string\",\n \"requestDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555987456\"\n }\n ]\n}" }, "url": { "raw": "{{ChannelGSMAHostName}}/transactions", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "transactions" ] }, "description": "Provided with a valid object representation, this endpoint allows for a new transaction to be created" }, "response": [ { "name": "Represents an Asynchronous response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Transaction response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"amount\": \"15.21\",\n \"currency\": \"\",\n \"type\": \"\",\n \"transactionReference\": \"\",\n \"transactionStatus\": \"\",\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"subType\": \"\",\n \"descriptionText\": \"\",\n \"requestDate\": \"\",\n \"requestingOrganisationTransactionReference\": \"\",\n \"oneTimeCode\": \"\",\n \"geoCode\": \"37.423825,-122.082900\",\n \"senderKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"recipientKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"originalTransactionReference\": \"\",\n \"servicingIdentity\": \"\",\n \"fees\": [\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n },\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n }\n ],\n \"requestingLei\": \"54930084UKLVMY22DS16\",\n \"receivingLei\": \"5493000IBP32UQZ0KL24\",\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\",\n \"transactionReceipt\": \"\",\n \"internationalTransferInformation\": {\n \"originCountry\": \"\",\n \"quotationReference\": \"\",\n \"quoteId\": \"\",\n \"receivingCountry\": \"\",\n \"remittancePurpose\": \"\",\n \"relationshipSender\": \"\",\n \"deliveryMethod\": \"\",\n \"senderBlockingReason\": \"\",\n \"recipientBlockingReason\": \"\"\n }\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "Create a Transaction", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{}" }, "url": { "raw": "{{ChannelGSMAHostName}}/transactions/type/transfer", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "transactions", "type", "transfer" ] }, "description": "Provided with a valid object representation, this endpoint allows for a new transaction to be created for a given transaction type passed via the URL." }, "response": [ { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/type/:transactionType", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "type", ":transactionType" ], "variable": [ { "key": "transactionType" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/type/:transactionType", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "type", ":transactionType" ], "variable": [ { "key": "transactionType" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/type/:transactionType", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "type", ":transactionType" ], "variable": [ { "key": "transactionType" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Transaction response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/type/:transactionType", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "type", ":transactionType" ], "variable": [ { "key": "transactionType" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n]" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/type/:transactionType", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "type", ":transactionType" ], "variable": [ { "key": "transactionType" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/type/:transactionType", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "type", ":transactionType" ], "variable": [ { "key": "transactionType" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/transactions/type/:transactionType", "host": [ "{{baseUrl}}" ], "path": [ "transactions", "type", ":transactionType" ], "variable": [ { "key": "transactionType" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" } ] } ] }, { "name": "batchtransactions", "item": [ { "name": "{batch Id}", "item": [ { "name": "View A Transaction Batch", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/batchtransactions/{{batchId}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "batchtransactions", "{{batchId}}" ] }, "description": "This endpoint returns the current status of a batch transaction" }, "response": [ { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Batch Transaction response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"approvalDate\": \"\",\n \"batchId\": \"\",\n \"batchStatus\": \"\",\n \"completionDate\": \"\",\n \"creationDate\": \"\",\n \"batchTitle\": \"\",\n \"batchdescription\": \"\",\n \"processingFlag\": \"\",\n \"scheduledStartDate\": \"\",\n \"completedDate\": \"\",\n \"rejectionCount\": \"\",\n \"parsingSuccessCount\": \"\",\n \"completedCount\": \"\"\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "Update A Transaction Batch", "request": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID.", "disabled": true }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"string\",\n \"value\": \"string\"\n }\n]" }, "url": { "raw": "{{ChannelGSMAHostName}}/batchtransactions/{{batchId}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "batchtransactions", "{{batchId}}" ] }, "description": "This endpoint updates a specific transaction batch" }, "response": [ { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "An empty response is returned for a synchronous successful patch.", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId" ], "variable": [ { "key": "batchId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View Batch Rejections", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/batchtransactions/{{batchId}}/rejections", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "batchtransactions", "{{batchId}}", "rejections" ], "query": [ { "key": "limit", "value": "", "description": "Supports pagination. If this is not supplied, then the server will apply a limit of 50 records returned for each request.", "disabled": true }, { "key": "offset", "value": "", "description": "Supports pagination. This value will indicate the cursor position from where to retrieve the set of records. For example, a limit of 50 and offset of 10 will return records 11 to 60.", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "Indicates the minimum date for which records should be returned.", "disabled": true }, { "key": "toDateTime", "value": "", "description": "Indicates the maximum date for which records should be returned.", "disabled": true } ] }, "description": "This endpoint returns rejected transactions for a specific batch\"" }, "response": [ { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId/rejections?limit=&offset=&fromDateTime=&toDateTime=", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId", "rejections" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" } ], "variable": [ { "key": "batchId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId/rejections?limit=&offset=&fromDateTime=&toDateTime=", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId", "rejections" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" } ], "variable": [ { "key": "batchId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId/rejections?limit=&offset=&fromDateTime=&toDateTime=", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId", "rejections" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" } ], "variable": [ { "key": "batchId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Batch Transaction Rejection response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId/rejections?limit=&offset=&fromDateTime=&toDateTime=", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId", "rejections" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" } ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "X-Records-Available-Count", "value": "", "description": "Integer containing number of records that are available to be returned." }, { "key": "X-Records-Returned-Count", "value": "", "description": "Integer containing number of records that are returned." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"rejectionDate\": \"\",\n \"rejectionReason\": \"\",\n \"transactionReference\": \"\",\n \"dateRejected\": \"\",\n \"requestingOrganisationTransactionReference\": \"\"\n },\n {\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"rejectionDate\": \"\",\n \"rejectionReason\": \"\",\n \"transactionReference\": \"\",\n \"dateRejected\": \"\",\n \"requestingOrganisationTransactionReference\": \"\"\n }\n]" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId/rejections?limit=&offset=&fromDateTime=&toDateTime=", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId", "rejections" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" } ], "variable": [ { "key": "batchId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId/rejections?limit=&offset=&fromDateTime=&toDateTime=", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId", "rejections" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" } ], "variable": [ { "key": "batchId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View Batch Completions", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/batchtransactions/{{batchId}}/completions", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "batchtransactions", "{{batchId}}", "completions" ], "query": [ { "key": "limit", "value": "", "description": "Supports pagination. If this is not supplied, then the server will apply a limit of 50 records returned for each request.", "disabled": true }, { "key": "offset", "value": "", "description": "Supports pagination. This value will indicate the cursor position from where to retrieve the set of records. For example, a limit of 50 and offset of 10 will return records 11 to 60.", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "Indicates the minimum date for which records should be returned.", "disabled": true }, { "key": "toDateTime", "value": "", "description": "Indicates the maximum date for which records should be returned.", "disabled": true } ] }, "description": "This endpoint returns completed transactions for a specific batch" }, "response": [ { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId/completions?limit=&offset=&fromDateTime=&toDateTime=", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId", "completions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" } ], "variable": [ { "key": "batchId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId/completions?limit=&offset=&fromDateTime=&toDateTime=", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId", "completions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" } ], "variable": [ { "key": "batchId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId/completions?limit=&offset=&fromDateTime=&toDateTime=", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId", "completions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" } ], "variable": [ { "key": "batchId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represent a list of Batch Completions", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId/completions?limit=&offset=&fromDateTime=&toDateTime=", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId", "completions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" } ], "variable": [ { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "X-Records-Available-Count", "value": "", "description": "Integer containing number of records that are available to be returned." }, { "key": "X-Records-Returned-Count", "value": "", "description": "Integer containing number of records that are returned." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"completionDate\": \"\",\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"link\": \"\",\n \"transactionReference\": \"\",\n \"completedDate\": \"\",\n \"requestingOrganisationTransactionReference\": \"\"\n },\n {\n \"completionDate\": \"\",\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"link\": \"\",\n \"transactionReference\": \"\",\n \"completedDate\": \"\",\n \"requestingOrganisationTransactionReference\": \"\"\n }\n]" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId/completions?limit=&offset=&fromDateTime=&toDateTime=", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId", "completions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" } ], "variable": [ { "key": "batchId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions/:batchId/completions?limit=&offset=&fromDateTime=&toDateTime=", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions", ":batchId", "completions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" } ], "variable": [ { "key": "batchId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "Create A Transaction Batch", "request": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Callback-URL", "value": "", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"batchStatus\": \"created\",\n \"transactions\": [\n {\n \"requestingOrganisationTransactionReference\": \"string\",\n \"originalTransactionReference\": \"string\",\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"type\": \"billpay\",\n \"subType\": \"string\",\n \"amount\": \"15.21\",\n \"currency\": \"AED\",\n \"descriptionText\": \"string\",\n \"fees\": [\n {\n \"feeType\": \"string\",\n \"feeAmount\": \"15.21\",\n \"feeCurrency\": \"AED\"\n }\n ],\n \"geoCode\": \"37.423825,-122.082900\",\n \"internationalTransferInformation\": {\n \"quotationReference\": \"string\",\n \"quoteId\": \"string\",\n \"originCountry\": \"AD\",\n \"deliveryMethod\": \"directtoaccount\",\n \"receivingCountry\": \"AD\",\n \"relationshipSender\": \"string\",\n \"remittancePurpose\": \"string\",\n \"sendingServiceProviderCountry\": \"AD\"\n },\n \"oneTimeCode\": \"string\",\n \"recipientKyc\": {\n \"birthCountry\": \"AD\",\n \"contactPhone\": \"string\",\n \"dateOfBirth\": \"2000-11-20\",\n \"emailAddress\": \"string\",\n \"employerName\": \"string\",\n \"gender\": \"m\",\n \"idDocument\": [\n {\n \"idType\": \"passport\",\n \"idNumber\": \"string\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"string\",\n \"issuerPlace\": \"string\",\n \"issuerCountry\": \"AD\",\n \"otherIddescription\": \"string\"\n }\n ],\n \"nationality\": \"AD\",\n \"occupation\": \"string\",\n \"postalAddress\": {\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\",\n \"city\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"AD\"\n },\n \"subjectName\": {\n \"title\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"fullName\": \"string\",\n \"nativeName\": \"string\"\n }\n },\n \"senderKyc\": {\n \"birthCountry\": \"AD\",\n \"contactPhone\": \"string\",\n \"dateOfBirth\": \"2000-11-20\",\n \"emailAddress\": \"string\",\n \"employerName\": \"string\",\n \"gender\": \"m\",\n \"idDocument\": [\n {\n \"idType\": \"passport\",\n \"idNumber\": \"string\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"string\",\n \"issuerPlace\": \"string\",\n \"issuerCountry\": \"AD\",\n \"otherIddescription\": \"string\"\n }\n ],\n \"nationality\": \"AD\",\n \"occupation\": \"string\",\n \"postalAddress\": {\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\",\n \"city\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"AD\"\n },\n \"subjectName\": {\n \"title\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"fullName\": \"string\",\n \"nativeName\": \"string\"\n }\n },\n \"requestingOrganisation\": {\n \"requestingOrganisationIdentifierType\": \"lei\",\n \"requestingOrganisationIdentifier\": \"string\"\n },\n \"servicingIdentity\": \"string\",\n \"requestDate\": \"2022-09-29T00:32:25.599Z\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ]\n }\n ],\n \"batchTitle\": \"string\",\n \"batchdescription\": \"string\",\n \"requestingOrganisation\": {\n \"requestingOrganisationIdentifierType\": \"lei\",\n \"requestingOrganisationIdentifier\": \"string\"\n },\n \"scheduledStartDate\": \"2022-09-29T00:32:25.599Z\",\n \"modificationDate\": \"2022-09-29T00:32:25.599Z\",\n \"requestDate\": \"2022-09-29T00:32:25.599Z\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ]\n}" }, "url": { "raw": "{{ChannelGSMAHostName}}/batchtransactions", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "batchtransactions" ] }, "description": "Provided with a valid object representation, this endpoint allows for a new transaction batch to be created" }, "response": [ { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions" ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/batchtransactions", "host": [ "{{baseUrl}}" ], "path": [ "batchtransactions" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" } ] } ] }, { "name": "accounts", "item": [ { "name": "{account Id}", "item": [ { "name": "bills", "item": [ { "name": "View Account Bills", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/bills", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "bills" ] }, "description": "This endpoint returns bills linked to an account" }, "response": [ { "name": "Represent a list of Bills", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/bills", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "bills" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"currency\": \"\",\n \"amountDue\": \"15.21\",\n \"dueDate\": \"2018-11-20\",\n \"billReference\": \"\",\n \"minimumAmountDue\": \"15.21\",\n \"billdescription\": \"\",\n \"billStatus\": \"\",\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"currency\": \"\",\n \"amountDue\": \"15.21\",\n \"dueDate\": \"2018-11-20\",\n \"billReference\": \"\",\n \"minimumAmountDue\": \"15.21\",\n \"billdescription\": \"\",\n \"billStatus\": \"\",\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n]" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/bills", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "bills" ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/bills", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "bills" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/bills", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "bills" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/bills", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "bills" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/bills", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "bills" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "Create A Bill Payment", "request": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Callback-URL", "value": "", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceProviderPaymentReference\": \"string\",\n \"requestingOrganisationTransactionReference\": \"string\",\n \"paymentType\": \"partialpayment\",\n \"amountPaid\": \"15.21\",\n \"currency\": \"AED\",\n \"customerReference\": \"string\",\n \"requestingOrganisation\": \"string\",\n \"supplementaryBillReferenceDetails\": [\n {\n \"paymentReferenceType\": \"string\",\n \"paymentReferenceValue\": \"string\"\n }\n ],\n \"requestDate\": \"2022-09-28T17:58:01.111Z\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"paidAmount\": \"15.21\"\n}" }, "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/bills/{{billReference}}/payments", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "bills", "{{billReference}}", "payments" ] }, "description": "Provided with a valid object representation, this endpoint allows for a new bill payment to be created for a specific account\"" }, "response": [ { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "bills", ":billReference", "payments" ], "variable": [ { "key": "accountId" }, { "key": "billReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "bills", ":billReference", "payments" ], "variable": [ { "key": "accountId" }, { "key": "billReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "bills", ":billReference", "payments" ], "variable": [ { "key": "accountId" }, { "key": "billReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "bills", ":billReference", "payments" ], "variable": [ { "key": "accountId" }, { "key": "billReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "bills", ":billReference", "payments" ], "variable": [ { "key": "accountId" }, { "key": "billReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Bill Payment response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "bills", ":billReference", "payments" ], "variable": [ { "key": "accountId" }, { "key": "billReference" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"currency\": \"\",\n \"amountPaid\": \"15.21\",\n \"billPaymentStatus\": \"\",\n \"paidAmount\": \"15.21\",\n \"serviceProviderPaymentReference\": \"\",\n \"requestingOrganisation\": \"\",\n \"requestingOrganisationTransactionReference\": \"\",\n \"customerReference\": \"\",\n \"paymentType\": \"\",\n \"serviceProviderComment\": \"\",\n \"serviceProviderNotification\": \"\",\n \"supplementaryBillReferenceDetails\": [\n {\n \"paymentReferenceType\": \"\",\n \"paymentReferenceValue\": \"\"\n },\n {\n \"paymentReferenceType\": \"\",\n \"paymentReferenceValue\": \"\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "bills", ":billReference", "payments" ], "variable": [ { "key": "accountId" }, { "key": "billReference" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" } ] } ] }, { "name": "debitmandates", "item": [ { "name": "{debit Mandate Reference}", "item": [ { "name": "View A Debit Mandate", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/debitmandates/{{debitMandateReference}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "debitmandates", "{{debitMandateReference}}" ] }, "description": "This endpoint returns a specific debit mandate linked to an account" }, "response": [ { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "accountId" }, { "key": "debitMandateReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Debit Mandate response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "accountId" }, { "key": "debitMandateReference" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"mandateReference\": \"\",\n \"currency\": \"\",\n \"amountLimit\": \"15.21\",\n \"startDate\": \"2018-11-20\",\n \"endDate\": \"2018-11-20\",\n \"numberOfPayments\": \"\",\n \"frequencyType\": \"\",\n \"mandateStatus\": \"\",\n \"requestDate\": \"\",\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\"\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "accountId" }, { "key": "debitMandateReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "accountId" }, { "key": "debitMandateReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "accountId" }, { "key": "debitMandateReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "accountId" }, { "key": "debitMandateReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "Update A Debit Mandate", "request": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"string\",\n \"value\": \"string\"\n }\n]" }, "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/debitmandates/{{debitMandateReference}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "debitmandates", "{{debitMandateReference}}" ] }, "description": "This endpoint updates a specific debit mandate linked to an account" }, "response": [ { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "accountId" }, { "key": "debitMandateReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "An empty response is returned for a synchronous successful patch.", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "accountId" }, { "key": "debitMandateReference" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "accountId" }, { "key": "debitMandateReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "accountId" }, { "key": "debitMandateReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "accountId" }, { "key": "debitMandateReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "accountId" }, { "key": "debitMandateReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "accountId" }, { "key": "debitMandateReference" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" } ] } ] }, { "name": "Create A Debit Mandate", "request": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"payee\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"mandateStatus\": \"active\",\n \"amountLimit\": \"string\",\n \"currency\": \"AED\",\n \"startDate\": \"2018-11-20\",\n \"endDate\": \"2018-11-20\",\n \"frequencyType\": \"weekly\",\n \"numberOfPayments\": 0,\n \"requestingOrganisation\": {\n \"requestingOrganisationIdentifierType\": \"lei\",\n \"requestingOrganisationIdentifier\": \"string\"\n },\n \"requestDate\": \"2022-09-29T07:29:08.821Z\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ]\n}" }, "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/debitmandates", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "debitmandates" ] }, "description": "Provided with a valid object representation, this endpoint allows for a new debit mandate to be created for a specific account." }, "response": [ { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates" ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates" ], "variable": [ { "key": "accountId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Debit Mandate response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates" ], "variable": [ { "key": "accountId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"mandateReference\": \"\",\n \"currency\": \"\",\n \"amountLimit\": \"15.21\",\n \"startDate\": \"2018-11-20\",\n \"endDate\": \"2018-11-20\",\n \"numberOfPayments\": \"\",\n \"frequencyType\": \"\",\n \"mandateStatus\": \"\",\n \"requestDate\": \"\",\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\"\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/debitmandates", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "debitmandates" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "links", "item": [ { "name": "{link Reference}", "item": [ { "name": "View A Link", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/links/{{linkReference}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "links", "{{linkReference}}" ] }, "description": "This endpoint returns a specific link" }, "response": [ { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links", ":linkReference" ], "variable": [ { "key": "accountId" }, { "key": "linkReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links", ":linkReference" ], "variable": [ { "key": "accountId" }, { "key": "linkReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Link response\"", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links", ":linkReference" ], "variable": [ { "key": "accountId" }, { "key": "linkReference" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"linkReference\": \"\",\n \"sourceAccountIdentifiers\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"status\": \"\",\n \"mode\": \"\"\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links", ":linkReference" ], "variable": [ { "key": "accountId" }, { "key": "linkReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links", ":linkReference" ], "variable": [ { "key": "accountId" }, { "key": "linkReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links", ":linkReference" ], "variable": [ { "key": "accountId" }, { "key": "linkReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "Update A Link", "request": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"string\",\n \"value\": \"string\"\n }\n]" }, "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/links/{{linkReference}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "links", "{{linkReference}}" ] }, "description": "This endpoint updates a specific link" }, "response": [ { "name": "An empty response is returned for a synchronous successful patch.", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links", ":linkReference" ], "variable": [ { "key": "accountId" }, { "key": "linkReference" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links", ":linkReference" ], "variable": [ { "key": "accountId" }, { "key": "linkReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links", ":linkReference" ], "variable": [ { "key": "accountId" }, { "key": "linkReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links", ":linkReference" ], "variable": [ { "key": "accountId" }, { "key": "linkReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links", ":linkReference" ], "variable": [ { "key": "accountId" }, { "key": "linkReference" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links", ":linkReference" ], "variable": [ { "key": "accountId" }, { "key": "linkReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links", ":linkReference" ], "variable": [ { "key": "accountId" }, { "key": "linkReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "Create A Link", "request": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"sourceAccountIdentifiers\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"mode\": \"push\",\n \"status\": \"active\",\n \"requestingOrganisation\": {\n \"requestingOrganisationIdentifierType\": \"lei\",\n \"requestingOrganisationIdentifier\": \"string\"\n },\n \"requestDate\": \"2022-09-29T07:26:54.647Z\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ]\n}" }, "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/links", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "links" ] }, "description": "Provided with a valid object representation, this endpoint allows a new link to be created for a specific account" }, "response": [ { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links" ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links" ], "variable": [ { "key": "accountId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Link response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/links", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "links" ], "variable": [ { "key": "accountId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"linkReference\": \"\",\n \"sourceAccountIdentifiers\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"status\": \"\",\n \"mode\": \"\"\n}" } ] } ] }, { "name": "authorisationcodes", "item": [ { "name": "{authorisation Code}", "item": [ { "name": "View an Authorisation Code", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/authorisationcodes/{{authorisationCode}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "authorisationcodes", "{{authorisationCode}}" ] }, "description": "This endpoint returns a specific Authorisation Code linked to an account" }, "response": [ { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "accountId" }, { "key": "authorisationCode" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "accountId" }, { "key": "authorisationCode" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "accountId" }, { "key": "authorisationCode" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "accountId" }, { "key": "authorisationCode" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Authorisation Code response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "accountId" }, { "key": "authorisationCode" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"authorisationCode\": \"\",\n \"codeState\": \"\",\n \"codeLifetime\": \"\",\n \"requestDate\": \"\",\n \"amount\": \"15.21\",\n \"currency\": \"\",\n \"amountType\": \"\",\n \"holdFundsIndicator\": \"\",\n \"redemptionChannels\": [\n {\n \"channelType\": \"\"\n },\n {\n \"channelType\": \"\"\n }\n ],\n \"redemptionTransactionTypes\": [\n {\n \"transactionType\": \"\",\n \"transactionSubtype\": \"\"\n },\n {\n \"transactionType\": \"\",\n \"transactionSubtype\": \"\"\n }\n ],\n \"redemptionAccountIdentifiers\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "accountId" }, { "key": "authorisationCode" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "Update an Authorisation Code", "request": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"string\",\n \"value\": \"string\"\n }\n]" }, "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/authorisationcodes/{{authorisationCode}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "authorisationcodes", "{{authorisationCode}}" ] }, "description": "This endpoint updates a specific Authorisation Code linked to an account" }, "response": [ { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "accountId" }, { "key": "authorisationCode" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "accountId" }, { "key": "authorisationCode" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "accountId" }, { "key": "authorisationCode" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "An empty response is returned for a synchronous successful patch.", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "accountId" }, { "key": "authorisationCode" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "accountId" }, { "key": "authorisationCode" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "accountId" }, { "key": "authorisationCode" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "accountId" }, { "key": "authorisationCode" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "Create an Authorisation Code", "request": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"15.21\",\n \"currency\": \"AED\",\n \"amountType\": \"exact\",\n \"codeLifetime\": 600,\n \"holdFundsIndicator\": true,\n \"redemptionAccountIdentifiers\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"redemptionChannels\": [\n {\n \"channelType\": \"string\"\n }\n ],\n \"redemptionTransactionTypes\": [\n {\n \"transactionType\": \"billpay\",\n \"transactionSubtype\": \"string\"\n }\n ],\n \"requestingOrganisation\": {\n \"requestingOrganisationIdentifierType\": \"lei\",\n \"requestingOrganisationIdentifier\": \"string\"\n },\n \"requestDate\": \"2022-09-29T07:23:27.990Z\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ]\n}" }, "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/authorisationcodes", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "authorisationcodes" ] }, "description": "this endpoint allows allows a mobile money payer or payee to generate a code which when presented to the other party, can be redeemed for an amount set by the payer or payee, depending upon the use case" }, "response": [ { "name": "Represents an Asynchronous response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes" ], "variable": [ { "key": "accountId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes" ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Authorisation Code response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes" ], "variable": [ { "key": "accountId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"authorisationCode\": \"\",\n \"codeState\": \"\",\n \"codeLifetime\": \"\",\n \"requestDate\": \"\",\n \"amount\": \"15.21\",\n \"currency\": \"\",\n \"amountType\": \"\",\n \"holdFundsIndicator\": \"\",\n \"redemptionChannels\": [\n {\n \"channelType\": \"\"\n },\n {\n \"channelType\": \"\"\n }\n ],\n \"redemptionTransactionTypes\": [\n {\n \"transactionType\": \"\",\n \"transactionSubtype\": \"\"\n },\n {\n \"transactionType\": \"\",\n \"transactionSubtype\": \"\"\n }\n ],\n \"redemptionAccountIdentifiers\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/authorisationcodes", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "authorisationcodes" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "View Account Status", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/status", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "status" ] }, "description": "This endpoint returns the current status of an account. This API accepts multiple identifiers" }, "response": [ { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/status", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "status" ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/status", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "status" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/status", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "status" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Account Status response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/status", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "status" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"accountStatus\": \"\",\n \"subStatus\": \"\",\n \"lei\": \"5493000IBP32UQZ0KL24\"\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/status", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "status" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/status", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "status" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View Account Name", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/accountname", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "accountname" ] }, "description": "This endpoint returns the status of a given account." }, "response": [ { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/accountname", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "accountname" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/accountname", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "accountname" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/accountname", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "accountname" ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/accountname", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "accountname" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Account Name response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/accountname", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "accountname" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"lei\": \"5493000IBP32UQZ0KL24\"\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/accountname", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "accountname" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View Account Balance", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/balance", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "balance" ] }, "description": "This endpoint returns the balance of an account" }, "response": [ { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balance" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balance" ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Account Balance response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balance" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"currentBalance\": \"15.21\",\n \"availableBalance\": \"15.21\",\n \"reservedBalance\": \"15.21\",\n \"unclearedBalance\": \"15.21\",\n \"currency\": \"\",\n \"accountStatus\": \"\"\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balance" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balance" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "balance" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View Account Specific Transaction", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/transactions", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "transactions" ], "query": [ { "key": "limit", "value": "", "description": "Supports pagination. If this is not supplied, then the server will apply a limit of 50 records returned for each request.", "disabled": true }, { "key": "offset", "value": "", "description": "Supports pagination. This value will indicate the cursor position from where to retrieve the set of records. For example, a limit of 50 and offset of 10 will return records 11 to 60.", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "Indicates the minimum date for which records should be returned.", "disabled": true }, { "key": "toDateTime", "value": "", "description": "Indicates the maximum date for which records should be returned.", "disabled": true }, { "key": "transactionStatus", "value": "", "description": "Query variable to uniquely identify the transaction status.", "disabled": true }, { "key": "transactionType", "value": "", "description": "Identifies the type of transaction.", "disabled": true } ] }, "description": "This endpoint returns transactions linked to a specific account" }, "response": [ { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/transactions?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&transactionType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "transactions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "transactionType", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/transactions?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&transactionType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "transactions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "transactionType", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represent a list of Transactions", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/transactions?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&transactionType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "transactions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "transactionType", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "X-Records-Available-Count", "value": "", "description": "Integer containing number of records that are available to be returned." }, { "key": "X-Records-Returned-Count", "value": "", "description": "Integer containing number of records that are returned." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"amount\": \"15.21\",\n \"currency\": \"\",\n \"type\": \"\",\n \"transactionReference\": \"\",\n \"transactionStatus\": \"\",\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"subType\": \"\",\n \"descriptionText\": \"\",\n \"requestDate\": \"\",\n \"requestingOrganisationTransactionReference\": \"\",\n \"oneTimeCode\": \"\",\n \"geoCode\": \"37.423825,-122.082900\",\n \"senderKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"recipientKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"originalTransactionReference\": \"\",\n \"servicingIdentity\": \"\",\n \"fees\": [\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n },\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n }\n ],\n \"requestingLei\": \"54930084UKLVMY22DS16\",\n \"receivingLei\": \"5493000IBP32UQZ0KL24\",\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\",\n \"transactionReceipt\": \"\",\n \"internationalTransferInformation\": {\n \"originCountry\": \"\",\n \"quotationReference\": \"\",\n \"quoteId\": \"\",\n \"receivingCountry\": \"\",\n \"remittancePurpose\": \"\",\n \"relationshipSender\": \"\",\n \"deliveryMethod\": \"\",\n \"senderBlockingReason\": \"\",\n \"recipientBlockingReason\": \"\"\n }\n },\n {\n \"amount\": \"15.21\",\n \"currency\": \"\",\n \"type\": \"\",\n \"transactionReference\": \"\",\n \"transactionStatus\": \"\",\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"subType\": \"\",\n \"descriptionText\": \"\",\n \"requestDate\": \"\",\n \"requestingOrganisationTransactionReference\": \"\",\n \"oneTimeCode\": \"\",\n \"geoCode\": \"37.423825,-122.082900\",\n \"senderKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"recipientKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"originalTransactionReference\": \"\",\n \"servicingIdentity\": \"\",\n \"fees\": [\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n },\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n }\n ],\n \"requestingLei\": \"54930084UKLVMY22DS16\",\n \"receivingLei\": \"5493000IBP32UQZ0KL24\",\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\",\n \"transactionReceipt\": \"\",\n \"internationalTransferInformation\": {\n \"originCountry\": \"\",\n \"quotationReference\": \"\",\n \"quoteId\": \"\",\n \"receivingCountry\": \"\",\n \"remittancePurpose\": \"\",\n \"relationshipSender\": \"\",\n \"deliveryMethod\": \"\",\n \"senderBlockingReason\": \"\",\n \"recipientBlockingReason\": \"\"\n }\n }\n]" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/transactions?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&transactionType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "transactions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "transactionType", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/transactions?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&transactionType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "transactions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "transactionType", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/transactions?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&transactionType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "transactions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "transactionType", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View Account Statements", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/statemententries", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "statemententries" ], "query": [ { "key": "limit", "value": "", "description": "Supports pagination. If this is not supplied, then the server will apply a limit of 50 records returned for each request.", "disabled": true }, { "key": "offset", "value": "", "description": "Supports pagination. This value will indicate the cursor position from where to retrieve the set of records. For example, a limit of 50 and offset of 10 will return records 11 to 60.", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "Indicates the minimum date for which records should be returned.", "disabled": true }, { "key": "toDateTime", "value": "", "description": "Indicates the maximum date for which records should be returned.", "disabled": true }, { "key": "transactionStatus", "value": "", "description": "Query variable to uniquely identify the transaction status.", "disabled": true }, { "key": "displayType", "value": "", "description": "Query parameter to to identify the display type of the statement entries to be returned.", "disabled": true } ] }, "description": "The Statement Entries API enables generic representations of transactions to be returned. Typically, the returned representations are used for the purposes of presenting a statement to the account holder. In order to return a statement, an account must be specified." }, "response": [ { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/statemententries?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&displayType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "statemententries" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "displayType", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/statemententries?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&displayType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "statemententries" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "displayType", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/statemententries?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&displayType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "statemententries" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "displayType", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/statemententries?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&displayType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "statemententries" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "displayType", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represent a list of Statement Entries", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/statemententries?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&displayType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "statemententries" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "displayType", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "X-Records-Available-Count", "value": "", "description": "Integer containing number of records that are available to be returned." }, { "key": "X-Records-Returned-Count", "value": "", "description": "Integer containing number of records that are returned." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"amount\": \"15.21\",\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"currency\": \"\",\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"transactionReference\": \"\",\n \"transactionStatus\": \"\",\n \"displayType\": \"\",\n \"descriptionText\": \"\",\n \"requestDate\": \"\",\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\",\n \"transactionReceipt\": \"\"\n },\n {\n \"amount\": \"15.21\",\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"currency\": \"\",\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"transactionReference\": \"\",\n \"transactionStatus\": \"\",\n \"displayType\": \"\",\n \"descriptionText\": \"\",\n \"requestDate\": \"\",\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\",\n \"transactionReceipt\": \"\"\n }\n]" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/statemententries?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&displayType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "statemententries" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "displayType", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View Bill Companies", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{accountId}}/billcompanies", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{accountId}}", "billcompanies" ], "query": [ { "key": "limit", "value": "", "description": "Supports pagination. If this is not supplied, then the server will apply a limit of 50 records returned for each request.", "disabled": true }, { "key": "offset", "value": "", "description": "Supports pagination. This value will indicate the cursor position from where to retrieve the set of records. For example, a limit of 50 and offset of 10 will return records 11 to 60.", "disabled": true } ] }, "description": "This Bill Companies API is used to return a list of Service Providers that accept Bill Payments for a given account." }, "response": [ { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represent a list of Bill Companies", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"companyName\": \"\",\n \"serviceProvider\": \"\",\n \"serviceProviderType\": \"\",\n \"serviceProviderSubType\": \"\",\n \"supplementaryServiceProviderDetails\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"companyName\": \"\",\n \"serviceProvider\": \"\",\n \"serviceProviderType\": \"\",\n \"serviceProviderSubType\": \"\",\n \"supplementaryServiceProviderDetails\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n]" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/accounts/:accountId/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":accountId", "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "{identifier Type}/{identifier}", "item": [ { "name": "bills", "item": [ { "name": "View Account Bills", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/bills", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "bills" ] }, "description": "This endpoint returns bills linked to an account." }, "response": [ { "name": "Represent a list of Bills", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/bills", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "bills" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"currency\": \"\",\n \"amountDue\": \"15.21\",\n \"dueDate\": \"2018-11-20\",\n \"billReference\": \"\",\n \"minimumAmountDue\": \"15.21\",\n \"billdescription\": \"\",\n \"billStatus\": \"\",\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"currency\": \"\",\n \"amountDue\": \"15.21\",\n \"dueDate\": \"2018-11-20\",\n \"billReference\": \"\",\n \"minimumAmountDue\": \"15.21\",\n \"billdescription\": \"\",\n \"billStatus\": \"\",\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n]" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/bills", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "bills" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/bills", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "bills" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/bills", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "bills" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/bills", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "bills" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/bills", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "bills" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "Create A Bill Payment", "request": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Callback-URL", "value": "", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceProviderPaymentReference\": \"string\",\n \"requestingOrganisationTransactionReference\": \"string\",\n \"paymentType\": \"partialpayment\",\n \"amountPaid\": \"15.21\",\n \"currency\": \"AED\",\n \"customerReference\": \"string\",\n \"requestingOrganisation\": \"string\",\n \"supplementaryBillReferenceDetails\": [\n {\n \"paymentReferenceType\": \"string\",\n \"paymentReferenceValue\": \"string\"\n }\n ],\n \"requestDate\": \"2022-09-29T00:07:24.740Z\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"paidAmount\": \"15.21\"\n}" }, "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/bills/{{billReference}}/payments", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "bills", "{{billReference}}", "payments" ] }, "description": "Provided with a valid object representation, this endpoint allows for a new bill payment to be created for a specific account." }, "response": [ { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "bills", ":billReference", "payments" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "billReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Bill Payment response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "bills", ":billReference", "payments" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "billReference" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"currency\": \"\",\n \"amountPaid\": \"15.21\",\n \"billPaymentStatus\": \"\",\n \"paidAmount\": \"15.21\",\n \"serviceProviderPaymentReference\": \"\",\n \"requestingOrganisation\": \"\",\n \"requestingOrganisationTransactionReference\": \"\",\n \"customerReference\": \"\",\n \"paymentType\": \"\",\n \"serviceProviderComment\": \"\",\n \"serviceProviderNotification\": \"\",\n \"supplementaryBillReferenceDetails\": [\n {\n \"paymentReferenceType\": \"\",\n \"paymentReferenceValue\": \"\"\n },\n {\n \"paymentReferenceType\": \"\",\n \"paymentReferenceValue\": \"\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "bills", ":billReference", "payments" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "billReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "bills", ":billReference", "payments" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "billReference" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "bills", ":billReference", "payments" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "billReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "bills", ":billReference", "payments" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "billReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "bills", ":billReference", "payments" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "billReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "debitmandates", "item": [ { "name": "{debit Mandate Reference}", "item": [ { "name": "View A Debit Mandate", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/debitmandates/{{debitMandateReference}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "debitmandates", "{{debitMandateReference}}" ] }, "description": "This endpoint returns a specific debit mandate linked to an account." }, "response": [ { "name": "Represents a Debit Mandate response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "debitMandateReference" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"mandateReference\": \"\",\n \"currency\": \"\",\n \"amountLimit\": \"15.21\",\n \"startDate\": \"2018-11-20\",\n \"endDate\": \"2018-11-20\",\n \"numberOfPayments\": \"\",\n \"frequencyType\": \"\",\n \"mandateStatus\": \"\",\n \"requestDate\": \"\",\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\"\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "debitMandateReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "debitMandateReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "debitMandateReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "debitMandateReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "debitMandateReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "Update A Debit Mandate", "request": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"string\",\n \"value\": \"string\"\n }\n]" }, "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/debitmandates/{{debitMandateReference}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "debitmandates", "{{debitMandateReference}}" ] }, "description": "This endpoint updates a specific debit mandate linked to an account." }, "response": [ { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "debitMandateReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "debitMandateReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "debitMandateReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "debitMandateReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "debitMandateReference" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "debitMandateReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "An empty response is returned for a synchronous successful patch.", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates/:debitMandateReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates", ":debitMandateReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "debitMandateReference" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Create A Debit Mandate", "request": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Callback-URL", "value": "", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"payee\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"mandateStatus\": \"active\",\n \"amountLimit\": \"string\",\n \"currency\": \"AED\",\n \"startDate\": \"2018-11-20\",\n \"endDate\": \"2018-11-20\",\n \"frequencyType\": \"weekly\",\n \"numberOfPayments\": 0,\n \"requestingOrganisation\": {\n \"requestingOrganisationIdentifierType\": \"lei\",\n \"requestingOrganisationIdentifier\": \"string\"\n },\n \"requestDate\": \"2022-09-29T00:09:32.272Z\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ]\n}" }, "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/debitmandates", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "debitmandates" ] }, "description": "Provided with a valid object representation, this endpoint allows for a new debit mandate to be created for a specific account." }, "response": [ { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Debit Mandate response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"mandateReference\": \"\",\n \"currency\": \"\",\n \"amountLimit\": \"15.21\",\n \"startDate\": \"2018-11-20\",\n \"endDate\": \"2018-11-20\",\n \"numberOfPayments\": \"\",\n \"frequencyType\": \"\",\n \"mandateStatus\": \"\",\n \"requestDate\": \"\",\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\"\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/debitmandates", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "debitmandates" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" } ] } ] }, { "name": "links", "item": [ { "name": "{link Reference}", "item": [ { "name": "View A Link", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/links/{{linkReference}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "links", "{{linkReference}}" ] }, "description": "This endpoint returns a specific link for a given account." }, "response": [ { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links", ":linkReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "linkReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links", ":linkReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "linkReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Link response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links", ":linkReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "linkReference" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"linkReference\": \"\",\n \"sourceAccountIdentifiers\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"status\": \"\",\n \"mode\": \"\"\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links", ":linkReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "linkReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links", ":linkReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "linkReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links", ":linkReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "linkReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "Update A Link", "request": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID.", "disabled": true }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"string\",\n \"value\": \"string\"\n }\n]" }, "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/links/{{linkReference}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "links", "{{linkReference}}" ] }, "description": "This endpoint updates a specific link.\"" }, "response": [ { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links", ":linkReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "linkReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links", ":linkReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "linkReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links", ":linkReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "linkReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "An empty response is returned for a synchronous successful patch.", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links", ":linkReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "linkReference" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links", ":linkReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "linkReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links", ":linkReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "linkReference" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links/:linkReference", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links", ":linkReference" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "linkReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "Create A Link", "request": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Callback-URL", "value": "", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"sourceAccountIdentifiers\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"mode\": \"push\",\n \"status\": \"active\",\n \"requestingOrganisation\": {\n \"requestingOrganisationIdentifierType\": \"lei\",\n \"requestingOrganisationIdentifier\": \"string\"\n },\n \"requestDate\": \"2022-09-29T00:15:03.101Z\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ]\n}" }, "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/links", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "links" ] }, "description": "Provided with a valid object representation, this endpoint allows a new link to be created for a specific account." }, "response": [ { "name": "Represents an Asynchronous response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Link response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"linkReference\": \"\",\n \"sourceAccountIdentifiers\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"status\": \"\",\n \"mode\": \"\"\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/links", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "links" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "authorisationcodes", "item": [ { "name": "{authorisation Code}", "item": [ { "name": "View an Authorisation Code", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/authorisationcodes/{{authorisationCode}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "authorisationcodes", "{{authorisationCode}}" ] }, "description": "This endpoint returns a specific Authorisation Code linked to an account." }, "response": [ { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "authorisationCode" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "authorisationCode" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "authorisationCode" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "authorisationCode" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Authorisation Code response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "authorisationCode" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"authorisationCode\": \"\",\n \"codeState\": \"\",\n \"codeLifetime\": \"\",\n \"requestDate\": \"\",\n \"amount\": \"15.21\",\n \"currency\": \"\",\n \"amountType\": \"\",\n \"holdFundsIndicator\": \"\",\n \"redemptionChannels\": [\n {\n \"channelType\": \"\"\n },\n {\n \"channelType\": \"\"\n }\n ],\n \"redemptionTransactionTypes\": [\n {\n \"transactionType\": \"\",\n \"transactionSubtype\": \"\"\n },\n {\n \"transactionType\": \"\",\n \"transactionSubtype\": \"\"\n }\n ],\n \"redemptionAccountIdentifiers\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "authorisationCode" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "Cancel an Authorisation Code", "request": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID.", "disabled": true }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"string\",\n \"value\": \"string\"\n }\n]" }, "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/authorisationcodes/{{authorisationCode}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "authorisationcodes", "{{authorisationCode}}" ] }, "description": "This endpoint cancels a specific authorisation code linked to an account." }, "response": [ { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "authorisationCode" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "authorisationCode" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "authorisationCode" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "authorisationCode" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "authorisationCode" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "authorisationCode" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "An empty response is returned for a synchronous successful patch.", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes/:authorisationCode", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes", ":authorisationCode" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" }, { "key": "authorisationCode" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Create an Authorisation Code via an account identifier.", "request": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Callback-URL", "value": "", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"authorisationCode\": \"string\",\n \"codeState\": \"active\",\n \"amount\": \"15.21\",\n \"currency\": \"AED\",\n \"amountType\": \"exact\",\n \"codeLifetime\": 600,\n \"holdFundsIndicator\": true,\n \"redemptionAccountIdentifiers\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"redemptionChannels\": [\n {\n \"channelType\": \"string\"\n }\n ],\n \"redemptionTransactionTypes\": [\n {\n \"transactionType\": \"billpay\",\n \"transactionSubtype\": \"string\"\n }\n ],\n \"requestingOrganisation\": {\n \"requestingOrganisationIdentifierType\": \"lei\",\n \"requestingOrganisationIdentifier\": \"string\"\n },\n \"creationDate\": \"2022-09-29T00:20:36.540Z\",\n \"modificationDate\": \"2022-09-29T00:20:36.540Z\",\n \"requestDate\": \"2022-09-29T00:20:36.540Z\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ]\n}" }, "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/authorisationcodes", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "authorisationcodes" ] }, "description": "This endpoint allows allows a mobile money payer or payee to generate a code which when presented to the other party, can be redeemed for an amount set by the payer or payee, depending upon the use case." }, "response": [ { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Authorisation Code response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"authorisationCode\": \"\",\n \"codeState\": \"\",\n \"codeLifetime\": \"\",\n \"requestDate\": \"\",\n \"amount\": \"15.21\",\n \"currency\": \"\",\n \"amountType\": \"\",\n \"holdFundsIndicator\": \"\",\n \"redemptionChannels\": [\n {\n \"channelType\": \"\"\n },\n {\n \"channelType\": \"\"\n }\n ],\n \"redemptionTransactionTypes\": [\n {\n \"transactionType\": \"\",\n \"transactionSubtype\": \"\"\n },\n {\n \"transactionType\": \"\",\n \"transactionSubtype\": \"\"\n }\n ],\n \"redemptionAccountIdentifiers\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/authorisationcodes", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "authorisationcodes" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "View Account Status", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/status", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "status" ] }, "description": "This endpoint returns the current status of an account." }, "response": [ { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/status", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "status" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/status", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "status" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Account Status response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/status", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "status" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"accountStatus\": \"\",\n \"subStatus\": \"\",\n \"lei\": \"5493000IBP32UQZ0KL24\"\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/status", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "status" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/status", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "status" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/status", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "status" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View Account Name", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/accountname", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "accountname" ] }, "description": "This endpoint returns the name of an account holder." }, "response": [ { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/accountname", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "accountname" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/accountname", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "accountname" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/accountname", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "accountname" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/accountname", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "accountname" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/accountname", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "accountname" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Account Name response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/accountname", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "accountname" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"lei\": \"5493000IBP32UQZ0KL24\"\n}" } ] }, { "name": "View Account Balance", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/balance", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "balance" ] }, "description": "This endpoint returns the balance of an account." }, "response": [ { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "balance" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "balance" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Account Balance response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "balance" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"currentBalance\": \"15.21\",\n \"availableBalance\": \"15.21\",\n \"reservedBalance\": \"15.21\",\n \"unclearedBalance\": \"15.21\",\n \"currency\": \"\",\n \"accountStatus\": \"\"\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "balance" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "balance" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "balance" ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View Account Specific Transaction", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/transactions", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "transactions" ], "query": [ { "key": "limit", "value": "", "description": "Supports pagination. If this is not supplied, then the server will apply a limit of 50 records returned for each request.", "disabled": true }, { "key": "offset", "value": "", "description": "Supports pagination. This value will indicate the cursor position from where to retrieve the set of records. For example, a limit of 50 and offset of 10 will return records 11 to 60.", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "Indicates the minimum date for which records should be returned.", "disabled": true }, { "key": "toDateTime", "value": "", "description": "Indicates the maximum date for which records should be returned.", "disabled": true }, { "key": "transactionStatus", "value": "", "description": "Query variable to uniquely identify the transaction status.", "disabled": true }, { "key": "transactionType", "value": "", "description": "Identifies the type of transaction.", "disabled": true } ] }, "description": "This endpoint returns transactions linked to a specific account." }, "response": [ { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/transactions?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&transactionType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "transactions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "transactionType", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represent a list of Transactions", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/transactions?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&transactionType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "transactions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "transactionType", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "X-Records-Available-Count", "value": "", "description": "Integer containing number of records that are available to be returned." }, { "key": "X-Records-Returned-Count", "value": "", "description": "Integer containing number of records that are returned." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"amount\": \"15.21\",\n \"currency\": \"\",\n \"type\": \"\",\n \"transactionReference\": \"\",\n \"transactionStatus\": \"\",\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"subType\": \"\",\n \"descriptionText\": \"\",\n \"requestDate\": \"\",\n \"requestingOrganisationTransactionReference\": \"\",\n \"oneTimeCode\": \"\",\n \"geoCode\": \"37.423825,-122.082900\",\n \"senderKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"recipientKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"originalTransactionReference\": \"\",\n \"servicingIdentity\": \"\",\n \"fees\": [\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n },\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n }\n ],\n \"requestingLei\": \"54930084UKLVMY22DS16\",\n \"receivingLei\": \"5493000IBP32UQZ0KL24\",\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\",\n \"transactionReceipt\": \"\",\n \"internationalTransferInformation\": {\n \"originCountry\": \"\",\n \"quotationReference\": \"\",\n \"quoteId\": \"\",\n \"receivingCountry\": \"\",\n \"remittancePurpose\": \"\",\n \"relationshipSender\": \"\",\n \"deliveryMethod\": \"\",\n \"senderBlockingReason\": \"\",\n \"recipientBlockingReason\": \"\"\n }\n },\n {\n \"amount\": \"15.21\",\n \"currency\": \"\",\n \"type\": \"\",\n \"transactionReference\": \"\",\n \"transactionStatus\": \"\",\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"subType\": \"\",\n \"descriptionText\": \"\",\n \"requestDate\": \"\",\n \"requestingOrganisationTransactionReference\": \"\",\n \"oneTimeCode\": \"\",\n \"geoCode\": \"37.423825,-122.082900\",\n \"senderKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"recipientKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"originalTransactionReference\": \"\",\n \"servicingIdentity\": \"\",\n \"fees\": [\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n },\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n }\n ],\n \"requestingLei\": \"54930084UKLVMY22DS16\",\n \"receivingLei\": \"5493000IBP32UQZ0KL24\",\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\",\n \"transactionReceipt\": \"\",\n \"internationalTransferInformation\": {\n \"originCountry\": \"\",\n \"quotationReference\": \"\",\n \"quoteId\": \"\",\n \"receivingCountry\": \"\",\n \"remittancePurpose\": \"\",\n \"relationshipSender\": \"\",\n \"deliveryMethod\": \"\",\n \"senderBlockingReason\": \"\",\n \"recipientBlockingReason\": \"\"\n }\n }\n]" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/transactions?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&transactionType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "transactions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "transactionType", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/transactions?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&transactionType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "transactions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "transactionType", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/transactions?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&transactionType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "transactions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "transactionType", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/transactions?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&transactionType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "transactions" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "transactionType", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View Account Statements", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/statemententries", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "statemententries" ], "query": [ { "key": "limit", "value": "", "description": "Supports pagination. If this is not supplied, then the server will apply a limit of 50 records returned for each request.", "disabled": true }, { "key": "offset", "value": "", "description": "Supports pagination. This value will indicate the cursor position from where to retrieve the set of records. For example, a limit of 50 and offset of 10 will return records 11 to 60.", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "Indicates the minimum date for which records should be returned.", "disabled": true }, { "key": "toDateTime", "value": "", "description": "Indicates the maximum date for which records should be returned.", "disabled": true }, { "key": "transactionStatus", "value": "", "description": "Query variable to uniquely identify the transaction status.", "disabled": true }, { "key": "displayType", "value": "", "description": "Query parameter to to identify the display type of the statement entries to be returned.", "disabled": true } ] }, "description": "The Statement Entries API enables generic representations of transactions to be returned. Typically, the returned representations are used for the purposes of presenting a statement to the account holder. In order to return a statement, an account must be specified." }, "response": [ { "name": "Represent a list of Statement Entries", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/statemententries?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&displayType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "statemententries" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "displayType", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "X-Records-Available-Count", "value": "", "description": "Integer containing number of records that are available to be returned." }, { "key": "X-Records-Returned-Count", "value": "", "description": "Integer containing number of records that are returned." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"amount\": \"15.21\",\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"currency\": \"\",\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"transactionReference\": \"\",\n \"transactionStatus\": \"\",\n \"displayType\": \"\",\n \"descriptionText\": \"\",\n \"requestDate\": \"\",\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\",\n \"transactionReceipt\": \"\"\n },\n {\n \"amount\": \"15.21\",\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"currency\": \"\",\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"transactionReference\": \"\",\n \"transactionStatus\": \"\",\n \"displayType\": \"\",\n \"descriptionText\": \"\",\n \"requestDate\": \"\",\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\",\n \"transactionReceipt\": \"\"\n }\n]" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/statemententries?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&displayType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "statemententries" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "displayType", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/statemententries?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&displayType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "statemententries" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "displayType", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/statemententries?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&displayType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "statemententries" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "displayType", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/statemententries?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&displayType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "statemententries" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "displayType", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/statemententries?limit=&offset=&fromDateTime=&toDateTime=&transactionStatus=&displayType=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "statemententries" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "fromDateTime", "value": "" }, { "key": "toDateTime", "value": "" }, { "key": "transactionStatus", "value": "" }, { "key": "displayType", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View Bill Companies", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/{{identifierType}}/{{identifier}}/billcompanies", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "{{identifierType}}", "{{identifier}}", "billcompanies" ], "query": [ { "key": "limit", "value": "", "description": "Supports pagination. If this is not supplied, then the server will apply a limit of 50 records returned for each request.", "disabled": true }, { "key": "offset", "value": "", "description": "Supports pagination. This value will indicate the cursor position from where to retrieve the set of records. For example, a limit of 50 and offset of 10 will return records 11 to 60.", "disabled": true } ] }, "description": "This Bill Companies API is used to return a list of Service Providers that accept Bill Payments for a given account." }, "response": [ { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represent a list of Bill Companies", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/:identifierType/:identifier/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":identifierType", ":identifier", "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "identifierType" }, { "key": "identifier" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"companyName\": \"\",\n \"serviceProvider\": \"\",\n \"serviceProviderType\": \"\",\n \"serviceProviderSubType\": \"\",\n \"supplementaryServiceProviderDetails\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"companyName\": \"\",\n \"serviceProvider\": \"\",\n \"serviceProviderType\": \"\",\n \"serviceProviderSubType\": \"\",\n \"supplementaryServiceProviderDetails\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n]" } ] } ] }, { "name": "View Account Balance", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/accounts/balance", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "accounts", "balance" ] }, "description": "This endpoint returns the balance of an account. As the account is not passed as a parameter, the account is assumed to be that of the calling client.\"" }, "response": [ { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "balance" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Account Balance response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "balance" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"currentBalance\": \"15.21\",\n \"availableBalance\": \"15.21\",\n \"reservedBalance\": \"15.21\",\n \"unclearedBalance\": \"15.21\",\n \"currency\": \"\",\n \"accountStatus\": \"\"\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "balance" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "balance" ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "balance" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/accounts/balance", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "balance" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "billcompanies", "item": [ { "name": "View Bill Companies", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/billcompanies", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "billcompanies" ], "query": [ { "key": "limit", "value": "", "description": "Supports pagination. If this is not supplied, then the server will apply a limit of 50 records returned for each request.", "disabled": true }, { "key": "offset", "value": "", "description": "Supports pagination. This value will indicate the cursor position from where to retrieve the set of records. For example, a limit of 50 and offset of 10 will return records 11 to 60.", "disabled": true } ] }, "description": "The Bill Companies API is used to return a list of Service Providers that accept Bill Payments." }, "response": [ { "name": "Represent a list of Bill Companies", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"companyName\": \"\",\n \"serviceProvider\": \"\",\n \"serviceProviderType\": \"\",\n \"serviceProviderSubType\": \"\",\n \"supplementaryServiceProviderDetails\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"companyName\": \"\",\n \"serviceProvider\": \"\",\n \"serviceProviderType\": \"\",\n \"serviceProviderSubType\": \"\",\n \"supplementaryServiceProviderDetails\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n]" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/billcompanies?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "billcompanies" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View a Specific Bill Company", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/billcompanies/{{serviceProvider}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "billcompanies", "{{serviceProvider}}" ] }, "description": "This Bill Companies API is used to return a information for a specific Service Providers that accepts Bill Payments." }, "response": [ { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/billcompanies/:serviceProvider", "host": [ "{{baseUrl}}" ], "path": [ "billcompanies", ":serviceProvider" ], "variable": [ { "key": "serviceProvider" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/billcompanies/:serviceProvider", "host": [ "{{baseUrl}}" ], "path": [ "billcompanies", ":serviceProvider" ], "variable": [ { "key": "serviceProvider" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/billcompanies/:serviceProvider", "host": [ "{{baseUrl}}" ], "path": [ "billcompanies", ":serviceProvider" ], "variable": [ { "key": "serviceProvider" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Returns a specific Bill Payment Service Provider", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/billcompanies/:serviceProvider", "host": [ "{{baseUrl}}" ], "path": [ "billcompanies", ":serviceProvider" ], "variable": [ { "key": "serviceProvider" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"companyName\": \"\",\n \"serviceProvider\": \"\",\n \"serviceProviderType\": \"\",\n \"serviceProviderSubType\": \"\",\n \"supplementaryServiceProviderDetails\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/billcompanies/:serviceProvider", "host": [ "{{baseUrl}}" ], "path": [ "billcompanies", ":serviceProvider" ], "variable": [ { "key": "serviceProvider" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/billcompanies/:serviceProvider", "host": [ "{{baseUrl}}" ], "path": [ "billcompanies", ":serviceProvider" ], "variable": [ { "key": "serviceProvider" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "quotations", "item": [ { "name": "Create A New Quotation", "request": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Callback-URL", "value": "", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"type\": \"billpay\",\n \"subType\": \"string\",\n \"requestAmount\": \"15.21\",\n \"requestCurrency\": \"AED\",\n \"chosenDeliveryMethod\": \"directtoaccount\",\n \"originCountry\": \"AD\",\n \"receivingCountry\": \"AD\",\n \"recipientKyc\": {\n \"birthCountry\": \"AD\",\n \"contactPhone\": \"string\",\n \"dateOfBirth\": \"2000-11-20\",\n \"emailAddress\": \"string\",\n \"employerName\": \"string\",\n \"gender\": \"m\",\n \"idDocument\": [\n {\n \"idType\": \"passport\",\n \"idNumber\": \"string\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"string\",\n \"issuerPlace\": \"string\",\n \"issuerCountry\": \"AD\",\n \"otherIddescription\": \"string\"\n }\n ],\n \"nationality\": \"AD\",\n \"occupation\": \"string\",\n \"postalAddress\": {\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\",\n \"city\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"AD\"\n },\n \"subjectName\": {\n \"title\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"fullName\": \"string\",\n \"nativeName\": \"string\"\n }\n },\n \"senderKyc\": {\n \"birthCountry\": \"AD\",\n \"contactPhone\": \"string\",\n \"dateOfBirth\": \"2000-11-20\",\n \"emailAddress\": \"string\",\n \"employerName\": \"string\",\n \"gender\": \"m\",\n \"idDocument\": [\n {\n \"idType\": \"passport\",\n \"idNumber\": \"string\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"string\",\n \"issuerPlace\": \"string\",\n \"issuerCountry\": \"AD\",\n \"otherIddescription\": \"string\"\n }\n ],\n \"nationality\": \"AD\",\n \"occupation\": \"string\",\n \"postalAddress\": {\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\",\n \"city\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"AD\"\n },\n \"subjectName\": {\n \"title\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"fullName\": \"string\",\n \"nativeName\": \"string\"\n }\n },\n \"requestingOrganisation\": {\n \"requestingOrganisationIdentifierType\": \"lei\",\n \"requestingOrganisationIdentifier\": \"string\"\n },\n \"sendingServiceProviderCountry\": \"AD\",\n \"requestDate\": \"2022-09-29T00:51:46.693Z\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ]\n}" }, "url": { "raw": "{{ChannelGSMAHostName}}/quotations", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "quotations" ] }, "description": "Provided with a valid object representation, this endpoint allows for a new quotation to be created." }, "response": [ { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/quotations", "host": [ "{{baseUrl}}" ], "path": [ "quotations" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/quotations", "host": [ "{{baseUrl}}" ], "path": [ "quotations" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/quotations", "host": [ "{{baseUrl}}" ], "path": [ "quotations" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/quotations", "host": [ "{{baseUrl}}" ], "path": [ "quotations" ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Quotation response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/quotations", "host": [ "{{baseUrl}}" ], "path": [ "quotations" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"quotationReference\": \"\",\n \"requestDate\": \"\",\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"requestAmount\": \"15.21\",\n \"requestCurrency\": \"\",\n \"senderKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"recipientKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"type\": \"\",\n \"subType\": \"\",\n \"chosenDeliveryMethod\": \"\",\n \"quotes\": [\n {\n \"quoteId\": \"\",\n \"receivingAmount\": \"15.21\",\n \"receivingCurrency\": \"\",\n \"sendingAmount\": \"15.21\",\n \"sendingCurrency\": \"\",\n \"quoteExpiryTime\": \"\",\n \"receivingServiceProvider\": \"\",\n \"fxRate\": \"1.3436\",\n \"deliveryMethod\": \"\",\n \"fees\": [\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n },\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n }\n ]\n },\n {\n \"quoteId\": \"\",\n \"receivingAmount\": \"15.21\",\n \"receivingCurrency\": \"\",\n \"sendingAmount\": \"15.21\",\n \"sendingCurrency\": \"\",\n \"quoteExpiryTime\": \"\",\n \"receivingServiceProvider\": \"\",\n \"fxRate\": \"1.3436\",\n \"deliveryMethod\": \"\",\n \"fees\": [\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n },\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n }\n ]\n }\n ],\n \"senderBlockingReason\": \"\",\n \"recipientBlockingReason\": \"\",\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"quotationStatus\": \"\",\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\",\n \"availableDeliveryMethod\": \"\"\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/quotations", "host": [ "{{baseUrl}}" ], "path": [ "quotations" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/quotations", "host": [ "{{baseUrl}}" ], "path": [ "quotations" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View A Quotation", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header.", "disabled": true }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/quotations/{{quotationReference}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "quotations", "{{quotationReference}}" ] }, "description": "This endpoint returns a specific quotation" }, "response": [ { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/quotations/:quotationReference", "host": [ "{{baseUrl}}" ], "path": [ "quotations", ":quotationReference" ], "variable": [ { "key": "quotationReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/quotations/:quotationReference", "host": [ "{{baseUrl}}" ], "path": [ "quotations", ":quotationReference" ], "variable": [ { "key": "quotationReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/quotations/:quotationReference", "host": [ "{{baseUrl}}" ], "path": [ "quotations", ":quotationReference" ], "variable": [ { "key": "quotationReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/quotations/:quotationReference", "host": [ "{{baseUrl}}" ], "path": [ "quotations", ":quotationReference" ], "variable": [ { "key": "quotationReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/quotations/:quotationReference", "host": [ "{{baseUrl}}" ], "path": [ "quotations", ":quotationReference" ], "variable": [ { "key": "quotationReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Quotation response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/quotations/:quotationReference", "host": [ "{{baseUrl}}" ], "path": [ "quotations", ":quotationReference" ], "variable": [ { "key": "quotationReference" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"quotationReference\": \"\",\n \"requestDate\": \"\",\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"requestAmount\": \"15.21\",\n \"requestCurrency\": \"\",\n \"senderKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"recipientKyc\": {\n \"nationality\": \"\",\n \"dateOfBirth\": \"2000-11-20\",\n \"occupation\": \"\",\n \"employerName\": \"\",\n \"contactPhone\": \"\",\n \"gender\": \"\",\n \"idDocument\": [\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n },\n {\n \"idType\": \"\",\n \"idNumber\": \"\",\n \"issueDate\": \"2018-11-20\",\n \"expiryDate\": \"2018-11-20\",\n \"issuer\": \"\",\n \"issuerPlace\": \"\",\n \"issuerCountry\": \"\",\n \"otherIddescription\": \"\"\n }\n ],\n \"postalAddress\": {\n \"country\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"stateProvince\": \"\",\n \"postalCode\": \"\"\n },\n \"subjectName\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"middleName\": \"\",\n \"lastName\": \"\",\n \"fullName\": \"\",\n \"nativeName\": \"\"\n },\n \"emailAddress\": \"\",\n \"birthCountry\": \"\"\n },\n \"type\": \"\",\n \"subType\": \"\",\n \"chosenDeliveryMethod\": \"\",\n \"quotes\": [\n {\n \"quoteId\": \"\",\n \"receivingAmount\": \"15.21\",\n \"receivingCurrency\": \"\",\n \"sendingAmount\": \"15.21\",\n \"sendingCurrency\": \"\",\n \"quoteExpiryTime\": \"\",\n \"receivingServiceProvider\": \"\",\n \"fxRate\": \"1.3436\",\n \"deliveryMethod\": \"\",\n \"fees\": [\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n },\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n }\n ]\n },\n {\n \"quoteId\": \"\",\n \"receivingAmount\": \"15.21\",\n \"receivingCurrency\": \"\",\n \"sendingAmount\": \"15.21\",\n \"sendingCurrency\": \"\",\n \"quoteExpiryTime\": \"\",\n \"receivingServiceProvider\": \"\",\n \"fxRate\": \"1.3436\",\n \"deliveryMethod\": \"\",\n \"fees\": [\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n },\n {\n \"feeType\": \"\",\n \"feeCurrency\": \"\",\n \"feeAmount\": \"15.21\"\n }\n ]\n }\n ],\n \"senderBlockingReason\": \"\",\n \"recipientBlockingReason\": \"\",\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"quotationStatus\": \"\",\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\",\n \"availableDeliveryMethod\": \"\"\n}" } ] } ] }, { "name": "requeststates/{server Correlation Id} Copy", "item": [ { "name": "View A Request State", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/requeststates/{{serverCorrelationId}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "requeststates", "{{serverCorrelationId}}" ] }, "description": "This endpoint returns a specific request state" }, "response": [ { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/requeststates/:serverCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "requeststates", ":serverCorrelationId" ], "variable": [ { "key": "serverCorrelationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/requeststates/:serverCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "requeststates", ":serverCorrelationId" ], "variable": [ { "key": "serverCorrelationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/requeststates/:serverCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "requeststates", ":serverCorrelationId" ], "variable": [ { "key": "serverCorrelationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/requeststates/:serverCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "requeststates", ":serverCorrelationId" ], "variable": [ { "key": "serverCorrelationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/requeststates/:serverCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "requeststates", ":serverCorrelationId" ], "variable": [ { "key": "serverCorrelationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/requeststates/:serverCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "requeststates", ":serverCorrelationId" ], "variable": [ { "key": "serverCorrelationId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "Update A Request State", "request": { "method": "PATCH", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"string\",\n \"value\": \"string\"\n }\n]" }, "url": { "raw": "{{ChannelGSMAHostName}}/requeststates/{{serverCorrelationId}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "requeststates", "{{serverCorrelationId}}" ] }, "description": "This endpoint updates a specific request state. This operation is to be deprecated. Please refer to Callback definitions for the revised approach to implementing asynchronous callbacks." }, "response": [ { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/requeststates/:serverCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "requeststates", ":serverCorrelationId" ], "variable": [ { "key": "serverCorrelationId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/requeststates/:serverCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "requeststates", ":serverCorrelationId" ], "variable": [ { "key": "serverCorrelationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/requeststates/:serverCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "requeststates", ":serverCorrelationId" ], "variable": [ { "key": "serverCorrelationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "An empty response is returned for a synchronous successful patch.", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/requeststates/:serverCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "requeststates", ":serverCorrelationId" ], "variable": [ { "key": "serverCorrelationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/requeststates/:serverCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "requeststates", ":serverCorrelationId" ], "variable": [ { "key": "serverCorrelationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "PATCH", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/requeststates/:serverCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "requeststates", ":serverCorrelationId" ], "variable": [ { "key": "serverCorrelationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "Check API availability", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/heartbeat/", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "heartbeat", "" ] }, "description": "This endpoint returns the current status of the API" }, "response": [ { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." } ], "url": { "raw": "{{baseUrl}}/heartbeat", "host": [ "{{baseUrl}}" ], "path": [ "heartbeat" ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." } ], "url": { "raw": "{{baseUrl}}/heartbeat", "host": [ "{{baseUrl}}" ], "path": [ "heartbeat" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." } ], "url": { "raw": "{{baseUrl}}/heartbeat", "host": [ "{{baseUrl}}" ], "path": [ "heartbeat" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." } ], "url": { "raw": "{{baseUrl}}/heartbeat", "host": [ "{{baseUrl}}" ], "path": [ "heartbeat" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Heartbeat response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." } ], "url": { "raw": "{{baseUrl}}/heartbeat", "host": [ "{{baseUrl}}" ], "path": [ "heartbeat" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"serviceStatus\": \"\",\n \"delay\": \"\",\n \"plannedRestorationTime\": \"\"\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." } ], "url": { "raw": "{{baseUrl}}/heartbeat", "host": [ "{{baseUrl}}" ], "path": [ "heartbeat" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View Specific Statement", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/statemententries/{{transactionReference}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "statemententries", "{{transactionReference}}" ] }, "description": "The Statement Entries API enables generic representations of transactions to be returned. Typically, the returned representations are used for the purposes of presenting a statement to the account holder. In order to return a statement, a transaction reference must be specified." }, "response": [ { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/statemententries/:transactionReference", "host": [ "{{baseUrl}}" ], "path": [ "statemententries", ":transactionReference" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/statemententries/:transactionReference", "host": [ "{{baseUrl}}" ], "path": [ "statemententries", ":transactionReference" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/statemententries/:transactionReference", "host": [ "{{baseUrl}}" ], "path": [ "statemententries", ":transactionReference" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/statemententries/:transactionReference", "host": [ "{{baseUrl}}" ], "path": [ "statemententries", ":transactionReference" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/statemententries/:transactionReference", "host": [ "{{baseUrl}}" ], "path": [ "statemententries", ":transactionReference" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represent a list of Statement Entries", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/statemententries/:transactionReference", "host": [ "{{baseUrl}}" ], "path": [ "statemententries", ":transactionReference" ], "variable": [ { "key": "transactionReference" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"amount\": \"15.21\",\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"currency\": \"\",\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n },\n {\n \"key\": \"msisdn\",\n \"value\": \"+33555123456\"\n }\n ],\n \"transactionReference\": \"\",\n \"transactionStatus\": \"\",\n \"displayType\": \"\",\n \"descriptionText\": \"\",\n \"requestDate\": \"\",\n \"creationDate\": \"\",\n \"modificationDate\": \"\",\n \"dateCreated\": \"\",\n \"dateModified\": \"\",\n \"transactionReceipt\": \"\"\n}" } ] }, { "name": "Create A Bill Payment", "request": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"serviceProviderPaymentReference\": \"string\",\n \"requestingOrganisationTransactionReference\": \"string\",\n \"paymentType\": \"partialpayment\",\n \"amountPaid\": \"15.21\",\n \"currency\": \"AED\",\n \"customerReference\": \"string\",\n \"requestingOrganisation\": \"string\",\n \"supplementaryBillReferenceDetails\": [\n {\n \"paymentReferenceType\": \"string\",\n \"paymentReferenceValue\": \"string\"\n }\n ],\n \"requestDate\": \"2022-09-29T07:45:19.744Z\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"paidAmount\": \"15.21\"\n}" }, "url": { "raw": "{{ChannelGSMAHostName}}/bills/{{billReference}}/payments", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "bills", "{{billReference}}", "payments" ] }, "description": "Provided with a valid object representation, this endpoint allows for a new bill payment to be created." }, "response": [ { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":billReference", "payments" ], "variable": [ { "key": "billReference" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents a Bill Payment response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":billReference", "payments" ], "variable": [ { "key": "billReference" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"currency\": \"\",\n \"amountPaid\": \"15.21\",\n \"billPaymentStatus\": \"\",\n \"paidAmount\": \"15.21\",\n \"serviceProviderPaymentReference\": \"\",\n \"requestingOrganisation\": \"\",\n \"requestingOrganisationTransactionReference\": \"\",\n \"customerReference\": \"\",\n \"paymentType\": \"\",\n \"serviceProviderComment\": \"\",\n \"serviceProviderNotification\": \"\",\n \"supplementaryBillReferenceDetails\": [\n {\n \"paymentReferenceType\": \"\",\n \"paymentReferenceValue\": \"\"\n },\n {\n \"paymentReferenceType\": \"\",\n \"paymentReferenceValue\": \"\"\n }\n ],\n \"metadata\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":billReference", "payments" ], "variable": [ { "key": "billReference" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":billReference", "payments" ], "variable": [ { "key": "billReference" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Asynchronous response", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":billReference", "payments" ], "variable": [ { "key": "billReference" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notificationMethod\": \"\",\n \"serverCorrelationId\": \"\",\n \"status\": \"\",\n \"pendingReason\": \"\",\n \"objectReference\": \"\",\n \"expiryTime\": \"\",\n \"pollLimit\": \"\",\n \"error\": {\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n }\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":billReference", "payments" ], "variable": [ { "key": "billReference" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "POST", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-CorrelationID", "value": "", "description": "Header parameter to uniquely identify the request. Must be supplied as a UUID." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-User-Bearer", "value": "", "description": "Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication" }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." }, { "key": "X-Callback-URL", "value": "https://myserver.com/send/callback/here", "description": "The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT." }, { "key": "X-Account-Holding-Institution-Identifier-Type", "value": "", "description": "A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header." }, { "key": "X-Account-Holding-Institution-Identifier", "value": "", "description": "A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header." } ], "url": { "raw": "{{baseUrl}}/bills/:billReference/payments", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":billReference", "payments" ], "variable": [ { "key": "billReference" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] }, { "name": "View A Response", "request": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.", "disabled": true }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server.", "disabled": true }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server.", "disabled": true }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed.", "disabled": true }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider.", "disabled": true }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App.", "disabled": true }, { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ChannelGSMAHostName}}/responses/{{clientCorrelationId}}", "host": [ "{{ChannelGSMAHostName}}" ], "path": [ "responses", "{{clientCorrelationId}}" ] }, "description": "This endpoint returns a specific response." }, "response": [ { "name": "Represents an Error Caused by a General Server-Side Issue", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/responses/:clientCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "responses", ":clientCorrelationId" ], "variable": [ { "key": "clientCorrelationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by an Authorisation Failure", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/responses/:clientCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "responses", ":clientCorrelationId" ], "variable": [ { "key": "clientCorrelationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Response object response", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/responses/:clientCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "responses", ":clientCorrelationId" ], "variable": [ { "key": "clientCorrelationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"link\": \"\"\n}" }, { "name": "Represents an Error Caused by the Violation of a Business Rule", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/responses/:clientCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "responses", ":clientCorrelationId" ], "variable": [ { "key": "clientCorrelationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by System Unavailability", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/responses/:clientCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "responses", ":clientCorrelationId" ], "variable": [ { "key": "clientCorrelationId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "name": "Represents an Error Caused by a Failure to Identify the Target Resource", "originalRequest": { "method": "GET", "header": [ { "key": "X-Date", "value": "", "description": "Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API." }, { "key": "X-API-Key", "value": "", "description": "Used to pass pre-shared client's API key to the server." }, { "key": "X-Client-Id", "value": "", "description": "Used to pass pre-shared client's identifier to the server." }, { "key": "X-Content-Hash", "value": "", "description": "SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed." }, { "key": "X-User-Credential-1", "value": "", "description": "The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-User-Credential-2", "value": "", "description": "The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider." }, { "key": "X-Channel", "value": "", "description": "String containing the channel that was used to originate the request. For example USSD, Web, App." } ], "url": { "raw": "{{baseUrl}}/responses/:clientCorrelationId", "host": [ "{{baseUrl}}" ], "path": [ "responses", ":clientCorrelationId" ], "variable": [ { "key": "clientCorrelationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "X-Date", "value": "", "description": "The date and time that the response message was sent." }, { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCategory\": \"\",\n \"errorCode\": \"\",\n \"errordescription\": \"\",\n \"errorDateTime\": \"\",\n \"errorParameters\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});" ] } } ] }, { "name": "GSMA API", "item": [ { "name": "GSMA P2P", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestingOrganisationTransactionReference\": \"string\",\n \"originalTransactionReference\": \"string\",\n \"subType\": \"string\",\n \"type\": \"transfer\",\n \"amount\": \"11.00\",\n \"currency\": \"USD\",\n \"descriptionText\": \"string\",\n \"fees\": [\n {\n \"feeType\": \"string\",\n \"feeAmount\": \"11\",\n \"feeCurrency\": \"USD\"\n }\n ],\n \"geoCode\": \"37.423825,-122.082900\",\n \"internationalTransferInformation\": {\n \"quotationReference\": \"string\",\n \"quoteId\": \"string\",\n \"originCountry\": \"USA\",\n \"deliveryMethod\": \"directtoaccount\",\n \"receivingCountry\": \"USA\",\n \"relationshipSender\": \"string\",\n \"remittancePurpose\": \"string\"\n },\n \"oneTimeCode\": \"string\",\n \"receiverKyc\": {\n \"birthCountry\": \"USA\",\n \"contactPhone\": \"string\",\n \"dateOfBirth\": \"2000-11-20\",\n \"emailAddress\": \"string\",\n \"employerName\": \"string\",\n \"gender\": \"m\",\n \"idDocument\": [\n {\n \"idType\": \"passport\",\n \"idNumber\": \"string\",\n \"issueDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"expiryDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"issuer\": \"string\",\n \"issuerPlace\": \"string\",\n \"issuerCountry\": \"USA\"\n }\n ],\n \"nationality\": \"USA\",\n \"occupation\": \"string\",\n \"postalAddress\": {\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\",\n \"city\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"USA\"\n },\n \"subjectName\": {\n \"title\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"nativeName\": \"string\"\n }\n },\n \"senderKyc\": {\n \"birthCountry\": \"USA\",\n \"contactPhone\": \"string\",\n \"dateOfBirth\": \"2022-09-28T12:51:19.260+00:00\",\n \"emailAddress\": \"string\",\n \"employerName\": \"string\",\n \"gender\": \"m\",\n \"idDocument\": [\n {\n \"idType\": \"passport\",\n \"idNumber\": \"string\",\n \"issueDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"expiryDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"issuer\": \"string\",\n \"issuerPlace\": \"string\",\n \"issuerCountry\": \"USA\"\n }\n ],\n \"nationality\": \"USA\",\n \"occupation\": \"string\",\n \"postalAddress\": {\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\",\n \"city\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"USA\"\n },\n \"subjectName\": {\n \"title\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"nativeName\": \"string\"\n }\n },\n \"servicingIdentity\": \"string\",\n \"requestDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"metadata\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+449999112\"\n }\n ],\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+449999999\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/gsma/transfer", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "gsma", "transfer" ] } }, "response": [] }, { "name": "GSMA Transaction", "request": { "method": "POST", "header": [ { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}", "type": "text" }, { "key": "accountHoldingInstitutionId", "value": "{{accountHoldingInstitutionId}}", "type": "text" }, { "key": "amsName", "value": "{{amsName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestingOrganisationTransactionReference\": \"string\",\n \"subType\": \"inbound\",\n \"type\": \"transfer\",\n \"amount\": \"11\",\n \"currency\": \"USD\",\n \"descriptionText\": \"string\",\n \"requestDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"payer\": [\n {\n \"partyIdType\": \"MSISDN\",\n \"partyIdIdentifier\": \"{{MSISDN}}\"\n }\n ],\n \"payee\": [\n {\n \"partyIdType\": \"accountId\",\n \"partyIdIdentifier\": \"{{accountId}}\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/gsma/transaction", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "gsma", "transaction" ] } }, "response": [ { "name": "GSMA Transaction", "originalRequest": { "method": "POST", "header": [ { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}", "type": "text" }, { "key": "accountHoldingInstitutionId", "value": "{{accountHoldingInstitutionId}}", "type": "text" }, { "key": "amsName", "value": "{{amsName}}", "type": "text" }, { "key": "X-CallbackURL", "value": "https://webhook.site/3cb8ab56-c03d-4251-9911-520f235da8f5", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestingOrganisationTransactionReference\": \"string\",\n \"subType\": \"inbound\",\n \"type\": \"transfer\",\n \"amount\": \"11\",\n \"currency\": \"USD\",\n \"descriptionText\": \"string\",\n \"requestDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"payer\": [\n {\n \"partyIdType\": \"MSISDN\",\n \"partyIdIdentifier\": \"{{MSISDN}}\"\n }\n ],\n \"payee\": [\n {\n \"partyIdType\": \"accountId\",\n \"partyIdIdentifier\": \"{{accountId}}\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/gsma/transaction", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "gsma", "transaction" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Date", "value": "Wed, 24 Apr 2024 10:22:08 GMT" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Expose-Headers", "value": "*" }, { "key": "X-Kong-Upstream-Latency", "value": "13" }, { "key": "X-Kong-Proxy-Latency", "value": "0" }, { "key": "Via", "value": "kong/3.2.1.0-enterprise-edition" } ], "cookie": [], "body": "{\n \"transactionId\": \"168e49b0-b0e9-4446-a4d8-188f2b9a42e3\"\n}" }, { "name": "GSMA Transaction callback", "originalRequest": { "method": "POST", "header": [ { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}", "type": "text" }, { "key": "accountHoldingInstitutionId", "value": "{{accountHoldingInstitutionId}}", "type": "text" }, { "key": "amsName", "value": "{{amsName}}", "type": "text" }, { "key": "X-CallbackURL", "value": "https://webhook.site/3cb8ab56-c03d-4251-9911-520f235da8f5", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestingOrganisationTransactionReference\": \"string\",\n \"subType\": \"inbound\",\n \"type\": \"transfer\",\n \"amount\": \"11\",\n \"currency\": \"USD\",\n \"descriptionText\": \"string\",\n \"requestDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"customData\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"payer\": [\n {\n \"partyIdType\": \"MSISDN\",\n \"partyIdIdentifier\": \"{{MSISDN}}\"\n }\n ],\n \"payee\": [\n {\n \"partyIdType\": \"accountId\",\n \"partyIdIdentifier\": \"{{accountId}}\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/gsma/transaction", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "gsma", "transaction" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"transferCode\": \"fb13887d-396b-492c-b481-f634fe0dfb03\",\n \"completedTimestamp\": \"2024-04-24T15:52:08+0530\",\n \"transactionCode\": \"168e49b0-b0e9-4446-a4d8-188f2b9a42e3\",\n \"state\": \"ACCEPTED\"\n}" } ] }, { "name": "International Remmitance Payee", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{PayeeTenantName}}", "type": "text" }, { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestingOrganisationTransactionReference\": \"string\",\n \"originalTransactionReference\": \"string\",\n \"subType\": \"string\",\n \"type\": \"transfer\",\n \"amount\": \"11.00\",\n \"currency\": \"USD\",\n \"descriptionText\": \"string\",\n \"fees\": [\n {\n \"feeType\": \"string\",\n \"feeAmount\": \"11\",\n \"feeCurrency\": \"USD\"\n }\n ],\n \"geoCode\": \"37.423825,-122.082900\",\n \"internationalTransferInformation\": {\n \"quotationReference\": \"string\",\n \"quoteId\": \"string\",\n \"originCountry\": \"USA\",\n \"deliveryMethod\": \"directtoaccount\",\n \"receivingCountry\": \"USA\",\n \"relationshipSender\": \"string\",\n \"remittancePurpose\": \"string\"\n },\n \"oneTimeCode\": \"string\",\n \"receiverKyc\": {\n \"birthCountry\": \"USA\",\n \"contactPhone\": \"string\",\n \"dateOfBirth\": \"2000-11-20\",\n \"emailAddress\": \"string\",\n \"employerName\": \"string\",\n \"gender\": \"m\",\n \"idDocument\": [\n {\n \"idType\": \"passport\",\n \"idNumber\": \"string\",\n \"issueDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"expiryDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"issuer\": \"string\",\n \"issuerPlace\": \"string\",\n \"issuerCountry\": \"USA\"\n }\n ],\n \"nationality\": \"USA\",\n \"occupation\": \"string\",\n \"postalAddress\": {\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\",\n \"city\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"USA\"\n },\n \"subjectName\": {\n \"title\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"nativeName\": \"string\"\n }\n },\n \"senderKyc\": {\n \"birthCountry\": \"USA\",\n \"contactPhone\": \"string\",\n \"dateOfBirth\": \"2022-09-28T12:51:19.260+00:00\",\n \"emailAddress\": \"string\",\n \"employerName\": \"string\",\n \"gender\": \"m\",\n \"idDocument\": [\n {\n \"idType\": \"passport\",\n \"idNumber\": \"string\",\n \"issueDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"expiryDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"issuer\": \"string\",\n \"issuerPlace\": \"string\",\n \"issuerCountry\": \"USA\"\n }\n ],\n \"nationality\": \"USA\",\n \"occupation\": \"string\",\n \"postalAddress\": {\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"addressLine3\": \"string\",\n \"city\": \"string\",\n \"stateProvince\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"USA\"\n },\n \"subjectName\": {\n \"title\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"nativeName\": \"string\"\n }\n },\n \"servicingIdentity\": \"string\",\n \"requestDate\": \"2022-09-28T12:51:19.260+00:00\",\n \"metadata\": [\n {\n \"key\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+449999112\"\n }\n ],\n \"debitParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+449999999\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/gsma/deposit", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "gsma", "deposit" ] } }, "response": [] } ] }, { "name": "Transfer Query", "request": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{PlatformTenant}}", "type": "text" } ], "url": { "raw": "{{ChannelHostName}}/channel/transfer/{{transactionId}}", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "transfer", "{{transactionId}}" ] } }, "response": [] }, { "name": "Transfer", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{PlatformTenant}}", "type": "text" }, { "key": "X-PayeeDFSP-ID", "value": "{{payeeDFSPId}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"payer\": {\n \"partyIdInfo\": {\n \"partyIdType\": \"MSISDN\",\n \"partyIdentifier\": \"27710101999\"\n }\n },\n \"payee\": {\n \"partyIdInfo\": {\n \"partyIdType\": \"MSISDN\",\n \"partyIdentifier\": \"27710102999\"\n }\n },\n \"amount\": {\n \"amount\": 230,\n \"currency\": \"TZS\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/transfer", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "transfer" ] } }, "response": [] }, { "name": "Transfer Request", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"payer\": {\n \"partyIdInfo\": {\n \"partyIdType\": \"MSISDN\",\n \"partyIdentifier\": \"27710203999\"\n }\n },\n \"payee\": {\n \"partyIdInfo\": {\n \"partyIdType\": \"MSISDN\",\n \"partyIdentifier\": \"27710305999\"\n }\n },\n \"amount\": {\n \"amount\": 77,\n \"currency\": \"TZS\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/transactionRequest", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "transactionRequest" ] } }, "response": [] }, { "name": "Party Registration", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\":\"9062b90de19b43989005\",\n \"idType\": \"EMAIL\",\n \"idValue\": \"test@test.hu\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/partyRegistration", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "partyRegistration" ] } }, "response": [] }, { "name": "Get Txn by Client Id", "request": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "requestType", "value": "transfers", "type": "text" } ], "url": { "raw": "{{ChannelHostName}}/channel/txnState/{{X-CorrelationID}}", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "txnState", "{{X-CorrelationID}}" ] } }, "response": [] } ] }, { "name": "Mobile Money APIs", "item": [ { "name": "Bilateral Money Transfer", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "tn05", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"payer\": {\n \"partyIdInfo\": {\n \"partyIdType\": \"MSISDN\",\n \"partyIdentifier\": \"+449999999\"\n }\n },\n \"payee\": {\n \"partyIdInfo\": {\n \"partyIdType\": \"MSISDN\",\n \"partyIdentifier\": \"+449999112\"\n }\n },\n \"amount\": {\n \"amount\": 6,\n \"currency\": \"TZS\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/{{provider}}/transfer", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "{{provider}}", "transfer" ] } }, "response": [] }, { "name": "MerchantPay", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "tn05", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"payer\": {\n \"partyIdInfo\": {\n \"partyIdType\": \"MSISDN\",\n \"partyIdentifier\": \"+449999999\"\n }\n },\n \"payee\": {\n \"partyIdInfo\": {\n \"partyIdType\": \"MSISDN\",\n \"partyIdentifier\": \"+449999112\"\n }\n },\n \"amount\": {\n \"amount\": 6,\n \"currency\": \"TZS\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/{{provider}}/merchantpay", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "{{provider}}", "merchantpay" ] } }, "response": [] }, { "name": "MerchantPay with AuthCode", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "tn05", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"payer\": {\n \"partyIdInfo\": {\n \"partyIdType\": \"MSISDN\",\n \"partyIdentifier\": \"+449999999\"\n }\n },\n \"payee\": {\n \"partyIdInfo\": {\n \"partyIdType\": \"MSISDN\",\n \"partyIdentifier\": \"+449999112\"\n }\n },\n \"amount\": {\n \"amount\": 6,\n \"currency\": \"TZS\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/{{provider}}/merchantpay/authcode/{{authorizationCode}}", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "{{provider}}", "merchantpay", "authcode", "{{authorizationCode}}" ] } }, "response": [] }, { "name": "International Transfer", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "ibank-usa", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"amount\": \"54\",\r\n \"type\": \"transfer\",\r\n \"requestingLei\": \"ibank-usa\", \r\n \"receivingLei\": \"ibank-india\",\r\n \"creditParty\": [\r\n {\r\n \"key\": \"msisdn\",\r\n \"value\": \"919900878571\"\r\n }\r\n ],\r\n \"currency\": \"USD\",\r\n \"debitParty\": [\r\n {\r\n \"key\": \"msisdn\",\r\n \"value\": \"7543010\"\r\n }\r\n ],\r\n \"internationalTransferInformation\":{\r\n \"originCountry\":\"US\",\r\n \"receivingCountry\":\"IN\",\r\n \"receivingCurrency\":\"INR\",\r\n \"currencyPair\":\"INR/USD\"\r\n }\r\n}" }, "url": { "raw": "{{ChannelHostName}}/channel/{{provider}}/inttransfer", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "{{provider}}", "inttransfer" ] } }, "response": [] }, { "name": "Deposit Money", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "ibank-usa", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"304\",\n \"type\": \"transfer\",\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"+919900878571\"\n }\n ],\n \"currency\": \"USD\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/{{provider}}/deposit", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "{{provider}}", "deposit" ] } }, "response": [] } ] }, { "name": "Bulk APIs", "item": [ { "name": "Bulk transfer older", "event": [ { "listen": "test", "script": { "exec": [ "postman.setEnvironmentVariable(\"batchId\", jsonData.pollingApi);" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}", "type": "text" } ], "url": { "raw": "{{BulkHostName}}/channel/bulk/transfer/ph-ee-bulk-demo-8.csv", "host": [ "{{BulkHostName}}" ], "path": [ "channel", "bulk", "transfer", "ph-ee-bulk-demo-8.csv" ] } }, "response": [ { "name": "Bulk transfer older success", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{BulkHostName}}/channel/bulk/transfer/ph-ee-bulk-demo-8.csv", "host": [ "{{BulkHostName}}" ], "path": [ "channel", "bulk", "transfer", "ph-ee-bulk-demo-8.csv" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "Date", "value": "Fri, 07 Oct 2022 10:12:52 GMT" }, { "key": "Content-Length", "value": "36" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Real-IP", "value": "172.31.21.123" }, { "key": "Accept-Encoding", "value": "gzip, deflate, br" }, { "key": "X-Forwarded-Scheme", "value": "https" }, { "key": "X-Request-ID", "value": "14c2dd56ee9a222f75b8969e7e7bdefd" }, { "key": "X-Scheme", "value": "https" }, { "key": "X-Forwarded-Port", "value": "443" }, { "key": "X-Forwarded-For", "value": "172.31.21.123" }, { "key": "Referer", "value": "http://bulk-connector.sandbox.fynarfin.io/channel/bulk/transfer/ph-ee-bulk-demo-8.csv" }, { "key": "X-Forwarded-Host", "value": "bulk-connector.sandbox.fynarfin.io" }, { "key": "Accept", "value": "*/*" }, { "key": "Postman-Token", "value": "f8abf77b-694f-417e-a127-0b33caff7aff" }, { "key": "fileName", "value": "ph-ee-bulk-demo-8.csv" }, { "key": "User-Agent", "value": "PostmanRuntime/7.29.2" }, { "key": "X-Forwarded-Proto", "value": "https" }, { "key": "Platform-TenantId", "value": "ibank-usa" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" } ], "cookie": [], "body": "d981b089-514b-4400-a7c7-499b56ed1c37" } ] }, { "name": "Bulk Transfer", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " pm.expect(pm.response.text).not.equal(null)", "});", "var jsonData = JSON.parse(responseBody);", "postman.setEnvironmentVariable(\"batchId\", jsonData.pollingApi);", "", "if(postman.getEnvironmentVariable(\"AutoTest\") == \"true\"){", " var nextTextIndex = Number(postman.getEnvironmentVariable(\"NextTestIndex\"));", " var apis = pm.environment.get('TestApiList');", " var testList = JSON.parse(apis);", " if(testList.length>nextTextIndex){", " postman.setEnvironmentVariable(\"NextTestIndex\", 1+ nextTextIndex);", " postman.setNextRequest(testList[nextTextIndex]); ", " }else{", " postman.setNextRequest(null); ", " }", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}" }, { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}", "type": "text" }, { "key": "X-Callback-URL", "value": "{{BulkHostName}}/simulate", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "data", "description": "CSV file conisiting of transaction details. CSV format: \"id\", \"request_id\", \"payment_mode\", \"account_number\", \"amount\", \"currency\", \"note\" in the given order. ", "type": "file", "src": "{{batchFilePath}}" }, { "key": "requestId", "value": "3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8", "description": "Request ID for client side batch correlation. ", "type": "text", "disabled": true }, { "key": "purpose", "value": "test payment", "description": "Optional field stating purpose of the batch.", "type": "text", "disabled": true } ] }, "url": { "raw": "{{BulkHostName}}/bulk/transfer/{{$guid}}/ph-ee-bulk-demo-6.csv", "host": [ "{{BulkHostName}}" ], "path": [ "bulk", "transfer", "{{$guid}}", "ph-ee-bulk-demo-6.csv" ] } }, "response": [ { "name": "Bulk Transfer", "originalRequest": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "ibank-usa" } ], "body": { "mode": "formdata", "formdata": [ { "key": "data", "description": "CSV file conisiting of transaction details. CSV format: \"id\", \"request_id\", \"payment_mode\", \"account_number\", \"amount\", \"currency\", \"note\" in the given order. ", "type": "file", "src": "/Users/subhampramanik/Downloads/download.csv" }, { "key": "requestId", "value": "3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8", "description": "Request ID for client side batch correlation. ", "type": "text" }, { "key": "purpose", "value": "iliydufkgiku", "description": "Optional field stating purpose of the batch.", "type": "text" } ] }, "url": { "raw": "{{ChannelHostName}}/channel/bulk/transfer", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "bulk", "transfer" ] } }, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"batch_id\": \"738bd830-3bd9-4511-bb42-3d0f5798e014\",\n \"request_id\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"status\": \"queued\"\n}" } ] }, { "name": "Batch Transactions", "event": [ { "listen": "test", "script": { "exec": [ "var jsonData = JSON.parse(responseBody);", "postman.setEnvironmentVariable(\"batchId\", jsonData.pollingApi);" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "Purpose", "value": "test payment", "type": "text" }, { "key": "filename", "value": "ph-ee-bulk-demo-7.csv", "type": "text" }, { "key": "X-CorrelationID", "value": "{{X-CorrelationId}}", "type": "text" }, { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-Signature", "value": "{{x-signature}}", "type": "text" }, { "key": "type", "value": "csv", "type": "text" }, { "key": "X-PayeeDFSP-ID", "value": "{{payeeDFSPId}}", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "data", "type": "file", "src": "/Users/ankitagarwal/fynarfin/ph-ee-bulk-demo-7.csv" } ] }, "url": { "raw": "{{BulkHostName}}/batchtransactions", "host": [ "{{BulkHostName}}" ], "path": [ "batchtransactions" ], "query": [ { "key": "type", "value": "csv", "disabled": true } ] } }, "response": [ { "name": "Batch Transactions", "originalRequest": { "method": "POST", "header": [ { "key": "Purpose", "value": "test payment", "type": "text" }, { "key": "filename", "value": "ph-ee-bulk-demo-6.csv", "type": "text" }, { "key": "X-CorrelationID", "value": "{{X-CorrelationId}}", "type": "text" }, { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-Signature", "value": "{{X-Signature}}", "type": "text" }, { "key": "type", "value": "csv", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "data", "type": "file", "src": "/Users/dhavalmaniyar/Documents/projects/ph-ee-connector-integration-test/src/test/java/resources/batch_demo_csv/ph-ee-bulk-demo-6.csv" } ] }, "url": { "raw": "{{BulkHostName}}/batchtransactions", "host": [ "{{BulkHostName}}" ], "path": [ "batchtransactions" ], "query": [ { "key": "type", "value": "csv", "disabled": true } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "102" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Platform-TenantId", "value": "gorilla" }, { "key": "X-SIGNATURE", "value": "Ta+CtpvS8KjuV9yxhjBjl+OJHwJ4x+52ha82sx7ozVELDSFIPgkjCWreEMI95urBVHorkJtY3yX0+5DJodynyShL017qoYgZOZRYZZRy3JFB15Nmi3BCtvsLQc94PMsnX4zx2Nlo2g/YTyWTTU/uAGIWXmnkjMgy7mX5/r5lBpGyVu2T0xdVHF109+/3do8YJA9MTieBlInCp6bxaCRXLLkb23DiC+T+sHhzRZ2ODj5cWcKBLvDvDCz/V4n90nYyHSaxPb6EfoxZlLU2013tSnhIXW6e95el/X4Rq8QRQ6OoZgN4mi75miF+zibDex9BvTIgxCgYSuVSjB0fS7E8FQ==" }, { "key": "Date", "value": "Fri, 15 Mar 2024 08:00:53 GMT" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Expose-Headers", "value": "*" }, { "key": "X-Kong-Upstream-Latency", "value": "136" }, { "key": "X-Kong-Proxy-Latency", "value": "1" }, { "key": "Via", "value": "kong/3.2.1.0-enterprise-edition" } ], "cookie": [], "body": "{\n \"PollingPath\": \"/batch/Summary/fc9ea097-4566-43aa-82d4-dd455ad55e99\",\n \"SuggestedCallbackSeconds\": \"120\"\n}" }, { "name": "Batch Transactions Callback", "originalRequest": { "method": "POST", "header": [ { "key": "Purpose", "value": "test payment", "type": "text" }, { "key": "filename", "value": "ph-ee-bulk-demo-6.csv", "type": "text" }, { "key": "X-CorrelationID", "value": "{{X-CorrelationId}}", "type": "text" }, { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-Signature", "value": "{{X-Signature}}", "type": "text" }, { "key": "type", "value": "csv", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "data", "type": "file", "src": "/Users/dhavalmaniyar/Documents/projects/ph-ee-connector-integration-test/src/test/java/resources/batch_demo_csv/ph-ee-bulk-demo-6.csv" } ] }, "url": { "raw": "{{BulkHostName}}/batchtransactions", "host": [ "{{BulkHostName}}" ], "path": [ "batchtransactions" ], "query": [ { "key": "type", "value": "csv", "disabled": true } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "102" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Platform-TenantId", "value": "gorilla" }, { "key": "X-SIGNATURE", "value": "Ta+CtpvS8KjuV9yxhjBjl+OJHwJ4x+52ha82sx7ozVELDSFIPgkjCWreEMI95urBVHorkJtY3yX0+5DJodynyShL017qoYgZOZRYZZRy3JFB15Nmi3BCtvsLQc94PMsnX4zx2Nlo2g/YTyWTTU/uAGIWXmnkjMgy7mX5/r5lBpGyVu2T0xdVHF109+/3do8YJA9MTieBlInCp6bxaCRXLLkb23DiC+T+sHhzRZ2ODj5cWcKBLvDvDCz/V4n90nYyHSaxPb6EfoxZlLU2013tSnhIXW6e95el/X4Rq8QRQ6OoZgN4mi75miF+zibDex9BvTIgxCgYSuVSjB0fS7E8FQ==" }, { "key": "Date", "value": "Fri, 15 Mar 2024 08:00:53 GMT" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Expose-Headers", "value": "*" }, { "key": "X-Kong-Upstream-Latency", "value": "136" }, { "key": "X-Kong-Proxy-Latency", "value": "1" }, { "key": "Via", "value": "kong/3.2.1.0-enterprise-edition" } ], "cookie": [], "body": "{\n \"clientCorrelationId\": \"2251799816458110\",\n \"batchId\": \"fc9ea097-4566-43aa-82d4-dd455ad55e99\",\n \"message\": \"The Batch Aggregation API was complete with : 100\"\n}" } ] }, { "name": "Batch Transactions JSON", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "var jsonData = JSON.parse(responseBody);", "postman.setEnvironmentVariable(\"batchId\", jsonData.pollingApi);", "", "pm.test(\"Response value check\", function () {", " var jsonData = pm.response.json();", " pm.expect(jsonData.batch_id)!=null;", " pm.expect(jsonData.status)!=null;", " pm.expect(jsonData.request_id)!=null;", "});", "", "", "if(postman.getEnvironmentVariable(\"AutoTest\") == \"true\"){", " var nextTextIndex = Number(postman.getEnvironmentVariable(\"NextTestIndex\"));", " var apis = pm.environment.get('TestApiList');", " var testList = JSON.parse(apis);", " if(testList.length>nextTextIndex){", " postman.setEnvironmentVariable(\"NextTestIndex\", 1+ nextTextIndex);", " postman.setNextRequest(testList[nextTextIndex]); ", " }else{", " postman.setNextRequest(null); ", " }", "}" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Purpose", "value": "test payment", "type": "text" }, { "key": "X-CorrelationID", "value": "{{X-CorrelationId}}", "type": "text" }, { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-Signature", "value": "{{x-signature}}", "type": "text" }, { "key": "type", "value": "raw", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"8837461856\"\n }\n ],\n \"debitParty\": [\n {\n \"key\": \"accountnumber\",\n \"value\": \"003001003874120160\"\n }\n ],\n \"subType\": \"SLCB\",\n \"amount\": \"820.00\",\n \"currency\": \"RWF\",\n \"descriptionText\": \"Test Payment\"\n },\n {\n \"creditParty\": [\n {\n \"key\": \"msisdn\",\n \"value\": \"32131461856\"\n }\n ],\n \"debitParty\": [\n {\n \"key\": \"accountnumber\",\n \"value\": \"21314556003874120160\"\n }\n ],\n \"subType\": \"SLCB\",\n \"amount\": \"20.00\",\n \"currency\": \"RWF\",\n \"descriptionText\": \"Test Payment\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{BulkHostName}}/batchtransactions", "host": [ "{{BulkHostName}}" ], "path": [ "batchtransactions" ] } }, "response": [] }, { "name": "Bulk Account Lookup", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}" }, { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "data", "description": "CSV file conisiting of transaction details. CSV format: \"id\", \"payment_mode\", \"account_number\", \"note\" in the given order. ", "type": "file", "src": "/Users/subhampramanik/Downloads/download.csv" }, { "key": "requestId", "value": "3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8", "description": "Request ID for client side batch correlation. ", "type": "text" }, { "key": "purpose", "value": "iliydufkgiku", "description": "Optional field stating purpose of the batch.", "type": "text" } ] }, "url": { "raw": "{{ChannelHostName}}/channel/bulk/lookup", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "bulk", "lookup" ] } }, "response": [ { "name": "Bulk Account Lookup", "originalRequest": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "ibank-usa" } ], "body": { "mode": "formdata", "formdata": [ { "key": "data", "description": "CSV file conisiting of transaction details. CSV format: \"id\", \"payment_mode\", \"account_number\", \"note\" in the given order. ", "type": "file", "src": "/Users/subhampramanik/Downloads/download.csv" }, { "key": "requestId", "value": "3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8", "description": "Request ID for client side batch correlation. ", "type": "text" }, { "key": "purpose", "value": "iliydufkgiku", "description": "Optional field stating purpose of the batch.", "type": "text" } ] }, "url": { "raw": "{{ChannelHostName}}/channel/bulk/lookup", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "bulk", "lookup" ] } }, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"batch_id\": \"738bd830-3bd9-4511-bb42-3d0f5798e014\",\n \"request_id\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"status\": \"queued\"\n}" } ] }, { "name": "Batch Summary", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " pm.expect(pm.response.text).not.equal(null)", "});", "", "if(postman.getEnvironmentVariable(\"AutoTest\") == \"true\"){", " var nextTextIndex = Number(postman.getEnvironmentVariable(\"NextTestIndex\"));", " var apis = pm.environment.get('TestApiList');", " var testList = JSON.parse(apis);", " if(testList.length>nextTextIndex){", " postman.setEnvironmentVariable(\"NextTestIndex\", 1+ nextTextIndex);", " postman.setNextRequest(testList[nextTextIndex]); ", " }else{", " postman.setNextRequest(null); ", " }", "}" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "User-Agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:90.0) Gecko/20100101 Firefox/90.0", "disabled": true }, { "key": "Accept", "value": "application/json, text/plain, */*", "disabled": true }, { "key": "Accept-Language", "value": "en-US,en;q=0.5", "disabled": true }, { "key": "Platform-TenantId", "value": "{{TenantName}}" }, { "key": "Authorization", "value": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiaWRlbnRpdHktcHJvdmlkZXIiLCJpYmFuay11c2EiXSwic2NvcGUiOlsiaWRlbnRpdHkiXSwiZXhwIjoxNjMyNjY3MjY4LCJhdXRob3JpdGllcyI6WyJBTExfRlVOQ1RJT05TIl0sImp0aSI6InE2bklEMUZSNzlvM1JTK2U2enZVZ2hoa0c2ST0iLCJjbGllbnRfaWQiOiJjaGFubmVsLWliYW5rLXVzYSJ9.pt-az4y6ue2OEh5PIpV8cPkhHFwql_XK8OVRc_31gH-8GLwwZwtG9Q1k16LNxfTG4lsDpPYkJUO7UwabJlDuEfIzQtMhalVY3QwkFKjOr9T77c9esFHsjJ35FfQ5cVEDW3dUgFjF_1l-QsPAD1Nil1JSpYg-tXy8bJaVn1BI8VxYrN713VB-ZOs-eVJC_0zdK8iUHGmbSxuHojfhsj3INvU6vYYzo0u-jCzFfxImrIIFdia8DuL1S6sy4kd2ZM08_NCw_4rzW3hCgL9Yu0u_SfO2iJvh0BsXg4DC8iweBfq8rDqfQNR0Vzew9zCmiynZBWbp3elmkNnZDcVJU3yTww" }, { "key": "Origin", "value": "http://localhost:4200", "disabled": true }, { "key": "Connection", "value": "keep-alive", "disabled": true }, { "key": "Referer", "value": "http://localhost:4200/", "disabled": true } ], "url": { "raw": "{{OperationsHostName}}/api/v1/batch?batchId={{batchId}}&X-CorrelationID={{clientCorrelationId}}", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "batch" ], "query": [ { "key": "direction", "value": "OUTGOING", "description": "INCOMING or OUTGOING direction", "disabled": true }, { "key": "status", "value": "ONGOING", "description": "Transaction State can be ONGOING, STARTED, FAILED", "disabled": true }, { "key": "batchId", "value": "{{batchId}}" }, { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}" } ] } }, "response": [ { "name": "Batch Summary", "originalRequest": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:90.0) Gecko/20100101 Firefox/90.0", "disabled": true }, { "key": "Accept", "value": "application/json, text/plain, */*", "disabled": true }, { "key": "Accept-Language", "value": "en-US,en;q=0.5", "disabled": true }, { "key": "Platform-TenantId", "value": "ibank-usa" }, { "key": "Authorization", "value": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiaWRlbnRpdHktcHJvdmlkZXIiLCJpYmFuay11c2EiXSwic2NvcGUiOlsiaWRlbnRpdHkiXSwiZXhwIjoxNjMyNjY3MjY4LCJhdXRob3JpdGllcyI6WyJBTExfRlVOQ1RJT05TIl0sImp0aSI6InE2bklEMUZSNzlvM1JTK2U2enZVZ2hoa0c2ST0iLCJjbGllbnRfaWQiOiJjaGFubmVsLWliYW5rLXVzYSJ9.pt-az4y6ue2OEh5PIpV8cPkhHFwql_XK8OVRc_31gH-8GLwwZwtG9Q1k16LNxfTG4lsDpPYkJUO7UwabJlDuEfIzQtMhalVY3QwkFKjOr9T77c9esFHsjJ35FfQ5cVEDW3dUgFjF_1l-QsPAD1Nil1JSpYg-tXy8bJaVn1BI8VxYrN713VB-ZOs-eVJC_0zdK8iUHGmbSxuHojfhsj3INvU6vYYzo0u-jCzFfxImrIIFdia8DuL1S6sy4kd2ZM08_NCw_4rzW3hCgL9Yu0u_SfO2iJvh0BsXg4DC8iweBfq8rDqfQNR0Vzew9zCmiynZBWbp3elmkNnZDcVJU3yTww" }, { "key": "Origin", "value": "http://localhost:4200", "disabled": true }, { "key": "Connection", "value": "keep-alive", "disabled": true }, { "key": "Referer", "value": "http://localhost:4200/", "disabled": true } ], "url": { "raw": "{{OperationsHostName}}/api/v1/batch?batchId={{batchId}}", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "batch" ], "query": [ { "key": "direction", "value": "OUTGOING", "description": "INCOMING or OUTGOING direction", "disabled": true }, { "key": "status", "value": "ONGOING", "description": "Transaction State can be ONGOING, STARTED, FAILED", "disabled": true }, { "key": "batchId", "value": "{{batchId}}" } ] } }, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"batchId\": \"c02a14f0-5e7e-44a1-88eb-5584a21e6f28\",\n \"requestId\": \"dhgdfe-jiae-ugir-bsjf-ndsdfsdfdfd\",\n \"totalTransactions\": 2,\n \"ongoing\": 2,\n \"failed\": 0,\n \"completed\": 0,\n \"total_amount\": 767,\n \"completed_amount\": 0,\n \"ongoing_amount\": 767,\n \"failed_amount\": 0,\n \"result_file\": null,\n \"resultGeneratedAt\": 1634955667187,\n \"note\": \"Sample Response\"\n}" } ] }, { "name": "Batch Details", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " pm.expect(pm.response.text).not.equal(null)", "});", "", "pm.test(\"Empty Content test\", () => {", " var jsonData = pm.response.json();", " pm.expect(jsonData.content).to.be.an(\"array\");", " pm.expect(jsonData.content).length.greaterThan(0);", "});", "", "pm.test(\"Party and payee null data check\", () => {", " var jsonData = pm.response.json();", " var contentArray = jsonData.content;", " console.log(contentArray)", " contentArray.forEach( (transfer) => {", " let payeeDfspId = transfer.payeeDfspId;", " let payeePartyId = transfer.payeePartyId;", " let payeePartyIdType = transfer.payeePartyIdType;", " let payerDfspId = transfer.payerDfspId;", " let payerPartyId = transfer.payerPartyId;", " let payerPartyIdType = transfer.payerPartyIdType;", "", " pm.expect(payeeDfspId).not.equal(null);", " pm.expect(payeePartyId).not.equal(null);", " pm.expect(payeePartyIdType).not.equal(null);", " pm.expect(payerDfspId).not.equal(null);", " pm.expect(payerPartyId).not.equal(null);", " pm.expect(payerPartyIdType).not.equal(null);", " })", "});", "", "if(postman.getEnvironmentVariable(\"AutoTest\") == \"true\"){", " var nextTextIndex = Number(postman.getEnvironmentVariable(\"NextTestIndex\"));", " var apis = pm.environment.get('TestApiList');", " var testList = JSON.parse(apis);", " if(testList.length>nextTextIndex){", " postman.setEnvironmentVariable(\"NextTestIndex\", 1+ nextTextIndex);", " postman.setNextRequest(testList[nextTextIndex]); ", " }else{", " postman.setNextRequest(null); ", " }", "}" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "User-Agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:90.0) Gecko/20100101 Firefox/90.0" }, { "key": "Accept", "value": "application/json, text/plain, */*" }, { "key": "Accept-Language", "value": "en-US,en;q=0.5" }, { "key": "Platform-TenantId", "value": "{{TenantName}}" }, { "key": "Authorization", "value": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiaWRlbnRpdHktcHJvdmlkZXIiLCJpYmFuay11c2EiXSwic2NvcGUiOlsiaWRlbnRpdHkiXSwiZXhwIjoxNjMyNjMyODYyLCJhdXRob3JpdGllcyI6WyJBTExfRlVOQ1RJT05TIl0sImp0aSI6IkJ1eitMMDZQbnRQcVI4QW1kK2VWVndCVWJMST0iLCJjbGllbnRfaWQiOiJjaGFubmVsLWliYW5rLXVzYSJ9.mXseJ-W1QyGz4rWyj91Goz5LHh-rSlfbABVVRatU2ecwG4CYxkwJn1Xo-WHfvQC45L8Uw3qJqKfhkkJ7mV7cFV5Tm5E6h1aYzPefn-POlo7GBOdrWPPaNvFkBaQKBJaPtqgmcmWBpo56o_XHj6Mz-f3PuepSq57Wi7tbpC1LuLCGxpsSNIvYeWA-_jkFCReGdOhuLphiUzAc1_p0cDVT2bmzSvVaU6sKYK2ZBIBsqfYXkhA5aFvbvFrLWj4o-w2mYrTH7v9689RfvSn57W_xE6aOC2nz_JoKAwaVjraxDl6bRQ_xEmzMJCITnYaFMoJi_dKC4Rp2tVEUb9GASqQfiQ" }, { "key": "Origin", "value": "http://localhost:4200" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Referer", "value": "http://localhost:4200/" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/batch/detail?batchId={{batchId}}&pageSize={{pageSize}}&X-CorrelationID={{clientCorrelationId}}", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "batch", "detail" ], "query": [ { "key": "direction", "value": "OUTGOING", "description": "INCOMING or OUTGOING direction", "disabled": true }, { "key": "batchId", "value": "{{batchId}}", "description": "Batch ID from transaction" }, { "key": "pageNo", "value": "{{pageNo}}", "description": "Page Number", "disabled": true }, { "key": "pageSize", "value": "{{pageSize}}", "description": "Page Size" }, { "key": "status", "value": "{{status}}", "description": "Transaction Status. Values can be COMPLETED, FAILED, IN_PROGRESS and ALL. By default set to ALL.", "disabled": true }, { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}" } ] } }, "response": [ { "name": "Batch Details", "originalRequest": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:90.0) Gecko/20100101 Firefox/90.0" }, { "key": "Accept", "value": "application/json, text/plain, */*" }, { "key": "Accept-Language", "value": "en-US,en;q=0.5" }, { "key": "Platform-TenantId", "value": "ibank-usa" }, { "key": "Authorization", "value": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiaWRlbnRpdHktcHJvdmlkZXIiLCJpYmFuay11c2EiXSwic2NvcGUiOlsiaWRlbnRpdHkiXSwiZXhwIjoxNjMyNjMyODYyLCJhdXRob3JpdGllcyI6WyJBTExfRlVOQ1RJT05TIl0sImp0aSI6IkJ1eitMMDZQbnRQcVI4QW1kK2VWVndCVWJMST0iLCJjbGllbnRfaWQiOiJjaGFubmVsLWliYW5rLXVzYSJ9.mXseJ-W1QyGz4rWyj91Goz5LHh-rSlfbABVVRatU2ecwG4CYxkwJn1Xo-WHfvQC45L8Uw3qJqKfhkkJ7mV7cFV5Tm5E6h1aYzPefn-POlo7GBOdrWPPaNvFkBaQKBJaPtqgmcmWBpo56o_XHj6Mz-f3PuepSq57Wi7tbpC1LuLCGxpsSNIvYeWA-_jkFCReGdOhuLphiUzAc1_p0cDVT2bmzSvVaU6sKYK2ZBIBsqfYXkhA5aFvbvFrLWj4o-w2mYrTH7v9689RfvSn57W_xE6aOC2nz_JoKAwaVjraxDl6bRQ_xEmzMJCITnYaFMoJi_dKC4Rp2tVEUb9GASqQfiQ" }, { "key": "Origin", "value": "http://localhost:4200" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Referer", "value": "http://localhost:4200/" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/batch/detail?batchId={{batchId}}&pageNo={{pageNo}}&pageSize={{pageSize}}", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "batch", "detail" ], "query": [ { "key": "direction", "value": "OUTGOING", "description": "INCOMING or OUTGOING direction", "disabled": true }, { "key": "batchId", "value": "{{batchId}}", "description": "Batch ID from transaction" }, { "key": "pageNo", "value": "{{pageNo}}", "description": "Page Number" }, { "key": "pageSize", "value": "{{pageSize}}", "description": "Page Size" }, { "key": "status", "value": "{{status}}", "description": "Transaction Status. Values can be COMPLETED, FAILED, IN_PROGRESS and ALL. By default set to ALL.", "disabled": true } ] } }, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "[\n {\n \"id\": 568,\n \"workflowInstanceKey\": 2251799907439003,\n \"transactionId\": \"e5eea064-1445-4d32-bc55-bd9826c779a0\",\n \"startedAt\": 1629130966000,\n \"completedAt\": 1629130967000,\n \"status\": \"IN_PROGRESS\",\n \"statusDetail\": null,\n \"payeeDfspId\": \"ibank-india\",\n \"payeePartyId\": \"919900878571\",\n \"payeePartyIdType\": \"MSISDN\",\n \"payeeFee\": null,\n \"payeeFeeCurrency\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": \"ibank-usa\",\n \"payerPartyId\": \"7543010\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerFeeCurrency\": null,\n \"payerQuoteCode\": null,\n \"amount\": 448,\n \"currency\": \"USD\",\n \"direction\": \"OUTGOING\",\n \"errorInformation\": \"{\\\\\\\"errorInformation\\\\\\\":{\\\\\\\"errorDescription\\\\\\\":\\\\\\\"Invalid responseCode 500 for transfer on PAYER side, transactionId: e5eea064-1445-4d32-bc55-bd9826c779a0 Message: {\\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\\":1629130966891,\\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\\":500,\\\\\\\\\\\\\\\"error\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"Internal Server Error\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"message\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"/fineract-provider/api/v1/interoperation/transfers\\\\\\\\\\\\\\\"}\\\\\\\",\\\\\\\"errorCode\\\\\\\":\\\\\\\"4101\\\\\\\"}}\",\n \"batchId\": \"c02a14f0-5e7e-44a1-88eb-5584a21e6f28\"\n },\n {\n \"id\": 569,\n \"workflowInstanceKey\": 2251799907439017,\n \"transactionId\": \"3cc88b24-1df6-48e2-8b1f-5dbd02ba96b7\",\n \"startedAt\": 1629130966000,\n \"completedAt\": 1629150766000,\n \"status\": \"IN_PROGRESS\",\n \"statusDetail\": null,\n \"payeeDfspId\": \"ibank-india\",\n \"payeePartyId\": \"919900878571\",\n \"payeePartyIdType\": \"MSISDN\",\n \"payeeFee\": null,\n \"payeeFeeCurrency\": null,\n \"payeeQuoteCode\": null,\n \"payerDfspId\": \"ibank-usa\",\n \"payerPartyId\": \"7543010\",\n \"payerPartyIdType\": \"MSISDN\",\n \"payerFee\": null,\n \"payerFeeCurrency\": null,\n \"payerQuoteCode\": null,\n \"amount\": 319,\n \"currency\": \"USD\",\n \"direction\": \"OUTGOING\",\n \"errorInformation\": null,\n \"batchId\": \"c02a14f0-5e7e-44a1-88eb-5584a21e6f28\"\n }\n]" } ] }, { "name": "Batch Lookup Details", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " pm.expect(pm.response.text).not.equal(null)", "});", "", "if(postman.getEnvironmentVariable(\"AutoTest\") == \"true\"){", " var nextTextIndex = Number(postman.getEnvironmentVariable(\"NextTestIndex\"));", " var apis = pm.environment.get('TestApiList');", " var testList = JSON.parse(apis);", " if(testList.length>nextTextIndex){", " postman.setEnvironmentVariable(\"NextTestIndex\", 1+ nextTextIndex);", " postman.setNextRequest(testList[nextTextIndex]); ", " }else{", " postman.setNextRequest(null); ", " }", "}" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "User-Agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:90.0) Gecko/20100101 Firefox/90.0" }, { "key": "Accept", "value": "application/json, text/plain, */*" }, { "key": "Accept-Language", "value": "en-US,en;q=0.5" }, { "key": "Platform-TenantId", "value": "{{TenantName}}" }, { "key": "Authorization", "value": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiaWRlbnRpdHktcHJvdmlkZXIiLCJpYmFuay11c2EiXSwic2NvcGUiOlsiaWRlbnRpdHkiXSwiZXhwIjoxNjMyNjMyODYyLCJhdXRob3JpdGllcyI6WyJBTExfRlVOQ1RJT05TIl0sImp0aSI6IkJ1eitMMDZQbnRQcVI4QW1kK2VWVndCVWJMST0iLCJjbGllbnRfaWQiOiJjaGFubmVsLWliYW5rLXVzYSJ9.mXseJ-W1QyGz4rWyj91Goz5LHh-rSlfbABVVRatU2ecwG4CYxkwJn1Xo-WHfvQC45L8Uw3qJqKfhkkJ7mV7cFV5Tm5E6h1aYzPefn-POlo7GBOdrWPPaNvFkBaQKBJaPtqgmcmWBpo56o_XHj6Mz-f3PuepSq57Wi7tbpC1LuLCGxpsSNIvYeWA-_jkFCReGdOhuLphiUzAc1_p0cDVT2bmzSvVaU6sKYK2ZBIBsqfYXkhA5aFvbvFrLWj4o-w2mYrTH7v9689RfvSn57W_xE6aOC2nz_JoKAwaVjraxDl6bRQ_xEmzMJCITnYaFMoJi_dKC4Rp2tVEUb9GASqQfiQ" }, { "key": "Origin", "value": "http://localhost:4200" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Referer", "value": "http://localhost:4200/" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/batch/detail?batchId={{batchId}}&pageNo={{pageNo}}&pageSize={{pageSize}}&status={{status}}&X-CorrelationID={{clientCorrelationId}}", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "batch", "detail" ], "query": [ { "key": "batchId", "value": "{{batchId}}", "description": "Batch ID from lookup" }, { "key": "pageNo", "value": "{{pageNo}}", "description": "Page Number" }, { "key": "pageSize", "value": "{{pageSize}}", "description": "Page Size" }, { "key": "status", "value": "{{status}}", "description": "Transaction Status. Values can be COMPLETED, FAILED, IN_PROGRESS and ALL. By default set to ALL." }, { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}" } ] } }, "response": [ { "name": "Batch Lookup Details", "originalRequest": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:90.0) Gecko/20100101 Firefox/90.0" }, { "key": "Accept", "value": "application/json, text/plain, */*" }, { "key": "Accept-Language", "value": "en-US,en;q=0.5" }, { "key": "Platform-TenantId", "value": "ibank-usa" }, { "key": "Authorization", "value": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiaWRlbnRpdHktcHJvdmlkZXIiLCJpYmFuay11c2EiXSwic2NvcGUiOlsiaWRlbnRpdHkiXSwiZXhwIjoxNjMyNjMyODYyLCJhdXRob3JpdGllcyI6WyJBTExfRlVOQ1RJT05TIl0sImp0aSI6IkJ1eitMMDZQbnRQcVI4QW1kK2VWVndCVWJMST0iLCJjbGllbnRfaWQiOiJjaGFubmVsLWliYW5rLXVzYSJ9.mXseJ-W1QyGz4rWyj91Goz5LHh-rSlfbABVVRatU2ecwG4CYxkwJn1Xo-WHfvQC45L8Uw3qJqKfhkkJ7mV7cFV5Tm5E6h1aYzPefn-POlo7GBOdrWPPaNvFkBaQKBJaPtqgmcmWBpo56o_XHj6Mz-f3PuepSq57Wi7tbpC1LuLCGxpsSNIvYeWA-_jkFCReGdOhuLphiUzAc1_p0cDVT2bmzSvVaU6sKYK2ZBIBsqfYXkhA5aFvbvFrLWj4o-w2mYrTH7v9689RfvSn57W_xE6aOC2nz_JoKAwaVjraxDl6bRQ_xEmzMJCITnYaFMoJi_dKC4Rp2tVEUb9GASqQfiQ" }, { "key": "Origin", "value": "http://localhost:4200" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Referer", "value": "http://localhost:4200/" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/batch/detail?batchId={{batchId}}&pageNo={{pageNo}}&pageSize={{pageSize}}&status={{status}}", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "batch", "detail" ], "query": [ { "key": "batchId", "value": "{{batchId}}", "description": "Batch ID from lookup" }, { "key": "pageNo", "value": "{{pageNo}}", "description": "Page Number" }, { "key": "pageSize", "value": "{{pageSize}}", "description": "Page Size" }, { "key": "status", "value": "{{status}}", "description": "Transaction Status. Values can be COMPLETED, FAILED, IN_PROGRESS and ALL. By default set to ALL." } ] } }, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"batchId\": \"c02a14f0-5e7e-44a1-88eb-5584a21e6f28\",\n \"requestId\": \"dhgdfe-jiae-ugir-bsjf-ndsdfsdfdfd\",\n \"totalTransactions\": 2,\n \"ongoing\": 2,\n \"failed\": 0,\n \"completed\": 0,\n \"result_file\": null,\n \"resultGeneratedAt\": 1634955667187,\n \"note\": \"Sample Response\"\n}" } ] }, { "name": "Get All Batches", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " pm.expect(pm.response.text).not.equal(null)", "});", "", "if(postman.getEnvironmentVariable(\"AutoTest\") == \"true\"){", " var nextTextIndex = Number(postman.getEnvironmentVariable(\"NextTestIndex\"));", " var apis = pm.environment.get('TestApiList');", " var testList = JSON.parse(apis);", " if(testList.length>nextTextIndex){", " postman.setEnvironmentVariable(\"NextTestIndex\", 1+ nextTextIndex);", " postman.setNextRequest(testList[nextTextIndex]); ", " }else{", " postman.setNextRequest(null); ", " }", "}" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/batches?page=2&size=10&sortedBy=requestFile&sortedOrder=asc&X-CorrelationID={{clientCorrelationId}}", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "batches" ], "query": [ { "key": "page", "value": "2" }, { "key": "size", "value": "10" }, { "key": "sortedBy", "value": "requestFile" }, { "key": "sortedOrder", "value": "asc" }, { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}" } ] } }, "response": [ { "name": "Get All Batches", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "ibank-usa", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/batches?page=1&size=20", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "batches" ], "query": [ { "key": "page", "value": "1" }, { "key": "size", "value": "20" }, { "key": "sortedBy", "value": null, "disabled": true }, { "key": "sortedOrder", "value": null, "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 13 Sep 2022 06:12:50 GMT" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"id\": 160,\n \"batchId\": \"589c4134-6739-4f54-b76d-567898c7e349\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662626306638_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": 11,\n \"ongoing\": 0,\n \"failed\": 0,\n \"completed\": 11,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662626353290_1662626353290_response.csv\",\n \"resultGeneratedAt\": 1662626353000,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799816029127,\n \"startedAt\": 1662626307000,\n \"completedAt\": null\n },\n {\n \"id\": 156,\n \"batchId\": \"9dbf00f4-f8a0-48e5-908a-154e5662d86a\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662625625503_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": 11,\n \"ongoing\": 0,\n \"failed\": 0,\n \"completed\": 11,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662625671389_1662625671389_response.csv\",\n \"resultGeneratedAt\": 1662625671000,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799816027861,\n \"startedAt\": 1662625626000,\n \"completedAt\": null\n },\n {\n \"id\": 152,\n \"batchId\": \"10a09f4a-61ba-4b54-ae39-ef2230f7748b\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662624970480_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": 11,\n \"ongoing\": 0,\n \"failed\": 0,\n \"completed\": 11,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662625016404_1662625016404_response.csv\",\n \"resultGeneratedAt\": 1662625017000,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799816026682,\n \"startedAt\": 1662624971000,\n \"completedAt\": null\n },\n {\n \"id\": 148,\n \"batchId\": \"7052b36f-594c-4d09-ad90-a69b46e956c0\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662624716397_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": 11,\n \"ongoing\": 0,\n \"failed\": 0,\n \"completed\": 11,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662624764987_1662624764987_response.csv\",\n \"resultGeneratedAt\": 1662624765000,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799816026063,\n \"startedAt\": 1662624718000,\n \"completedAt\": null\n },\n {\n \"id\": 144,\n \"batchId\": \"953d5a8f-d43a-4c08-801a-4f7cf9a2d5c4\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662624261785_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": 11,\n \"ongoing\": 0,\n \"failed\": 0,\n \"completed\": 11,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662624307703_1662624307703_response.csv\",\n \"resultGeneratedAt\": 1662624423000,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799816025171,\n \"startedAt\": 1662624262000,\n \"completedAt\": null\n },\n {\n \"id\": 140,\n \"batchId\": \"1c4d2440-0d93-4978-9d4e-bdc1621ad294\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662623877478_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": 11,\n \"ongoing\": 0,\n \"failed\": 0,\n \"completed\": 11,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662623923610_1662623923610_response.csv\",\n \"resultGeneratedAt\": 1662623924000,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799816024310,\n \"startedAt\": 1662623878000,\n \"completedAt\": null\n },\n {\n \"id\": 136,\n \"batchId\": \"47dfc101-6d16-4da2-b9d0-9af2a4200852\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662623418697_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": 11,\n \"ongoing\": 0,\n \"failed\": 0,\n \"completed\": 11,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662623467290_1662623467290_response.csv\",\n \"resultGeneratedAt\": 1662623468000,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799816023435,\n \"startedAt\": 1662623421000,\n \"completedAt\": null\n },\n {\n \"id\": 132,\n \"batchId\": \"e136647b-1fc1-481e-a187-587edada5776\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662555399110_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": 11,\n \"ongoing\": 0,\n \"failed\": 0,\n \"completed\": 11,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662555448112_e136647b-1fc1-481e-a187-587edada5776.csv\",\n \"resultGeneratedAt\": 1662555513000,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799815940242,\n \"startedAt\": 1662555401000,\n \"completedAt\": null\n },\n {\n \"id\": 128,\n \"batchId\": \"2d50ade8-11e1-4909-ad89-b4e002eb8f51\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662555121105_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": 11,\n \"ongoing\": 0,\n \"failed\": 0,\n \"completed\": 11,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662555169739_1662555169739_response.csv\",\n \"resultGeneratedAt\": 1662555170000,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799815939648,\n \"startedAt\": 1662555123000,\n \"completedAt\": null\n },\n {\n \"id\": 124,\n \"batchId\": \"0bcba65a-58d8-454b-8cb8-fab76d571309\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662554777301_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": null,\n \"ongoing\": null,\n \"failed\": null,\n \"completed\": null,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662554962405_0bcba65a-58d8-454b-8cb8-fab76d571309.csv\",\n \"resultGeneratedAt\": null,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799815938865,\n \"startedAt\": 1662554779000,\n \"completedAt\": null\n },\n {\n \"id\": 120,\n \"batchId\": \"f89d2977-93e4-41a6-93c4-943920eacd96\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662554182323_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": null,\n \"ongoing\": null,\n \"failed\": null,\n \"completed\": null,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662554366184_f89d2977-93e4-41a6-93c4-943920eacd96.csv\",\n \"resultGeneratedAt\": null,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799815937704,\n \"startedAt\": 1662554182000,\n \"completedAt\": null\n },\n {\n \"id\": 116,\n \"batchId\": \"f4148cfa-0d95-401d-8b4c-a5e52f93759e\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662553748996_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": null,\n \"ongoing\": null,\n \"failed\": null,\n \"completed\": null,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662553934532_f4148cfa-0d95-401d-8b4c-a5e52f93759e.csv\",\n \"resultGeneratedAt\": null,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799815936764,\n \"startedAt\": 1662553751000,\n \"completedAt\": null\n },\n {\n \"id\": 112,\n \"batchId\": \"fa83813b-12b3-4dde-b094-631cc7557\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662551891704_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": null,\n \"ongoing\": null,\n \"failed\": null,\n \"completed\": null,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662552077613_fa83813b-12b3-4dde-b094-631cc7557b53.csv\",\n \"resultGeneratedAt\": null,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799815933797,\n \"startedAt\": 1662551894000,\n \"completedAt\": null\n },\n {\n \"id\": 108,\n \"batchId\": \"3c937b39-0667-40af-8241-48c86da20e93\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662551457591_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": null,\n \"ongoing\": null,\n \"failed\": null,\n \"completed\": null,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662551502363_3c937b39-0667-40af-8241-48c86da20e93.csv\",\n \"resultGeneratedAt\": null,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799815932902,\n \"startedAt\": 1662551460000,\n \"completedAt\": null\n },\n {\n \"id\": 104,\n \"batchId\": \"568d6284-5348-4007-a349-fdb161000ddc\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662551342791_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": 11,\n \"ongoing\": 0,\n \"failed\": 0,\n \"completed\": 11,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662551386540_568d6284-5348-4007-a349-fdb161000ddc.csv\",\n \"resultGeneratedAt\": 1662551417000,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799815932415,\n \"startedAt\": 1662551345000,\n \"completedAt\": null\n },\n {\n \"id\": 100,\n \"batchId\": \"0756d07d-b4e3-44c8-aa88-ef593f6c7a79\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662551194305_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": 11,\n \"ongoing\": 0,\n \"failed\": 0,\n \"completed\": 11,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662551237558_0756d07d-b4e3-44c8-aa88-ef593f6c7a79.csv\",\n \"resultGeneratedAt\": 1662551332000,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799815931913,\n \"startedAt\": 1662551196000,\n \"completedAt\": null\n },\n {\n \"id\": 99,\n \"batchId\": \"5df60ee5-1384-4fa2-9129-3ff97cdf291b\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662551072705_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": null,\n \"ongoing\": null,\n \"failed\": null,\n \"completed\": null,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": null,\n \"resultGeneratedAt\": null,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799815931659,\n \"startedAt\": 1662551075000,\n \"completedAt\": null\n },\n {\n \"id\": 95,\n \"batchId\": \"34fb9b8c-0306-45e0-a79e-ec8483e884b2\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662483494135_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": 11,\n \"ongoing\": 0,\n \"failed\": 0,\n \"completed\": 11,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662483494861_34fb9b8c-0306-45e0-a79e-ec8483e884b2.csv\",\n \"resultGeneratedAt\": 1662546592000,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799815848649,\n \"startedAt\": 1662483494000,\n \"completedAt\": null\n },\n {\n \"id\": 91,\n \"batchId\": \"7febdf5f-1755-4c93-9d9d-ec5437bcbba7\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662483121908_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": 11,\n \"ongoing\": 0,\n \"failed\": 0,\n \"completed\": 11,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"\\\"https://paymenthub-ee-dev.s3.us-east-2.amazonaws.com/1662483124546_7febdf5f-1755-4c93-9d9d-ec5437bcbba7.csv\\\"\",\n \"resultGeneratedAt\": 1662483239000,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799815847922,\n \"startedAt\": 1662483123000,\n \"completedAt\": null\n },\n {\n \"id\": 87,\n \"batchId\": \"41d14ab5-a0f1-4509-868c-094941ebfb01\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": \"1662481892007_ph-ee-bulk-demo-6.csv\",\n \"totalTransactions\": null,\n \"ongoing\": null,\n \"failed\": null,\n \"completed\": null,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": \"\\\"1662481894276_41d14ab5-a0f1-4509-868c-094941ebfb01\\\"\",\n \"resultGeneratedAt\": null,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799815846020,\n \"startedAt\": 1662481894000,\n \"completedAt\": null\n }\n ],\n \"totalElements\": 79,\n \"totalPages\": 4,\n \"last\": false,\n \"numberOfElements\": 20,\n \"sort\": [\n {\n \"direction\": \"DESC\",\n \"property\": \"startedAt\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": true,\n \"ascending\": false\n }\n ],\n \"first\": false,\n \"size\": 20,\n \"number\": 1\n}" }, { "name": "Get All Batches all query param", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "ibank-usa", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/batches?page=2&size=2&sortedBy=requestFile&sortedOrder=asc", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "batches" ], "query": [ { "key": "page", "value": "2" }, { "key": "size", "value": "2" }, { "key": "sortedBy", "value": "requestFile" }, { "key": "sortedOrder", "value": "asc" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 13 Sep 2022 06:25:13 GMT" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"id\": 7,\n \"batchId\": \"acea70d3-df71-431b-992b-e5f609c62ebf\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": null,\n \"totalTransactions\": null,\n \"ongoing\": null,\n \"failed\": null,\n \"completed\": null,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": null,\n \"resultGeneratedAt\": null,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799819952265,\n \"startedAt\": 1661784518000,\n \"completedAt\": 1661784518000\n },\n {\n \"id\": 8,\n \"batchId\": \"b0a10f54-3efe-4ad5-aceb-700a3c831e60\",\n \"subBatchId\": null,\n \"requestId\": \"3a4dfab5-0f4f-4e78-b6b5-1aff3859d4e8\",\n \"requestFile\": null,\n \"totalTransactions\": null,\n \"ongoing\": null,\n \"failed\": null,\n \"completed\": null,\n \"totalAmount\": null,\n \"ongoingAmount\": null,\n \"failedAmount\": null,\n \"completedAmount\": null,\n \"result_file\": null,\n \"resultGeneratedAt\": null,\n \"note\": null,\n \"workflowKey\": null,\n \"workflowInstanceKey\": 2251799819961213,\n \"startedAt\": 1661785658000,\n \"completedAt\": 1661785658000\n }\n ],\n \"totalElements\": 79,\n \"totalPages\": 40,\n \"last\": false,\n \"numberOfElements\": 2,\n \"sort\": [\n {\n \"direction\": \"ASC\",\n \"property\": \"requestFile\",\n \"ignoreCase\": false,\n \"nullHandling\": \"NATIVE\",\n \"descending\": false,\n \"ascending\": true\n }\n ],\n \"first\": false,\n \"size\": 2,\n \"number\": 2\n}" } ] }, { "name": "Batch Payment Detail", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "User-Agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:90.0) Gecko/20100101 Firefox/90.0", "disabled": true }, { "key": "Accept", "value": "application/json, text/plain, */*", "disabled": true }, { "key": "Accept-Language", "value": "en-US,en;q=0.5", "disabled": true }, { "key": "Platform-TenantId", "value": "{{TenantName}}" }, { "key": "Authorization", "value": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiaWRlbnRpdHktcHJvdmlkZXIiLCJpYmFuay11c2EiXSwic2NvcGUiOlsiaWRlbnRpdHkiXSwiZXhwIjoxNjMyNjY3MjY4LCJhdXRob3JpdGllcyI6WyJBTExfRlVOQ1RJT05TIl0sImp0aSI6InE2bklEMUZSNzlvM1JTK2U2enZVZ2hoa0c2ST0iLCJjbGllbnRfaWQiOiJjaGFubmVsLWliYW5rLXVzYSJ9.pt-az4y6ue2OEh5PIpV8cPkhHFwql_XK8OVRc_31gH-8GLwwZwtG9Q1k16LNxfTG4lsDpPYkJUO7UwabJlDuEfIzQtMhalVY3QwkFKjOr9T77c9esFHsjJ35FfQ5cVEDW3dUgFjF_1l-QsPAD1Nil1JSpYg-tXy8bJaVn1BI8VxYrN713VB-ZOs-eVJC_0zdK8iUHGmbSxuHojfhsj3INvU6vYYzo0u-jCzFfxImrIIFdia8DuL1S6sy4kd2ZM08_NCw_4rzW3hCgL9Yu0u_SfO2iJvh0BsXg4DC8iweBfq8rDqfQNR0Vzew9zCmiynZBWbp3elmkNnZDcVJU3yTww", "disabled": true }, { "key": "Origin", "value": "http://localhost:4200", "disabled": true }, { "key": "Connection", "value": "keep-alive", "disabled": true }, { "key": "Referer", "value": "http://localhost:4200/", "disabled": true }, { "key": "X-Correlation-ID", "value": "{{clientCorrelationId}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/batches/{{batchId}}?associations=all", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "batches", "{{batchId}}" ], "query": [ { "key": "direction", "value": "OUTGOING", "description": "INCOMING or OUTGOING direction", "disabled": true }, { "key": "status", "value": "ONGOING", "description": "Transaction State can be ONGOING, STARTED, FAILED", "disabled": true }, { "key": "associations", "value": "all" }, { "key": "offset", "value": "0", "disabled": true }, { "key": "limit", "value": "10", "disabled": true } ] } }, "response": [ { "name": "Batch Summary", "originalRequest": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:90.0) Gecko/20100101 Firefox/90.0", "disabled": true }, { "key": "Accept", "value": "application/json, text/plain, */*", "disabled": true }, { "key": "Accept-Language", "value": "en-US,en;q=0.5", "disabled": true }, { "key": "Platform-TenantId", "value": "ibank-usa" }, { "key": "Authorization", "value": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiaWRlbnRpdHktcHJvdmlkZXIiLCJpYmFuay11c2EiXSwic2NvcGUiOlsiaWRlbnRpdHkiXSwiZXhwIjoxNjMyNjY3MjY4LCJhdXRob3JpdGllcyI6WyJBTExfRlVOQ1RJT05TIl0sImp0aSI6InE2bklEMUZSNzlvM1JTK2U2enZVZ2hoa0c2ST0iLCJjbGllbnRfaWQiOiJjaGFubmVsLWliYW5rLXVzYSJ9.pt-az4y6ue2OEh5PIpV8cPkhHFwql_XK8OVRc_31gH-8GLwwZwtG9Q1k16LNxfTG4lsDpPYkJUO7UwabJlDuEfIzQtMhalVY3QwkFKjOr9T77c9esFHsjJ35FfQ5cVEDW3dUgFjF_1l-QsPAD1Nil1JSpYg-tXy8bJaVn1BI8VxYrN713VB-ZOs-eVJC_0zdK8iUHGmbSxuHojfhsj3INvU6vYYzo0u-jCzFfxImrIIFdia8DuL1S6sy4kd2ZM08_NCw_4rzW3hCgL9Yu0u_SfO2iJvh0BsXg4DC8iweBfq8rDqfQNR0Vzew9zCmiynZBWbp3elmkNnZDcVJU3yTww" }, { "key": "Origin", "value": "http://localhost:4200", "disabled": true }, { "key": "Connection", "value": "keep-alive", "disabled": true }, { "key": "Referer", "value": "http://localhost:4200/", "disabled": true } ], "url": { "raw": "{{OperationsHostName}}/api/v1/batch?batchId={{batchId}}", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "batch" ], "query": [ { "key": "direction", "value": "OUTGOING", "description": "INCOMING or OUTGOING direction", "disabled": true }, { "key": "status", "value": "ONGOING", "description": "Transaction State can be ONGOING, STARTED, FAILED", "disabled": true }, { "key": "batchId", "value": "{{batchId}}" } ] } }, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"batchId\": \"c02a14f0-5e7e-44a1-88eb-5584a21e6f28\",\n \"requestId\": \"dhgdfe-jiae-ugir-bsjf-ndsdfsdfdfd\",\n \"totalTransactions\": 2,\n \"ongoing\": 2,\n \"failed\": 0,\n \"completed\": 0,\n \"total_amount\": 767,\n \"completed_amount\": 0,\n \"ongoing_amount\": 767,\n \"failed_amount\": 0,\n \"result_file\": null,\n \"resultGeneratedAt\": 1634955667187,\n \"note\": \"Sample Response\"\n}" } ] }, { "name": "Sub Batch Payment Detail", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " pm.expect(pm.response.text).not.equal(null)", "});", "", "if(postman.getEnvironmentVariable(\"AutoTest\") == \"true\"){", " var nextTextIndex = Number(postman.getEnvironmentVariable(\"NextTestIndex\"));", " var apis = pm.environment.get('TestApiList');", " var testList = JSON.parse(apis);", " if(testList.length>nextTextIndex){", " postman.setEnvironmentVariable(\"NextTestIndex\", 1+ nextTextIndex);", " postman.setNextRequest(testList[nextTextIndex]); ", " }else{", " postman.setNextRequest(null); ", " }", "}" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "User-Agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:90.0) Gecko/20100101 Firefox/90.0", "disabled": true }, { "key": "Accept", "value": "application/json, text/plain, */*", "disabled": true }, { "key": "Accept-Language", "value": "en-US,en;q=0.5", "disabled": true }, { "key": "Platform-TenantId", "value": "{{TenantName}}" }, { "key": "Authorization", "value": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiaWRlbnRpdHktcHJvdmlkZXIiLCJpYmFuay11c2EiXSwic2NvcGUiOlsiaWRlbnRpdHkiXSwiZXhwIjoxNjMyNjY3MjY4LCJhdXRob3JpdGllcyI6WyJBTExfRlVOQ1RJT05TIl0sImp0aSI6InE2bklEMUZSNzlvM1JTK2U2enZVZ2hoa0c2ST0iLCJjbGllbnRfaWQiOiJjaGFubmVsLWliYW5rLXVzYSJ9.pt-az4y6ue2OEh5PIpV8cPkhHFwql_XK8OVRc_31gH-8GLwwZwtG9Q1k16LNxfTG4lsDpPYkJUO7UwabJlDuEfIzQtMhalVY3QwkFKjOr9T77c9esFHsjJ35FfQ5cVEDW3dUgFjF_1l-QsPAD1Nil1JSpYg-tXy8bJaVn1BI8VxYrN713VB-ZOs-eVJC_0zdK8iUHGmbSxuHojfhsj3INvU6vYYzo0u-jCzFfxImrIIFdia8DuL1S6sy4kd2ZM08_NCw_4rzW3hCgL9Yu0u_SfO2iJvh0BsXg4DC8iweBfq8rDqfQNR0Vzew9zCmiynZBWbp3elmkNnZDcVJU3yTww", "disabled": true }, { "key": "Origin", "value": "http://localhost:4200", "disabled": true }, { "key": "Connection", "value": "keep-alive", "disabled": true }, { "key": "Referer", "value": "http://localhost:4200/", "disabled": true }, { "key": "X-Correlation-ID", "value": "{{clientCorrelationId}}", "type": "text" } ], "url": { "raw": "{{OperationsHostName}}/api/v1/batches/{{batchId}}}/subBatches/{{subBatchId}}?offset=0&limit=5", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "batches", "{{batchId}}}", "subBatches", "{{subBatchId}}" ], "query": [ { "key": "direction", "value": "OUTGOING", "description": "INCOMING or OUTGOING direction", "disabled": true }, { "key": "status", "value": "ONGOING", "description": "Transaction State can be ONGOING, STARTED, FAILED", "disabled": true }, { "key": "offset", "value": "0" }, { "key": "limit", "value": "5" } ] } }, "response": [ { "name": "Batch Summary", "originalRequest": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:90.0) Gecko/20100101 Firefox/90.0", "disabled": true }, { "key": "Accept", "value": "application/json, text/plain, */*", "disabled": true }, { "key": "Accept-Language", "value": "en-US,en;q=0.5", "disabled": true }, { "key": "Platform-TenantId", "value": "ibank-usa" }, { "key": "Authorization", "value": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiaWRlbnRpdHktcHJvdmlkZXIiLCJpYmFuay11c2EiXSwic2NvcGUiOlsiaWRlbnRpdHkiXSwiZXhwIjoxNjMyNjY3MjY4LCJhdXRob3JpdGllcyI6WyJBTExfRlVOQ1RJT05TIl0sImp0aSI6InE2bklEMUZSNzlvM1JTK2U2enZVZ2hoa0c2ST0iLCJjbGllbnRfaWQiOiJjaGFubmVsLWliYW5rLXVzYSJ9.pt-az4y6ue2OEh5PIpV8cPkhHFwql_XK8OVRc_31gH-8GLwwZwtG9Q1k16LNxfTG4lsDpPYkJUO7UwabJlDuEfIzQtMhalVY3QwkFKjOr9T77c9esFHsjJ35FfQ5cVEDW3dUgFjF_1l-QsPAD1Nil1JSpYg-tXy8bJaVn1BI8VxYrN713VB-ZOs-eVJC_0zdK8iUHGmbSxuHojfhsj3INvU6vYYzo0u-jCzFfxImrIIFdia8DuL1S6sy4kd2ZM08_NCw_4rzW3hCgL9Yu0u_SfO2iJvh0BsXg4DC8iweBfq8rDqfQNR0Vzew9zCmiynZBWbp3elmkNnZDcVJU3yTww" }, { "key": "Origin", "value": "http://localhost:4200", "disabled": true }, { "key": "Connection", "value": "keep-alive", "disabled": true }, { "key": "Referer", "value": "http://localhost:4200/", "disabled": true } ], "url": { "raw": "{{OperationsHostName}}/api/v1/batch?batchId={{batchId}}", "host": [ "{{OperationsHostName}}" ], "path": [ "api", "v1", "batch" ], "query": [ { "key": "direction", "value": "OUTGOING", "description": "INCOMING or OUTGOING direction", "disabled": true }, { "key": "status", "value": "ONGOING", "description": "Transaction State can be ONGOING, STARTED, FAILED", "disabled": true }, { "key": "batchId", "value": "{{batchId}}" } ] } }, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"batchId\": \"c02a14f0-5e7e-44a1-88eb-5584a21e6f28\",\n \"requestId\": \"dhgdfe-jiae-ugir-bsjf-ndsdfsdfdfd\",\n \"totalTransactions\": 2,\n \"ongoing\": 2,\n \"failed\": 0,\n \"completed\": 0,\n \"total_amount\": 767,\n \"completed_amount\": 0,\n \"ongoing_amount\": 767,\n \"failed_amount\": 0,\n \"result_file\": null,\n \"resultGeneratedAt\": 1634955667187,\n \"note\": \"Sample Response\"\n}" } ] } ] }, { "name": "Collection APIs", "item": [ { "name": "Collection Request", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"payer\": [\n {\n \"key\": \"MSISDN\",\n \"value\": \"254708374149\"\n },\n {\n \"key\": \"ACCOUNTID\",\n \"value\": \"24450523\"\n }\n ],\n \"amount\": {\n \"amount\": \"1\",\n \"currency\": \"USD\"\n },\n \"transactionType\": {\n \"scenario\": \"MPESA\",\n \"subScenario\": \"BUYGOODS\",\n \"initiator\": \"PAYEE\",\n \"initiatorType\": \"BUSINESS\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ChannelHostName}}/channel/collection", "host": [ "{{ChannelHostName}}" ], "path": [ "channel", "collection" ] } }, "response": [] } ] }, { "name": "Mpesa APIs", "item": [ { "name": "Mpesa buygoods callback", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"Body\": {\n \"stkCallback\": {\n \"MerchantRequestID\": \"61034-2694171-1\",\n \"CheckoutRequestID\": \"ws_CO_101120211333024994\",\n \"ResultCode\": 1037,\n \"ResultDesc\": \"DS timeout.\"\n },\n \"CallbackMetadata\":{\n \"Item\":[\n {\n \"Name\":\"Amount\",\n \"Value\":10\n },\n {\n \"Name\":\"MpesaReceiptNumber\",\n \"Value\":\"MRLSJHDH9\"\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "http://{{MpesaHostName}}/buygoods/callback", "protocol": "http", "host": [ "{{MpesaHostName}}" ], "path": [ "buygoods", "callback" ] } }, "response": [] } ] }, { "name": "Notifications APIs", "item": [ { "name": "Notifications Callback", "request": { "method": "POST", "header": [ { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"201\",\n \"externalId\": \"SM7b1b75ffa3f5737a\",\n \"deliveredOnDate\": \"2022-01-11\",\n \"deliveryStatus\": 300,\n \"hasError\": false,\n \"errorMessage\": null,\n \"bridgeId\": 2,\n \"tenantId\": 1\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{NotificationsHostName}}/sms/callback", "host": [ "{{NotificationsHostName}}" ], "path": [ "sms", "callback" ] }, "description": "Callback from message gateway" }, "response": [] }, { "name": "Send Message to Message Gateway", "request": { "method": "POST", "header": [ { "key": "Fineract-Platform-TenantId", "value": "default", "type": "text" }, { "key": "Fineract-Tenant-App-Key", "value": "123456543234abdkdkdkd", "type": "text" }, { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"internalId\": \"20\",\n \"mobileNumber\": \"+15005550012\",\n \"message\": \"Random Message\",\n \"providerId\": 2\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{MessagegatewayHostName}}/sms", "host": [ "{{MessagegatewayHostName}}" ], "path": [ "sms" ] } }, "response": [] } ] }, { "name": "Message Gateway APIs", "item": [ { "name": "Message gateway provider callback", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded", "type": "text" }, { "key": "X-CorrelationID", "value": "{{clientCorrelationId}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"CT190322d3246e0a2f\",\n \"contact[conversation_status]\": \"closed\",\n \"contact[id]\": \"CT190322d3246e0a2f\",\n \"contact[incoming_message_count]\": 0,\n \"contact[last_message_id]\": \"SM8edad9e1caf03b04\",\n \"contact[last_message_time]\": 1641306324,\n \"contact[last_outgoing_message_time]\": 1641306324,\n \"contact[message_count]\": 17,\n \"contact[name]\": \"+15005550012\",\n \"contact[outgoing_message_count]\": 17,\n \"contact[phone_number]\": \"+15005550012\",\n \"contact[project_id]\": \"PJ5ff552ce01d2978c\",\n \"contact[send_blocked]\": 0,\n \"contact[time_created]\": 1641227864,\n \"contact[time_updated]\": 1641227864,\n \"content\": \"The transaction for account number:$account for amount:$amount has failed on $date with following transaction id: $transactionid\",\n \"direction\": \"outgoing\",\n \"error_message\": \" \",\n \"event\": \"send_status\",\n \"from_number\": \"555-1212\",\n \"id\": \"SM8edad9e1caf03b04\",\n \"message_type\": \"sms\",\n \"phone_id\": \"PNa2d2c147eb96c34d\",\n \"priority\": 1,\n \"project_id\": \"PJ5ff552ce01d2978c\",\n \"secret\": \" \",\n \"simulated\": 1,\n \"source\": \"api\",\n \"starred\": 0,\n \"status\": \"delivered\",\n \"time_created\": 1641306324,\n \"time_sent\": 1641306324,\n \"time_updated\": 1641306324,\n \"to_number\": \"+15005550012\",\n \"track_clicks\": 0,\n \"user_id\": \"URfabcdb9eb26ca257\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{MessagegatewayHostName}}/telerivet/report/", "host": [ "{{MessagegatewayHostName}}" ], "path": [ "telerivet", "report", "" ] } }, "response": [] } ] }, { "name": "Zeebe Operations APIs", "item": [ { "name": "Start a workflow", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"var1\": \"val1\",\n \"var2\": \"val2\",\n \"var3\": \"val3\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZeebeOpsHostName}}/channel/workflow/{{BpmnProcessId}}", "host": [ "{{ZeebeOpsHostName}}" ], "path": [ "channel", "workflow", "{{BpmnProcessId}}" ] } }, "response": [] }, { "name": "Upload bpmn", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "/Users/ishan/fynarfin/phee/ph-ee-env-labs/orchestration/feel/inbound_transfer_roster-DFSPID.bpmn" } ] }, "url": { "raw": "{{ZeebeOpsHostName}}/zeebe/upload", "host": [ "{{ZeebeOpsHostName}}" ], "path": [ "zeebe", "upload" ] } }, "response": [] }, { "name": "Bulk cancellation of active process", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"processId\": [123, 456, 789]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZeebeOpsHostName}}/channel/workflow/", "host": [ "{{ZeebeOpsHostName}}" ], "path": [ "channel", "workflow", "" ] } }, "response": [ { "name": "Bulk cancellation of active process", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"processId\": [123, 456, 789]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "localhost:5000/channel/workflow/", "host": [ "localhost" ], "port": "5000", "path": [ "channel", "workflow", "" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Accept", "value": "*/*" }, { "key": "Postman-Token", "value": "9243b64b-7c57-443f-91fc-c1ec0ee18e68" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Accept-Encoding", "value": "gzip, deflate, br" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "87" }, { "key": "User-Agent", "value": "PostmanRuntime/7.28.4" }, { "key": "Date", "value": "Wed, 13 Oct 2021 18:54:34 GMT" } ], "cookie": [], "body": "{\n \"cancellationSuccessful\": 0,\n \"cancellationFailed\": 3,\n \"success\": [],\n \"failed\": [\n 123,\n 456,\n 789\n ]\n}" } ] }, { "name": "Check ES health", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZeebeOpsHostName}}/es/health", "host": [ "{{ZeebeOpsHostName}}" ], "path": [ "es", "health" ] } }, "response": [ { "name": "Status-Down", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "localhost:5000/es/health", "host": [ "localhost" ], "port": "5000", "path": [ "es", "health" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "Accept", "value": "*/*" }, { "key": "Postman-Token", "value": "87609590-28a6-4713-b58a-329444239d6a" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Accept-Encoding", "value": "gzip, deflate, br" }, { "key": "Content-Length", "value": "47" }, { "key": "User-Agent", "value": "PostmanRuntime/7.28.4" }, { "key": "Date", "value": "Wed, 13 Oct 2021 18:57:37 GMT" } ], "cookie": [], "body": "{\"reason\":\"Connection refused\",\"status\":\"down\"}" }, { "name": "Status-UP", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "localhost:5000/es/health", "host": [ "localhost" ], "port": "5000", "path": [ "es", "health" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "Accept", "value": "*/*" }, { "key": "Postman-Token", "value": "685f2f41-459f-4d8d-aa3d-b6ecf5bf545f" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Accept-Encoding", "value": "gzip, deflate, br" }, { "key": "Content-Length", "value": "15" }, { "key": "User-Agent", "value": "PostmanRuntime/7.28.4" }, { "key": "Date", "value": "Wed, 13 Oct 2021 18:55:51 GMT" } ], "cookie": [], "body": "{\"status\":\"UP\"}" } ] }, { "name": "Get process definition key and name", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZeebeOpsHostName}}/channel/process", "host": [ "{{ZeebeOpsHostName}}" ], "path": [ "channel", "process" ] } }, "response": [ { "name": "Get process definition key and name", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "localhost:5000/channel/process", "host": [ "localhost" ], "port": "5000", "path": [ "channel", "process" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "Accept", "value": "*/*" }, { "key": "Postman-Token", "value": "80c6f388-c4c2-4774-afdb-6268bff4ebfd" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Accept-Encoding", "value": "gzip, deflate, br" }, { "key": "Content-Length", "value": "416" }, { "key": "User-Agent", "value": "PostmanRuntime/7.28.4" }, { "key": "Date", "value": "Wed, 13 Oct 2021 18:59:27 GMT" } ], "cookie": [], "body": "{\"bulk_processor-ibank-usa\":[2251799813685998,2251799814125425],\"international_remittance_payee_process-ibank-india\":[2251799813686276,2251799814069864],\"international_remittance_payer_process-ibank-usa\":[2251799813686414,2251799814069794],\"international_remittance_payer_process-ibank-india\":[2251799813686138,2251799814070206],\"international_remittance_payee_process-ibank-usa\":[2251799813686068,2251799814070344]}" } ] }, { "name": "Cancel a workflow by state and retires", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"state\": \"Activity_1m5hpl9\",\n \"retries\": 12\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZeebeOpsHostName}}/channel/workflow/cancel", "host": [ "{{ZeebeOpsHostName}}" ], "path": [ "channel", "workflow", "cancel" ] } }, "response": [] }, { "name": "Cancel a process by variable name and value", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"key\": \"initiatorFspId\",\n \"value\": \"\\\"ibank-usa\\\"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ZeebeOpsHostName}}/channel/workflow/cancelbyvalue", "host": [ "{{ZeebeOpsHostName}}" ], "path": [ "channel", "workflow", "cancelbyvalue" ] } }, "response": [] }, { "name": "Get process variable by process instance key", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZeebeOpsHostName}}/channel/process/variable/{{ProcessInstanceKey}}", "host": [ "{{ZeebeOpsHostName}}" ], "path": [ "channel", "process", "variable", "{{ProcessInstanceKey}}" ] } }, "response": [ { "name": "Get process variable by process instance key", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "localhost:5000/channel/process/variable/2251799813783649", "host": [ "localhost" ], "port": "5000", "path": [ "channel", "process", "variable", "2251799813783649" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "plain", "header": [ { "key": "Accept", "value": "*/*" }, { "key": "Postman-Token", "value": "fa223624-7661-43b5-a525-ea5c3691bc09" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Accept-Encoding", "value": "gzip, deflate, br" }, { "key": "Content-Length", "value": "1416" }, { "key": "PROCESS_INSTANCE_KEY", "value": "2251799813783649" }, { "key": "User-Agent", "value": "PostmanRuntime/7.28.4" }, { "key": "Date", "value": "Wed, 13 Oct 2021 19:06:47 GMT" } ], "cookie": [], "body": "{\"transactionType\":\"\\\"inttransfer\\\"\",\"gsmaChannelRequest\":\"\\\"{\\\\\\\"amount\\\\\\\":\\\\\\\"54\\\\\\\",\\\\\\\"currency\\\\\\\":\\\\\\\"USD\\\\\\\",\\\\\\\"type\\\\\\\":\\\\\\\"transfer\\\\\\\",\\\\\\\"debitParty\\\\\\\":[{\\\\\\\"key\\\\\\\":\\\\\\\"msisdn\\\\\\\",\\\\\\\"value\\\\\\\":\\\\\\\"7543010\\\\\\\"}],\\\\\\\"creditParty\\\\\\\":[{\\\\\\\"key\\\\\\\":\\\\\\\"msisdn\\\\\\\",\\\\\\\"value\\\\\\\":\\\\\\\"919900878571\\\\\\\"}],\\\\\\\"requestingLei\\\\\\\":\\\\\\\"ibank-usa\\\\\\\",\\\\\\\"receivingLei\\\\\\\":\\\\\\\"ibank-india\\\\\\\",\\\\\\\"internationalTransferInformation\\\\\\\":{\\\\\\\"originCountry\\\\\\\":\\\\\\\"US\\\\\\\",\\\\\\\"receivingCountry\\\\\\\":\\\\\\\"IN\\\\\\\",\\\\\\\"receivingCurrency\\\\\\\":\\\\\\\"INR\\\\\\\",\\\\\\\"senderCurrency\\\\\\\":\\\\\\\"USD\\\\\\\",\\\\\\\"currencyPair\\\\\\\":\\\\\\\"USD/INR\\\\\\\",\\\\\\\"currencyPairRate\\\\\\\":\\\\\\\"70\\\\\\\",\\\\\\\"receivingAmount\\\\\\\":\\\\\\\"3780\\\\\\\"}}\\\"\",\"partyLookupFspId\":\"\\\"ibank-india\\\"\",\"channelRequest\":\"\\\"{\\\\\\\"payer\\\\\\\":{\\\\\\\"partyIdInfo\\\\\\\":{\\\\\\\"partyIdType\\\\\\\":\\\\\\\"MSISDN\\\\\\\",\\\\\\\"partyIdentifier\\\\\\\":\\\\\\\"7543010\\\\\\\"}},\\\\\\\"payee\\\\\\\":{\\\\\\\"partyIdInfo\\\\\\\":{\\\\\\\"partyIdType\\\\\\\":\\\\\\\"MSISDN\\\\\\\",\\\\\\\"partyIdentifier\\\\\\\":\\\\\\\"919900878571\\\\\\\"}},\\\\\\\"amount\\\\\\\":{\\\\\\\"amount\\\\\\\":\\\\\\\"54\\\\\\\",\\\\\\\"currency\\\\\\\":\\\\\\\"USD\\\\\\\"},\\\\\\\"transactionType\\\\\\\":{\\\\\\\"scenario\\\\\\\":\\\\\\\"TRANSFER\\\\\\\",\\\\\\\"initiator\\\\\\\":\\\\\\\"PAYER\\\\\\\",\\\\\\\"initiatorType\\\\\\\":\\\\\\\"CONSUMER\\\\\\\"}}\\\"\",\"isRtpRequest\":\"false\",\"tenantId\":\"\\\"ibank-usa\\\"\",\"initiatorFspId\":\"\\\"ibank-usa\\\"\",\"partyIdType\":\"\\\"MSISDN\\\"\",\"partyId\":\"\\\"919900878571\\\"\",\"originDate\":\"1633441154238\",\"transactionId\":\"\\\"ae75a455-4a09-477f-8e5a-9c1ac4747a5f\\\"\"}" } ] }, { "name": "Get list of task that are already executed by process definition key", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZeebeOpsHostName}}/channel/process/{{ProcessDefinitionKey}}/task/", "host": [ "{{ZeebeOpsHostName}}" ], "path": [ "channel", "process", "{{ProcessDefinitionKey}}", "task", "" ] } }, "response": [] }, { "name": "Get process current state and variable by process instance id", "request": { "method": "GET", "header": [], "url": { "raw": "{{ZeebeOpsHostName}}/channel/process/{{ProcessInstanceId}}", "host": [ "{{ZeebeOpsHostName}}" ], "path": [ "channel", "process", "{{ProcessInstanceId}}" ] } }, "response": [] }, { "name": "Cancel a workflow by workflow instance key", "request": { "method": "POST", "header": [], "url": { "raw": "{{ZeebeOpsHostName}}/channel/workflow/{{WorkflowInstanceKey}}/cancel", "host": [ "{{ZeebeOpsHostName}}" ], "path": [ "channel", "workflow", "{{WorkflowInstanceKey}}", "cancel" ] } }, "response": [] } ] }, { "name": "Paybill APIs", "item": [ { "name": "Validation", "item": [ { "name": "MPESA-Connector Validiate Webhook", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"TransactionType\":\"Pay Bill\",\n \"TransID\":\"8335b60090979AvUefSR\",\n \"TransTime\":\"20191122063845\",\n \"TransAmount\":\"1\",\n \"BusinessShortCode\":\"24322607\",\n \"BillRefNumber\":\"24322607\",\n \"InvoiceNumber\":\"\",\n \"OrgAccountBalance\":\"49197.00\",\n \"ThirdPartyTransID\":\"\",\n \"MSISDN\":\"254797668592\",\n \"FirstName\":\"John\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{MpesaHostName}}/validation", "host": [ "{{MpesaHostName}}" ], "path": [ "validation" ] }, "description": "BillRefNo : (primaryIdentifier) \n Paygops - foundationalId - 24322607 \n Roster - accountId - 33272035\n\nMSISDN : \nPaygops - 254797668592 \nRoster - 2540726839144\n\nTransactionID: \nPaygops - “8335b60090979AvUefSR” \nRoster - “670d65bd-4efd-4a6c-ae2c-7fdaa8cb4d60\"" }, "response": [] } ] }, { "name": "Confirmation", "item": [ { "name": "MPESA-Connector Confirmation Webhook", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", " pm.expect(pm.response.text).not.equal(null)", "});", "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"TransactionType\":\"Pay Bill\",\n \"TransID\":\"8335b60090979AvUefSR\",\n \"TransTime\":\"20191122063845\",\n \"TransAmount\":\"1\",\n \"BusinessShortCode\":\"24322607\",\n \"BillRefNumber\":\"24322607\",\n \"InvoiceNumber\":\"\",\n \"OrgAccountBalance\":\"49197\",\n \"ThirdPartyTransID\":\"\",\n \"MSISDN\":\"254797668592\",\n \"FirstName\":\"John\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{MpesaHostName}}/confirmation", "host": [ "{{MpesaHostName}}" ], "path": [ "confirmation" ] } }, "response": [] } ] } ], "description": "Design Document: [https://www.notion.so/PayBill-Design-2670e8fac37a485eaac659ba942683ce](https://www.notion.so/PayBill-Design-2670e8fac37a485eaac659ba942683ce)" }, { "name": "Identity Account Mapper", "item": [ { "name": "Register Beneficiary", "request": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"27713803912\",\n \"paymentModality\": \"01\",\n \"financialAddress\": \"589\",\n \"bankingInstitutionCode\": \"gorilla\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/beneficiary", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "beneficiary" ] } }, "response": [ { "name": "Callback request body", "originalRequest": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"27713803912\",\n \"paymentModality\": \"01\",\n \"financialAddress\": \"589\",\n \"bankingInstitutionCode\": \"gorilla\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/beneficiary", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "beneficiary" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 05:07:11 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "x-registering-institution-id" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"requestID\": \"171073978834\",\n \"registerRequestID\": \"915251236700\",\n \"numberFailedCases\": 0,\n \"failedCases\": []\n}" }, { "name": "Register Beneficiary Already Exist", "originalRequest": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"27713803912\",\n \"paymentModality\": \"01\",\n \"financialAddress\": \"589\",\n \"bankingInstitutionCode\": \"gorilla\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/beneficiary", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "beneficiary" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"requestID\": \"171073977096\",\n \"registerRequestID\": \"915251236700\",\n \"numberFailedCases\": 1,\n \"failedCases\": [\n {\n \"payeeIdentity\": \"27713803912\",\n \"paymentModality\": \"01\",\n \"failureReason\": \"Beneficiary already registered\"\n }\n ]\n}" }, { "name": "Register Beneficiary 202", "originalRequest": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"27713803912\",\n \"paymentModality\": \"01\",\n \"financialAddress\": \"589\",\n \"bankingInstitutionCode\": \"gorilla\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/beneficiary", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "beneficiary" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 08:32:21 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "x-registering-institution-id" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"915251236706\"\n}" } ] }, { "name": "Update Beneficiary", "request": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"27713803912\",\n \"paymentModality\": \"00\",\n \"financialAddress\": \"1233456\",\n \"bankingInstitutionCode\": \"gorilla\"\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/beneficiary", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "beneficiary" ] } }, "response": [ { "name": "Callback request body", "originalRequest": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"27713803912\",\n \"paymentModality\": \"00\",\n \"financialAddress\": \"1233456\",\n \"bankingInstitutionCode\": \"gorilla\"\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/beneficiary", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "beneficiary" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 05:06:54 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "x-registering-institution-id" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"requestID\": \"171073988979\",\n \"registerRequestID\": \"915251236706\",\n \"numberFailedCases\": 0,\n \"failedCases\": []\n}" }, { "name": "Update Beneficiary Beneficiary not Registered", "originalRequest": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"27713803912\",\n \"paymentModality\": \"00\",\n \"financialAddress\": \"1233456\",\n \"bankingInstitutionCode\": \"gorilla\"\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/beneficiary", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "beneficiary" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "{\n \"requestID\": \"171074375685\",\n \"registerRequestID\": \"915251236706\",\n \"numberFailedCases\": 1,\n \"failedCases\": [\n {\n \"payeeIdentity\": \"27713803902\",\n \"paymentModality\": \"00\",\n \"failureReason\": \"Beneficiary is not registered\"\n }\n ]\n}" }, { "name": "Update Beneficiary 202", "originalRequest": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"27713803912\",\n \"paymentModality\": \"00\",\n \"financialAddress\": \"1233456\",\n \"bankingInstitutionCode\": \"gorilla\"\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/beneficiary", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "beneficiary" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 08:32:58 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "x-registering-institution-id" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"915251236706\"\n}" } ] }, { "name": "Batch Account Lookup", "request": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"9404916971482891259\"\n },\n {\n \"payeeIdentity\": \"76032553265657618183\"\n },\n {\n \"payeeIdentity\": \"51498584148040549461\"\n },\n {\n \"payeeIdentity\": \"69028769626982342710\"\n },\n {\n \"payeeIdentity\": \"690287696269444382342710\"\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/accountLookup", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "accountLookup" ] } }, "response": [ { "name": "Callback request body", "originalRequest": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"9404916971482891259\"\n },\n {\n \"payeeIdentity\": \"76032553265657618183\"\n },\n {\n \"payeeIdentity\": \"51498584148040549461\"\n },\n {\n \"payeeIdentity\": \"69028769626982342710\"\n },\n {\n \"payeeIdentity\": \"690287696269444382342710\"\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/accountLookup", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "accountLookup" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 05:06:37 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "x-registering-institution-id" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"915251236706\"\n}" }, { "name": "Batch Account Lookup 202", "originalRequest": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"27713803912\"\n },\n {\n \"payeeIdentity\": \"76032553265657618183\"\n },\n {\n \"payeeIdentity\": \"51498584148040549461\"\n },\n {\n \"payeeIdentity\": \"69028769626982342710\"\n },\n {\n \"payeeIdentity\": \"690287696269444382342710\"\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/accountLookup", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "accountLookup" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 08:34:34 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "x-registering-institution-id" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"915251236706\"\n}" } ] }, { "name": "Account Lookup", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "SocialWelfare", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/beneficiary/?payeeIdentity=63310590323322234956&requestId=12345667987&paymentModality=00", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "beneficiary", "" ], "query": [ { "key": "payeeIdentity", "value": "63310590323322234956" }, { "key": "requestId", "value": "12345667987" }, { "key": "paymentModality", "value": "00" } ] } }, "response": [ { "name": "Account Lookup", "originalRequest": { "method": "GET", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "SocialWelfare", "type": "text" } ], "url": { "raw": "{{IdentityAccountMapperHostName}}/beneficiary/?payeeIdentity=63310590323322234956&requestId=12345667987&paymentModality=00", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "beneficiary", "" ], "query": [ { "key": "payeeIdentity", "value": "63310590323322234956" }, { "key": "requestId", "value": "12345667987" }, { "key": "paymentModality", "value": "00" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 05:06:23 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "x-registering-institution-id" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"12345667987\"\n}" } ] }, { "name": "Fetch All Beneficiaries", "request": { "method": "GET", "header": [ { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "url": { "raw": "{{IdentityAccountMapperHostName}}/beneficiaries?page=10&pageSize=5", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "beneficiaries" ], "query": [ { "key": "page", "value": "10" }, { "key": "pageSize", "value": "5" } ] } }, "response": [ { "name": "Fetch All Beneficiaries", "originalRequest": { "method": "GET", "header": [ { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "url": { "raw": "{{IdentityAccountMapperHostName}}/beneficiaries?page=10&pageSize=5", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "beneficiaries" ], "query": [ { "key": "page", "value": "10" }, { "key": "pageSize", "value": "5" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 05:06:04 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "x-registering-institution-id" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"content\": [],\n \"pageable\": {\n \"sort\": {\n \"empty\": true,\n \"unsorted\": true,\n \"sorted\": false\n },\n \"offset\": 50,\n \"pageNumber\": 10,\n \"pageSize\": 5,\n \"paged\": true,\n \"unpaged\": false\n },\n \"totalElements\": 1,\n \"totalPages\": 1,\n \"last\": true,\n \"size\": 5,\n \"number\": 10,\n \"sort\": {\n \"empty\": true,\n \"unsorted\": true,\n \"sorted\": false\n },\n \"numberOfElements\": 0,\n \"first\": false,\n \"empty\": true\n}" } ] }, { "name": "Fetch Beneficiaries", "request": { "method": "GET", "header": [ { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "url": { "raw": "{{IdentityAccountMapperHostName}}/beneficiaries/{{payeeIdentity}}", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "beneficiaries", "{{payeeIdentity}}" ] } }, "response": [ { "name": "Fetch Beneficiaries", "originalRequest": { "method": "GET", "header": [ { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "url": { "raw": "{{IdentityAccountMapperHostName}}/beneficiaries/{{payeeIdentity}}", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "beneficiaries", "{{payeeIdentity}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 05:05:51 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "x-registering-institution-id" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"registeringInstitutionId\": \"123\",\n \"payeeIdentity\": \"3001003873110196\",\n \"paymentModality\": null,\n \"financialAddress\": null,\n \"bankingInstitutionCode\": null\n}" } ] }, { "name": "Add Payment Modality", "request": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"27713803912\",\n \"paymentModality\": \"00\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/paymentModality", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "paymentModality" ] } }, "response": [ { "name": "Add Payment Modality", "originalRequest": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"27713803912\",\n \"paymentModality\": \"00\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/paymentModality", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "paymentModality" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 05:05:30 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "x-registering-institution-id" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"requestID\": \"171074009205\",\n \"registerRequestID\": \"915251236706\",\n \"numberFailedCases\": 1,\n \"failedCases\": [\n {\n \"payeeIdentity\": \"27713803912\",\n \"paymentModality\": \"00\",\n \"failureReason\": \"Banking Institution Code Invalid\"\n }\n ]\n}" } ] }, { "name": "Update Payment Modality", "request": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"51498584148040549461\",\n \"paymentModality\": \"00\",\n \"financialAddress\": \"998LB283697636447147812564357\"\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/paymentModality", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "paymentModality" ] } }, "response": [ { "name": "Failed Update Payment Modality", "originalRequest": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"915251236706\",\n \"beneficiaries\": [\n {\n \"payeeIdentity\": \"51498584148040549461\",\n \"paymentModality\": \"00\",\n \"financialAddress\": \"998LB283697636447147812564357\"\n }\n ]\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{IdentityAccountMapperHostName}}/paymentModality", "host": [ "{{IdentityAccountMapperHostName}}" ], "path": [ "paymentModality" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 05:05:11 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "x-registering-institution-id" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"requestID\": \"171074011382\",\n \"registerRequestID\": \"915251236706\",\n \"numberFailedCases\": 1,\n \"failedCases\": [\n {\n \"payeeIdentity\": \"51498584148040549461\",\n \"paymentModality\": \"00\",\n \"failureReason\": \"Beneficiary is not registered\"\n }\n ]\n}" } ] } ] }, { "name": "Voucher Management", "item": [ { "name": "Create Voucher", "request": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"instructionID\": \"1202383344325434\",\n \"groupCode\": \"021\",\n \"currency\": \"USD\",\n \"amount\": 5009,\n \"payeeFunctionalID\": \"63310590322288932633\",\n \"narration\": \"Social Support Payment for the Month of Jan\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ] } }, "response": [ { "name": "Sample response 202", "originalRequest": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"instructionID\": \"1202383344325434\",\n \"groupCode\": \"021\",\n \"currency\": \"USD\",\n \"amount\": 5009,\n \"payeeFunctionalID\": \"63310590322288932633\",\n \"narration\": \"Social Support Payment for the Month of Jan\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"849324499155\"\n}" }, { "name": "Callback request body", "originalRequest": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"instructionID\": \"1202383344325434\",\n \"groupCode\": \"021\",\n \"currency\": \"USD\",\n \"amount\": 5009,\n \"payeeFunctionalID\": \"63310590322288932633\",\n \"narration\": \"Social Support Payment for the Month of Jan\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"instructionID\": \"1202383344325434\",\n \"currency\": \"USD\",\n \"amount\": 5009,\n \"narration\": \"Social Support Payment for the Month of Jan\",\n \"voucherNumber\": \"f3ONmzIfROhCCHZiAFXATQHqm2/tJjuh0ozax0ycaJp+rE32Cm4r2Ub8xIpE2AEXvvvG/42bB/DlVUbF2Fe1NQHF7HHBQPV0TMUy0AbIfE7ihf3Qp6DMsd2z2ffyKdo0KpRY8x25lZSB/D1wUM96KsdPR1OB4zyDOag+zSIZbJIbLD+jRWkzw8pJp0X7x5RtRrh4KD5gwR3M6RNA7Hpd+eYzUo2SsPx82QLHi1Vx1l79f3JFpPmc0lhdrfzbEZQQAk/6z2dj2aw89XaBOZsZXy751E9xJQGXtiitA8m9mIrFYZ3iQoWzbSIzFEygM6sIbJASgrm+YvYesWUP/pcmXw==\",\n \"serialNumber\": \"17123246904971\"\n }\n ]\n}" } ] }, { "name": "Activate Voucher", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"serialNumber\": \"16939790248654\",\n \"status\": \"02\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=activate", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "activate" } ] } }, "response": [ { "name": "Sample response 202", "originalRequest": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"serialNumber\": \"16939790248654\",\n \"status\": \"02\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=activate", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "activate" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"849324499155\"\n}" }, { "name": "Callback request body", "originalRequest": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"serialNumber\": \"16939790248654\",\n \"status\": \"02\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=activate", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "activate" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"requestID\": \"171232475311\",\n \"registerRequestID\": \"849324499155\",\n \"numberFailedCases\": 0,\n \"failedCases\": []\n}" } ] }, { "name": "Suspend Voucher", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"serialNumber\": \"16895906640276\",\n \"status\": \"06\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=suspend", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "suspend" } ] } }, "response": [ { "name": "Sample response 202", "originalRequest": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"serialNumber\": \"16895906640276\",\n \"status\": \"06\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=suspend", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "suspend" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"849324499155\"\n}" }, { "name": "Callback request body", "originalRequest": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"serialNumber\": \"16895906640276\",\n \"status\": \"06\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=suspend", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "suspend" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"requestID\": \"171232493718\",\n \"registerRequestID\": \"849324499155\",\n \"numberFailedCases\": 0,\n \"failedCases\": []\n}" } ] }, { "name": "Cancel Voucher", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"serialNumber\": \"16895845478866\",\n \"status\": \"03\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=cancel", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "cancel" } ] } }, "response": [ { "name": "Sample response 202", "originalRequest": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"serialNumber\": \"16895845478866\",\n \"status\": \"03\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=cancel", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "cancel" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"849324499155\"\n}" }, { "name": "Callback request body", "originalRequest": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"serialNumber\": \"16895845478866\",\n \"status\": \"03\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=cancel", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "cancel" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"requestID\": \"171232511656\",\n \"registerRequestID\": \"849324499155\",\n \"numberFailedCases\": 0,\n \"failedCases\": []\n}" } ] }, { "name": "Reactivate Voucher", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"serialNumber\": \"16895906640276\",\n \"status\": \"02\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=reactivate", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "reactivate" } ] } }, "response": [ { "name": "Sample response 202", "originalRequest": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"serialNumber\": \"16895906640276\",\n \"status\": \"02\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=reactivate", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "reactivate" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"849324499155\"\n}" }, { "name": "Sample request body", "originalRequest": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestID\": \"849324499155\",\n \"batchID\": \"045155518258\",\n \"voucherInstructions\": [\n {\n \"serialNumber\": \"16895906640276\",\n \"status\": \"02\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=reactivate", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "reactivate" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"requestID\": \"171233278011\",\n \"registerRequestID\": \"849324499155\",\n \"numberFailedCases\": 0,\n \"failedCases\": []\n}" } ] }, { "name": "Redeem Voucher", "request": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestId\": \"849324499155\",\n \"agentId\": \"1234567890\",\n \"voucherSecretNumber\": \"168959066402710531\"\n }\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=redeem", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "redeem" } ] } }, "response": [ { "name": "Sample response 202", "originalRequest": { "method": "POST", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestId\": \"849324499155\",\n \"agentId\": \"1234567890\",\n \"voucherSecretNumber\": \"168959066402710531\"\n }\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=redeem", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "redeem" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"01\",\n \"message\": \"Voucher redemption successful!\",\n \"serialNumber\": \"H8cTUUhlO/JIqFCRZdfyeIbtxeWvzO5++5xtj+r9wcALoOnP17mG5tYThRROkWBFrW2O4xYjtuZsV9VCQk+4VrTgzwA8uafbWZQh6hppHx7zgrwJ7E/YiC6MZriMvp4vHIFSruYFbKOt5gr3RGkNFAl1xD9wTY3n0g381/qZSSAWA8ODByt61nZLyNH91of4wHyzYtCJuFCBx3UKKhICenv1XJ4FaKUKrWYyFPCMN24DIDprwzY5aAKFRucXKYK2XG4UkyJQe7lRvDfmOo/jzGtz2LmxtsgltJYvGqglZx3Q0k4zmJUkopB4O5edAb4bMzuny3zPsbqTyk2CF/GWtQ==\",\n \"value\": \"5009.00\",\n \"timestamp\": \"2024-04-05T16:01:24.271818174\",\n \"transactionId\": \"1712332884\"\n}" } ] }, { "name": "Redeem and Pay Voucher", "request": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestId\": \"849324499155\",\n \"agentId\": \"1234567890\",\n \"voucherSecretNumber\": \"168975377470710722\"\n }\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=redeemPay", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "redeemPay" } ] } }, "response": [ { "name": "Sample response 202", "originalRequest": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestId\": \"849324499155\",\n \"agentId\": \"1234567890\",\n \"voucherSecretNumber\": \"168975377470710722\"\n }\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=redeemPay", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "redeemPay" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"849324499155\"\n}" }, { "name": "Sample request body", "originalRequest": { "method": "PUT", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"requestId\": \"849324499155\",\n \"agentId\": \"1234567890\",\n \"voucherSecretNumber\": \"168975377470710722\"\n }\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?command=redeemPay", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "command", "value": "redeemPay" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"requestID\": \"171233306861\",\n \"registerRequestID\": \"849324499155\",\n \"numberFailedCases\": 0,\n \"failedCases\": []\n}" } ] }, { "name": "Check Validity", "request": { "method": "GET", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "url": { "raw": "{{VoucherManagementHostName}}/voucher/validity?isValid=true&serialNumber=16939790248654", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "voucher", "validity" ], "query": [ { "key": "isValid", "value": "true" }, { "key": "voucherNumber", "value": "ffds", "disabled": true }, { "key": "groupCode", "value": "fsfsfd", "disabled": true }, { "key": "serialNumber", "value": "16939790248654" } ] } }, "response": [ { "name": "Sample response 202", "originalRequest": { "method": "GET", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "url": { "raw": "{{VoucherManagementHostName}}/voucher/validity?isValid=true&serialNumber=16939790248654", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "voucher", "validity" ], "query": [ { "key": "isValid", "value": "true" }, { "key": "voucherNumber", "value": "ffds", "disabled": true }, { "key": "groupCode", "value": "fsfsfd", "disabled": true }, { "key": "serialNumber", "value": "16939790248654" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"\"\n}\n" }, { "name": "Callback request body", "originalRequest": { "method": "GET", "header": [ { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "url": { "raw": "{{VoucherManagementHostName}}/voucher/validity?isValid=true&serialNumber=16939790248654", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "voucher", "validity" ], "query": [ { "key": "isValid", "value": "true" }, { "key": "voucherNumber", "value": "ffds", "disabled": true }, { "key": "groupCode", "value": "fsfsfd", "disabled": true }, { "key": "serialNumber", "value": "16939790248654" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "{\n \"serialNumber\": \"17098827605447\",\n \"isValid\": true\n}" } ] }, { "name": "Fetch Vouchers", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers/{{voucherNumber}}", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers", "{{voucherNumber}}" ] } }, "response": [ { "name": "Sample response 202", "originalRequest": { "method": "GET", "header": [ { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "url": { "raw": "{{VoucherManagementHostName}}/vouchers/{{voucherNumber}}", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers", "{{voucherNumber}}" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"serialNumber\": \"17098827605447\",\n \"createdDate\": \"2024-03-08T07:26:01\",\n \"registeringInstitutionId\": \"123\",\n \"status\": \"02\",\n \"payeeFunctionalID\": \"63310590322288932682\"\n}" } ] }, { "name": "Fetch All Vouchers", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{VoucherManagementHostName}}/vouchers?page=0&size=10", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "10" } ] } }, "response": [ { "name": "Sample response 202", "originalRequest": { "method": "GET", "header": [ { "key": "X-Registering-Institution-ID", "value": "{{X-Registering-Institution-ID}}", "type": "text" } ], "url": { "raw": "{{VoucherManagementHostName}}/vouchers?page=0&size=10", "host": [ "{{VoucherManagementHostName}}" ], "path": [ "vouchers" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "10" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"content\": [\n {\n \"serialNumber\": \"17098827605447\",\n \"createdDate\": \"2024-03-08T07:26:01\",\n \"registeringInstitutionId\": \"123\",\n \"status\": \"02\",\n \"payeeFunctionalID\": \"63310590322288932682\"\n },\n {\n \"serialNumber\": \"17098827614621\",\n \"createdDate\": \"2024-03-08T07:26:01\",\n \"registeringInstitutionId\": \"123\",\n \"status\": \"02\",\n \"payeeFunctionalID\": \"63310590322288932682\"\n },\n {\n \"serialNumber\": \"17098827623176\",\n \"createdDate\": \"2024-03-08T07:26:02\",\n \"registeringInstitutionId\": \"123\",\n \"status\": \"02\",\n \"payeeFunctionalID\": \"63310590322288932682\"\n },\n {\n \"serialNumber\": \"17098827631581\",\n \"createdDate\": \"2024-03-08T07:26:03\",\n \"registeringInstitutionId\": \"123\",\n \"status\": \"02\",\n \"payeeFunctionalID\": \"63310590322288932682\"\n },\n {\n \"serialNumber\": \"17098827640378\",\n \"createdDate\": \"2024-03-08T07:26:04\",\n \"registeringInstitutionId\": \"123\",\n \"status\": \"02\",\n \"payeeFunctionalID\": \"63310590322288932682\"\n },\n {\n \"serialNumber\": \"17098827649245\",\n \"createdDate\": \"2024-03-08T07:26:05\",\n \"registeringInstitutionId\": \"123\",\n \"status\": \"02\",\n \"payeeFunctionalID\": \"63310590322288932682\"\n },\n {\n \"serialNumber\": \"17098827658061\",\n \"createdDate\": \"2024-03-08T07:26:06\",\n \"registeringInstitutionId\": \"123\",\n \"status\": \"02\",\n \"payeeFunctionalID\": \"63310590322288932682\"\n },\n {\n \"serialNumber\": \"17098828235054\",\n \"createdDate\": \"2024-03-08T07:27:04\",\n \"registeringInstitutionId\": \"123\",\n \"status\": \"02\",\n \"payeeFunctionalID\": \"63310590322288932682\"\n },\n {\n \"serialNumber\": \"17098828244473\",\n \"createdDate\": \"2024-03-08T07:27:04\",\n \"registeringInstitutionId\": \"123\",\n \"status\": \"02\",\n \"payeeFunctionalID\": \"63310590322288932682\"\n },\n {\n \"serialNumber\": \"17098828254959\",\n \"createdDate\": \"2024-03-08T07:27:05\",\n \"registeringInstitutionId\": \"123\",\n \"status\": \"02\",\n \"payeeFunctionalID\": \"63310590322288932682\"\n }\n ],\n \"pageable\": {\n \"sort\": {\n \"empty\": true,\n \"unsorted\": true,\n \"sorted\": false\n },\n \"offset\": 0,\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"unpaged\": false,\n \"paged\": true\n },\n \"totalPages\": 103,\n \"totalElements\": 1029,\n \"last\": false,\n \"size\": 10,\n \"number\": 0,\n \"sort\": {\n \"empty\": true,\n \"unsorted\": true,\n \"sorted\": false\n },\n \"numberOfElements\": 10,\n \"first\": true,\n \"empty\": false\n}" } ] } ] }, { "name": "Bill Pay APIs", "item": [ { "name": "Mock APIs", "item": [ { "name": "Connector-CRM", "item": [ { "name": "Bill Inquiry API", "request": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-CorrelationID", "value": "f56caf0b-377d-4a1f-8ac1-715859a83eee", "type": "text" }, { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-PayerFSP-Id", "value": "{{PayeeTenantName}}", "type": "text" } ], "url": { "raw": "{{ConnectorCRMHostName}}/bills/{{billId}}", "host": [ "{{ConnectorCRMHostName}}" ], "path": [ "bills", "{{billId}}" ] } }, "response": [] }, { "name": "Bill Payments API", "request": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-CorrelationID", "value": "f56caf0b-377d-4a1f-8ac1-715859a83eee", "type": "text" }, { "key": "X-PayerFSP-Id", "value": "{{PayeeTenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"billInquiryRequestId\": \"12e2cedc-7372-4208-8079-7d46d691fca4\",\n \"billId\": \"001\",\n \"paymentReferenceID\": \"8f353842-451c-4231-afc9-58289afdc396\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ConnectorCRMHostName}}/paymentNotifications", "host": [ "{{ConnectorCRMHostName}}" ], "path": [ "paymentNotifications" ] } }, "response": [] } ] }, { "name": "Connector-Bulk", "item": [ { "name": "Payer RTP Request API", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-Client-Correlation-ID", "value": "{{clientCorrelationId}}", "type": "text" }, { "key": "X-Callback-URL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Biller-Id", "value": "GovBill", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ConnectorBulkHostName}}/billTransferRequests", "host": [ "{{ConnectorBulkHostName}}" ], "path": [ "billTransferRequests" ] } }, "response": [ { "name": "Payer RTP Request API 202", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-Client-Correlation-ID", "value": "{{clientCorrelationId}}", "type": "text" }, { "key": "X-Callback-URL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Biller-Id", "value": "GovBill", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{ConnectorBulkHostName}}/billTransferRequests", "host": [ "{{ConnectorBulkHostName}}" ], "path": [ "billTransferRequests" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"12345678-6897-6798-6798-098765432134\"\n}" } ] } ] }, { "name": "Payer RTP Response API", "request": { "method": "PUT", "header": [ { "key": "X-Callback-URL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Client-Correlation-ID", "value": "{{clientCorrelationId}}", "type": "text" }, { "key": "X-Biller-Id", "value": "GovBill", "type": "text" }, { "key": "X-Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"clientCorrelationId\": \"123445\",\n \"billId\": \"12345\",\n \"requestType\": \"00\",\n \"payerFspDetail\": {\n \"payerFspId\": \"lion\",\n \"financialAddress\": \"1223455\"\n },\n \"alias\": null,\n \"bill\": {\n \"billerName\": \"Test\",\n \"amount\": 100.0\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{BillPayHostName}}/billTransferRequests", "host": [ "{{BillPayHostName}}" ], "path": [ "billTransferRequests" ] } }, "response": [ { "name": "Payer RTP Response API 202", "originalRequest": { "method": "PUT", "header": [ { "key": "X-Callback-URL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Client-Correlation-ID", "value": "{{clientCorrelationId}}", "type": "text" }, { "key": "X-Biller-Id", "value": "GovBill", "type": "text" }, { "key": "X-Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"clientCorrelationId\": \"123445\",\n \"billId\": \"12345\",\n \"requestType\": \"00\",\n \"payerFspDetail\": {\n \"payerFspId\": \"lion\",\n \"financialAddress\": \"1223455\"\n },\n \"alias\": null,\n \"bill\": {\n \"billerName\": \"Test\",\n \"amount\": 100.0\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{BillPayHostName}}/billTransferRequests", "host": [ "{{BillPayHostName}}" ], "path": [ "billTransferRequests" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"12345678-6897-6798-6798-098765432134\"\n}" } ] } ] }, { "name": "Bill Inquiry API", "request": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-CorrelationID", "value": "1234", "type": "text" }, { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "Payer-FSP-Id", "value": "{{PayeeTenantName}}", "type": "text" } ], "url": { "raw": "{{BillPayHostName}}/bills/{{billId}}", "host": [ "{{BillPayHostName}}" ], "path": [ "bills", "{{billId}}" ] } }, "response": [ { "name": "Callback request body", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-CorrelationID", "value": "f56caf0b-377d-4a1f-8ac1-715859a83eee", "type": "text" }, { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-PayerFSP-Id", "value": "{{PayeeTenantName}}", "type": "text" } ], "url": { "raw": "{{BillPayHostName}}/bills/{{billId}}", "host": [ "{{BillPayHostName}}" ], "path": [ "bills", "{{billId}}" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 05:04:54 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"code\": \"00\",\n \"reason\": \"TRANSACTION SUCCESSFUL\",\n \"clientCorrelationId\": \"f56caf0b-377d-4a1f-8ac1-715859a83eee\",\n \"billId\": \"001\",\n \"billDetails\": {\n \"billerId\": \"001\",\n \"billerName\": \"Biller1\",\n \"billStatus\": \"PAID\",\n \"dueDate\": \"2021-07-01\",\n \"amountonDueDate\": \"1000\",\n \"amountAfterDueDate\": \"1100\"\n }\n}" }, { "name": "Bill Inquiry API 202", "originalRequest": { "method": "GET", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-CorrelationID", "value": "f56caf0b-377d-4a1f-8ac1-715859a83eee", "type": "text" }, { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-PayerFSP-Id", "value": "{{PayeeTenantName}}", "type": "text" } ], "url": { "raw": "{{BillPayHostName}}/bills/{{billId}}", "host": [ "{{BillPayHostName}}" ], "path": [ "bills", "{{billId}}" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 08:47:54 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"transactionId\": \"33397af3-a696-460c-95c3-3b21773643f5\"\n}" } ] }, { "name": "Bill Payments API", "request": { "method": "POST", "header": [ { "key": "X-Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-CorrelationID", "value": "1234", "type": "text" }, { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-PayerFSP-Id", "value": "{{PayeeTenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"billInquiryRequestId\": \"12e2cedc-73\",\n \"billId\": \"001\",\n \"paymentReferenceID\": \"8f353842-451c-4\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{BillPayHostName}}/paymentNotifications", "host": [ "{{BillPayHostName}}" ], "path": [ "paymentNotifications" ] } }, "response": [ { "name": "Callback request body", "originalRequest": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-CorrelationID", "value": "f56caf0b-377d-4a1f-8ac1-715859a83eee", "type": "text" }, { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-PayerFSP-Id", "value": "{{PayeeTenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"billInquiryRequestId\": \"12e2cedc-7372-4208-8079-7d46d691fca4\",\n \"billId\": \"001\",\n \"paymentReferenceID\": \"8f353842-451c-4231-afc9-58289afdc396\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{BillPayHostName}}/paymentNotifications", "host": [ "{{BillPayHostName}}" ], "path": [ "paymentNotifications" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 05:04:39 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"code\": \"00\",\n \"reason\": \"TRANSACTION SUCCESSFUL\",\n \"requestID\": \"f56caf0b-377d-4a1f-8ac1-715859a83eee\",\n \"billId\": \"001\",\n \"status\": \"ACK\"\n}" }, { "name": "Bill Payments API 202", "originalRequest": { "method": "POST", "header": [ { "key": "Platform-TenantId", "value": "{{TenantName}}", "type": "text" }, { "key": "X-CorrelationID", "value": "f56caf0b-377d-4a1f-8ac1-715859a83eee", "type": "text" }, { "key": "X-CallbackURL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-PayerFSP-Id", "value": "{{PayeeTenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"billInquiryRequestId\": \"12e2cedc-7372-4208-8079-7d46d691fca4\",\n \"billId\": \"001\",\n \"paymentReferenceID\": \"8f353842-451c-4231-afc9-58289afdc396\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{BillPayHostName}}/paymentNotifications", "host": [ "{{BillPayHostName}}" ], "path": [ "paymentNotifications" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 08:48:26 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"transactionId\": \"f183aea3-a75d-43e3-a7c1-830a10d72956\"\n}" } ] }, { "name": "Biller RTP Request API", "request": { "method": "POST", "header": [ { "key": "X-Callback-URL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Client-Correlation-ID", "value": "{{clientCorrelationId}}", "type": "text" }, { "key": "X-Biller-Id", "value": "GovBill", "type": "text" }, { "key": "X-Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"clientCorrelationId\": \"123445\",\n \"billID\": \"12345\",\n \"requestType\": \"00\",\n \"payerFspDetails\": {\n \"payerFSPID\": \"lion\",\n \"financialAddress\": \"1223455\"\n },\n \"alias\": null,\n \"billDetails\": {\n \"billerName\": \"Test\",\n \"amount\": 100.0\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{BillPayHostName}}/billTransferRequests", "host": [ "{{BillPayHostName}}" ], "path": [ "billTransferRequests" ] } }, "response": [ { "name": "Callback request body", "originalRequest": { "method": "POST", "header": [ { "key": "X-Callback-URL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Client-Correlation-ID", "value": "{{clientCorrelationId}}", "type": "text" }, { "key": "X-Biller-Id", "value": "GovBill", "type": "text" }, { "key": "X-Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"clientCorrelationId\": \"123445\",\n \"billId\": \"12345\",\n \"requestType\": \"00\",\n \"payerFspDetail\": {\n \"payerFspId\": \"lion\",\n \"financialAddress\": \"1223455\"\n },\n \"alias\": null,\n \"bill\": {\n \"billerName\": \"Test\",\n \"amount\": 100.0\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{BillPayHostName}}/billTransferRequests", "host": [ "{{BillPayHostName}}" ], "path": [ "billTransferRequests" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 05:04:01 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"requestId\": \"12345678-6897-6798-6798-098765432134\",\n \"rtpId\": \"123456\",\n \"billId\": \"12345\",\n \"rtpStatus\": \"00\",\n \"rejectReason\": null\n}" }, { "name": "Biller RTP Request API", "originalRequest": { "method": "POST", "header": [ { "key": "X-Callback-URL", "value": "{{X-CallbackURL}}", "type": "text" }, { "key": "X-Client-Correlation-ID", "value": "{{clientCorrelationId}}", "type": "text" }, { "key": "X-Biller-Id", "value": "GovBill", "type": "text" }, { "key": "X-Platform-TenantId", "value": "{{TenantName}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"clientCorrelationId\": \"123445\",\n \"billId\": \"12345\",\n \"requestType\": \"00\",\n \"payerFspDetail\": {\n \"payerFspId\": \"lion\",\n \"financialAddress\": \"1223455\"\n },\n \"alias\": null,\n \"bill\": {\n \"billerName\": \"Test\",\n \"amount\": 100.0\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{BillPayHostName}}/billTransferRequests", "host": [ "{{BillPayHostName}}" ], "path": [ "billTransferRequests" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 18 Mar 2024 08:48:51 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" }, { "key": "Access-Control-Allow-Origin", "value": "*" }, { "key": "Access-Control-Allow-Credentials", "value": "true" }, { "key": "Access-Control-Allow-Methods", "value": "PUT, GET, POST, OPTIONS, DELETE" }, { "key": "Access-Control-Allow-Headers", "value": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization" }, { "key": "Access-Control-Max-Age", "value": "1728000" } ], "cookie": [], "body": "{\n \"responseCode\": \"00\",\n \"responseDescription\": \"Request successfully received by Pay-BB\",\n \"requestID\": \"12345678-6897-6798-6798-098765432134\"\n}" } ] } ] } ], "variable": [ { "key": "TenantName", "value": "ibank-india" } ] }