From a7aef4ea27c2ef48e555d37c9780388d1aad2da3 Mon Sep 17 00:00:00 2001 From: Yash Dwivedi Date: Fri, 15 Mar 2024 12:36:16 +0530 Subject: [PATCH 1/4] Added API Doc for Bill Pay and Identity Account Mapper --- PostmanCollections/Payment Hub.json | 1571 ++++++++++++++++++++++++++- 1 file changed, 1557 insertions(+), 14 deletions(-) diff --git a/PostmanCollections/Payment Hub.json b/PostmanCollections/Payment Hub.json index 18407e8f8..db37cfd2a 100644 --- a/PostmanCollections/Payment Hub.json +++ b/PostmanCollections/Payment Hub.json @@ -1,9 +1,9 @@ { "info": { - "_postman_id": "ef1ae1e6-3a8d-462e-8a60-abf2f880c9d4", - "name": "Payment Hub APIs", + "_postman_id": "6d1077e2-6626-421f-aef7-727547582146", + "name": "Payment Hub APIs Copy 2", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "_exporter_id": "20222524" + "_exporter_id": "31254556" }, "item": [ { @@ -46060,7 +46060,222 @@ ] } }, - "response": [] + "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", @@ -46097,7 +46312,214 @@ ] } }, - "response": [] + "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", @@ -46134,7 +46556,174 @@ ] } }, - "response": [] + "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", @@ -46189,7 +46778,97 @@ ] } }, - "response": [] + "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", @@ -46222,7 +46901,87 @@ ] } }, - "response": [] + "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", @@ -46246,7 +47005,78 @@ ] } }, - "response": [] + "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", @@ -46283,7 +47113,91 @@ ] } }, - "response": [] + "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", @@ -46320,7 +47234,91 @@ ] } }, - "response": [] + "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}" + } + ] } ] }, @@ -46806,7 +47804,178 @@ ] } }, - "response": [] + "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", @@ -46853,7 +48022,194 @@ ] } }, - "response": [] + "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", @@ -46900,7 +48256,194 @@ ] } }, - "response": [] + "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}" + } + ] } ] } From 837ec3996a42e064754cdc97a03cf44ff4c49b10 Mon Sep 17 00:00:00 2001 From: Yash Dwivedi Date: Mon, 18 Mar 2024 12:55:02 +0530 Subject: [PATCH 2/4] API DOC Updated for Bill Pay and IDAM --- PostmanCollections/{Payment Hub.json => Payment Hub APIs.json} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename PostmanCollections/{Payment Hub.json => Payment Hub APIs.json} (100%) diff --git a/PostmanCollections/Payment Hub.json b/PostmanCollections/Payment Hub APIs.json similarity index 100% rename from PostmanCollections/Payment Hub.json rename to PostmanCollections/Payment Hub APIs.json From 0ded4ac89154eb773de36897dc4431902897b824 Mon Sep 17 00:00:00 2001 From: Abhinav Mishra Date: Mon, 18 Mar 2024 15:28:31 +0530 Subject: [PATCH 3/4] [PHEE-632] Add callback as an example in batch transaction API (#407) --- PostmanCollections/{Payment Hub APIs.json => Payment Hub.json} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename PostmanCollections/{Payment Hub APIs.json => Payment Hub.json} (100%) diff --git a/PostmanCollections/Payment Hub APIs.json b/PostmanCollections/Payment Hub.json similarity index 100% rename from PostmanCollections/Payment Hub APIs.json rename to PostmanCollections/Payment Hub.json From 7762fcf9a1edbf1bd05123df0f00ebdba419b360 Mon Sep 17 00:00:00 2001 From: Abhinav Mishra Date: Wed, 20 Mar 2024 19:56:12 +0530 Subject: [PATCH 4/4] Mock Payment api --- .../Mock Payment.postman_collection.json | 37 +++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 PostmanCollections/Mock Payment.postman_collection.json diff --git a/PostmanCollections/Mock Payment.postman_collection.json b/PostmanCollections/Mock Payment.postman_collection.json new file mode 100644 index 000000000..c1fa97068 --- /dev/null +++ b/PostmanCollections/Mock Payment.postman_collection.json @@ -0,0 +1,37 @@ +{ + "info": { + "_postman_id": "e7ba3432-e852-4f9f-9a30-5e1a17c3c990", + "name": "Mock Payment", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "31254556" + }, + "item": [ + { + "name": "Mock Batch Summary", + "request": { + "method": "GET", + "header": [] + }, + "response": [] + }, + { + "name": "Mock Batch Detail", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{MockPaymentSchema}}/batches/{batchId}/detail", + "host": [ + "{{MockPaymentSchema}}" + ], + "path": [ + "batches", + "{batchId}", + "detail" + ] + } + }, + "response": [] + } + ] +} \ No newline at end of file