{ "openapi": "3.1.0", "info": { "version": "4.2", "title": "EBACL R2P REST API - PWS", "description": "PWS RESTful API for interacting with R2P services", "contact": { "name": "EBA", "url": "https://www.eba.europa.eu/homepage" }, "x-info-creation-date": "2026-06-12", "x-info-release": "V20261116", "x-info-oasis-version": "3.0.20", "x-info-customization": "SWIFT" }, "servers": [ { "url": "https://api.swiftnet.sipn.swift.com/ebacl-r2p/v1", "description": "Live Environment" }, { "url": "https://api-test.swiftnet.sipn.swift.com/ebacl-r2p/v1", "description": "Test Environment" }, { "url": "https://api.common.swiftnet.sipn.swift.com/ebacl-r2p/v1", "description": "Extended availability Live environment" }, { "url": "https://api-pilot.common.swiftnet.sipn.swift.com/ebacl-r2p/v1", "description": "Extended availability Test environment" } ], "tags": [ { "name": "Files", "description": "Files" }, { "name": "Messages", "description": "Messages" }, { "name": "NetworkChannel", "description": "NetworkChannel" }, { "name": "Operations", "description": "Operations" }, { "name": "Participant management", "description": "Participant management" }, { "name": "Retransmission", "description": "Retransmission" }, { "name": "Routing Table", "description": "Routing Table" }, { "name": "System Alerts", "description": "System Alerts" }, { "name": "User Commands", "description": "User Commands" } ], "security": [ { "oauthBearerToken": [] } ], "paths": { "/messages/listMessages/{senderBic}": { "post": { "tags": [ "Messages" ], "operationId": "LIST_MESSAGES", "summary": "List messages", "description": "Use the listMessages request to retrieve a list of messages according to a search criteria.", "parameters": [ { "name": "senderBic", "description": "The BIC of participant sending the request\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nXA02: The BIC must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMessagesRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "msgTp": "pain.013", "dateFrom": "2019-06-21", "dateTo": "2019-06-21", "solutionPurposeId": "APNW", "aosId": [ "ALIA", "LINK" ], "referenceId": "2306211715ZZ", "endToEndId": "2306211013CC", "amountFrom": 10000.01, "amountTo": 10000.01, "debtorBic": "RTPDID21", "creditorBic": "RTPDID21", "msgStatus": "INFL", "r2pRsnCd": "XT07", "xmlMsgSts": "RJCS", "xmlStsRsn": "AEXR", "expiryDate": "2019-06-21", "overdue": "Y", "pointer": "001C", "msgSenderBic": "RTPDID21", "msgReceiverBic": "RTPDID21", "pmtInfId": "2306211013CC", "withCrdNote": false } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMessagesResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "numRcrdList": 1, "msgList": [ { "solutionPurposeId": "APNW", "aosId": [ "ALIA", "LINK" ], "msgTp": "pain.013", "creationDtTm": "2019-06-21T23:20:50.000001", "referenceId": "2306211715ZZ", "amount": 10000.01, "endToEndId": "2306211013CC", "creditorBic": "RTPDID21", "debtorBic": "RTPDID21", "msgStatus": "INFL", "r2pRsnCd": "XT07", "xmlMsgSts": "RJCS", "xmlStsRsn": "AEXR", "expiryDate": "2019-06-21", "overdue": "Y", "pmtInfId": "2306211013CC", "crdNoteAmt": 1234567.99 }, { "solutionPurposeId": "APLT", "aosId": [ "ALIA", "LINK" ], "msgTp": "pain.014", "creationDtTm": "2024-11-08T14:29:00.012345", "referenceId": "2306211013CC", "amount": 1234567.99, "endToEndId": "2306211013EE", "creditorBic": "RTPDID21ABC", "debtorBic": "RTPDID21ABC", "msgStatus": "RJCS", "r2pRsnCd": "XT83", "xmlMsgSts": "ACTC", "xmlStsRsn": "CUST", "expiryDate": "2024-11-08", "grntedPmtReqd": false, "overdue": "N", "pmtInfId": "231002035719", "crdNoteAmt": 9999999.12 } ], "pointer": "001C" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/messages/msgDetails/{senderBic}": { "post": { "tags": [ "Messages" ], "operationId": "MSG_DETAILS", "summary": "Detail message", "description": "Use the msgDetails request to get details of a specific message and the original message in XML format.", "parameters": [ { "name": "senderBic", "description": "Participant BIC sending the request\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nXA02: The BIC must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MsgDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "msgTp": "pain.013", "creationDtTm": "2019-06-21T23:20:50.000001", "referenceId": "2306211715ZZ", "creditorBic": "RTPDID21", "debtorBic": "RTPDID21", "msgStatus": "INFL", "r2pRsnCd": "XT07", "getOriginalMessage": "Y" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MsgDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "originalMessage": "2306211715YY", "msgDetails": { "msgTp": "pain.013", "receivingDtTm": "2019-06-21T23:20:50.000001", "sendingDtTm": "2019-06-21T23:20:50.000001", "solutionPurposeId": "APNW", "creationDtTm": "2019-06-21T23:20:50.000001", "referenceId": "2306211715ZZ", "endToEndId": "2306211013CC", "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "debtorBic": "RTPDID21", "creditorBic": "RTPDID21", "msgSenderBic": "RTPDID21", "msgReceiverBic": "RTPDID21", "amount": 10000.01, "msgStatus": "INFL", "r2pRsnCd": "XT07", "xmlMsgSts": "RJCS", "xmlStsRsn": "AEXR", "aosId": [ "ALIA", "LINK" ], "orgnlInformation": { "orgnlDebtorBic": "RTPDID21", "orgnlCreditorBic": "RTPDID21", "orgnlReferenceId": "2306211715YY", "orgnlAmount": 10000.01, "orgnlEndToEnd": "2306211013CC" }, "expiryDate": "2019-06-21T23:20:50.000001", "overdue": "Y", "acceptedAmt": 10000.01, "accptncDtTm": "2019-06-21T23:20:50.000001", "reqExeDt": "2019-06-21T23:20:50.000001", "pmtInfId": "2306211013CC", "crdNoteAmt": 1234567.99, "instNmb": 3, "resourceId": "2306211715ZZ", "cancellationId": "20180501183030100000", "installments": { "instAmt": 10000.01, "instReqExecDt": "2019-06-21T23:20:50.000001" } } } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/files/fileDetails/{senderBic}": { "post": { "tags": [ "Files" ], "operationId": "FILE_DETAILS", "summary": "Detail file", "description": "Use the fileDetails request to get details of a specific file as follows.\n", "parameters": [ { "name": "senderBic", "description": "Participant BIC sending the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value\nXA02: it must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "fileTp": "DRR", "businessDate": "2019-06-21", "netFileName": "PR02R2PRTPDID21200724003002011.D" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "fileTp": "DRR", "fileStatus": "TSG", "network": "EAS", "netFileName": "PR02R2PRTPDID21200724003002011.D", "fileReference": "DR2P200724000012", "sendingDtTm": "2019-06-21T23:20:50.000001", "receiverBic": "RTPDID21", "businessDate": "2019-06-21", "lastStatusUpdt": "2019-06-21T23:20:50.000001", "drrDetails": { "drps": { "totNumOfMsgSnt": "12", "totNumP013Snt": "12", "totNumP014Snt": "12", "totNumP028Snt": "12", "totNumC055Snt": "12", "totNumC029Snt": "12", "numP013SntAccp": "12", "numP013SntAcwc": "12", "numP013SntApcsAppm": "12", "numP013SntActc": "12", "numP013SntAccr": "12", "numP013SntRjctRjcm": "12", "numP013SntRjcs": "12", "numP014SntAccp": "12", "numP014SntAcwc": "12", "numP014SntActc": "12", "numP014SntRjReq": "12", "numP014SntRjcs": "12", "numP028SntNtfd": "12", "numP028SntVali": "12", "numP028SntRjcs": "12", "numC055SntAccr": "12", "numC055SntRjcs": "12", "numC055SntRjcr": "12", "numC055SntNtfd": "12", "numC055SntVali": "12", "numC029SntAccr": "12", "numC029SntRjcr": "12", "numC029SntRjcs": "12" }, "drpr": { "totNumOfMsgRcv": "12", "totNumP013Rcv": "12", "totNumP014Rcv": "12", "totNumP028Rcv": "12", "totNumC055Rcv": "12", "totNumC029Rcv": "12", "numP013RcvAcwc": "12", "numP013RcvAccp": "12", "numP013RcvApcsAppm": "12", "numP013RcvActc": "12", "numP013RcvAccr": "12", "numP013RcvRjctRjcsRjcm": "12", "numP014RcvAcwc": "12", "numP014RcvAccp": "12", "numP014RcvAppm": "12", "numP014RcvActc": "12", "numP014RcvRjct": "12", "numP014RcvRjcs": "12", "numP014RcvNtfd": "12", "numP028RcvNtfd": "12", "numC055RcvAccr": "12", "numC055RcvNtfd": "12", "numC055RcvRjcr": "12", "numC029RcvAccr": "12", "numC029RcvRjcr": "12", "numC029RcvRjcs": "12", "numC029RcvNtfd": "12" } }, "msrDetails": { "mrps": { "totNumOfMsgSnt": "12", "totNumP013Snt": "12", "totNumP014Snt": "12", "totNumP028Snt": "12", "totNumC055Snt": "12", "totNumC029Snt": "12", "numP013SntAcwc": "12", "numP013SntAccp": "12", "numP013SntAcspAppm": "12", "numP013SntActc": "12", "numP013SntAccr": "12", "numP013SntRjctRjcm": "12", "numP013SntRjcs": "12", "numP014SntAccp": "12", "numP014SntActc": "12", "numP014SntAcwc": "12", "numP014SntRjcs": "12", "numP014SntRjReq": "12", "numP028SntNtfd": "12", "numP028SntVali": "12", "numP028SntRjcs": "12", "numC055SntNtfd": "12", "numC055SntVali": "12", "numC055SntAccr": "12", "numC055SntRjcs": "12", "numC055SntRjcr": "12", "numC029SntAccr": "12", "numC029SntRjcr": "12", "numC029SntRjcs": "12" }, "mrpr": { "totNumOfMsgRcv": "12", "totNumP013Rcv": "12", "totNumP014Rcv": "12", "totNumP028Rcv": "12", "totNumC055Rcv": "12", "totNumC029Rcv": "12", "numP013RcvAcwc": "12", "numP013RcvAccp": "12", "numP013RcvApcsAppm": "12", "numP013RcvActc": "12", "numP013RcvAccr": "12", "numP013RcvRjctRjcsRjcm": "12", "numP014RcvAcwc": "12", "numP014RcvAccp": "12", "numP014RcvAppm": "12", "numP014RcvActc": "12", "numP014RcvRjct": "12", "numP014RcvRjcs": "12", "numP014RcvNtfd": "12", "numP028RcvNtfd": "12", "numC055RcvAccr": "12", "numC055RcvRjcr": "12", "numC055RcvNtfd": "12", "numC029RcvAccr": "12", "numC029RcvRjcr": "12", "numC029RcvRjcs": "12", "numC029RcvNtfd": "12" } } } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/files/listFiles/{senderBic}": { "post": { "tags": [ "Files" ], "operationId": "LIST_FILES", "summary": "List files", "description": "Use the listFiles request to retrieve a list of files (e.g. DRR, MSR,...) according to search criteria. ", "parameters": [ { "name": "senderBic", "description": "Participant BIC sending the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value\nXA02: The BIC must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFilesRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "fileTp": "DRR", "dateFrom": "2019-06-21", "dateTo": "2019-06-21", "timeFrom": "16:00:00", "timeTo": "16:00:00", "fileReference": "DR2P200724000012", "netFileName": "PR02R2PRTPDID21200724003002011.D", "fileStatus": "TSG", "pointer": "001C" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFilesResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "numRcrdList": 1, "fileList": [ { "fileTp": "DRR", "fileReference": "DR2P200724000012", "sendingDtTm": "2019-06-21T23:20:50.000001", "fileStatus": "TSG", "netFileName": "PR02R2PRTPDID21200724003002011.D", "network": "EAS" }, { "fileTp": "MSR", "fileReference": "DR2P200467000034", "sendingDtTm": "2024-11-08T14:29:00.012345", "fileStatus": "TSD", "netFileName": "PR02R2PRTPDID21200801003002008.M", "network": "EBX" } ], "pointer": "001C" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/routingTable/getParticipants/{senderBic}": { "post": { "tags": [ "Routing Table" ], "operationId": "GET_PARTICIPANTS", "summary": "List participants", "description": "Use the getParticipants request to retrieve a list of Participants based on a search criteria.\nWith “network” search criteria, the query filters the Participants by their network configuration for both “Transactional Interface Primary/Secondary Network Identification” and both “File Interface Primary/Secondary Network Identification”.\nIf left null, the query does not use this filter. If any value is set in the “network” field, than the value is used to filter the result for one of the following Participant parameters:\n• “Transactional Interface Primary/ Secondary Network Identification” if one of the following “Network” values has been set: EAS;EBX;SWI; API\n• “File Interface Primary/Secondary Network Identification” if one of the following “Network” values has been set: EAS;EBX;SWF;SWA;SWS; SWM\n", "parameters": [ { "name": "senderBic", "description": "Participant BIC sending the request\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nXA02: The BIC must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetParticipantsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "participantBic": "RTPDID21", "technicalBic": "Y", "rtStatus": "ENB", "initValidityDate": "2019-06-21", "endValidityDate": "2019-06-21", "solutionPurposeId": "APNW", "aosId": [ "ALIA", "LINK" ], "network": "EAS" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetParticipantsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "numRcrdList": 1, "participantList": [ { "participantBic": "RTPDID21", "participantName": "Merrill Lynch", "technicalBic": "Y", "rtStatus": "ENB", "initValidityDate": "2019-06-21", "endValidityDate": "2019-06-21", "solutionPurposeId": "APNW", "aosId": [ "ALIA", "LINK" ] }, { "participantBic": "RTPDID22", "participantName": "ExampleBank01", "technicalBic": "N", "rtStatus": "SUS", "initValidityDate": "2024-11-08", "endValidityDate": "2024-11-08", "solutionPurposeId": "APLT", "aosId": [ "ALIA", "LINK" ] } ] } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/routingTable/listREs/{senderBic}": { "post": { "tags": [ "Routing Table" ], "operationId": "LIST_RES", "summary": "List REs", "description": "Use the listREsrequest for a list of Reachables Entity according to a search criteria. ", "parameters": [ { "name": "senderBic", "description": "Participant BIC sending the request\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nXA02: The BIC must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListREsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "reBic": "RTPDID21ABC", "participantBic": "RTPDID21", "reName": "Merrill Lynch", "rtStatus": "ENB", "solutionPurposeId": "APNW", "aosId": [ "ALIA", "LINK" ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListREsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "numRcrdList": 1, "reList": [ { "reBic": "RTPDID21ABC", "participantBic": "RTPDID21", "reName": "Merrill Lynch", "solutionPurposeId": "APNW", "aosId": [ "ALIA", "LINK" ], "rtStatus": "ENB", "initValidityDate": "2019-06-21", "endValidityDate": "2019-06-21" }, { "reBic": "RTPDID22DEF", "participantBic": "RTPDID22", "reName": "ExampleBank01", "solutionPurposeId": "APLT", "aosId": [ "ALIA", "LINK" ], "rtStatus": "SUS", "initValidityDate": "2024-11-08", "endValidityDate": "2024-11-08" } ] } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/routingTable/participantDetails/{senderBic}/{participantBic}": { "post": { "tags": [ "Routing Table" ], "operationId": "PARTICIPANT_DETAILS", "summary": "Participant Detail", "description": "Use the participantDetails request to get details of a specific Participant. ", "parameters": [ { "name": "senderBic", "description": "Participant BIC sending the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value\nXA02: The BIC must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } }, { "name": "participantBic", "description": "Set the BIC of the Participant to search\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value\nPY01: it must be enabled, suspended or inserted participant", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ParticipantBic" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParticipantDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "participantDetails": { "participantBic": "RTPDID21", "participantName": "Merrill Lynch", "technicalBic": "Y", "rtStatus": "ENB", "initValidityDate": "2019-06-21", "endValidityDate": "2019-06-21" }, "parametersModificationHistory": [ { "cmndRfrnc": "00520200521074631403L6", "participantBic": "RTPDID21", "participantName": "Merrill Lynch", "technicalBic": "Y", "initParameterValidity": "2019-06-21", "endParameterValidity": "2019-06-21", "participantParameters": { "generalInformation": { "participantBic": "RTPDID21", "participantName": "Merrill Lynch", "initValidityDate": "2019-06-21", "endValidityDate": "2019-06-21", "rtStatus": "ENB", "roleChange": "Y", "newBic": "RTPDID21" }, "fileIntf": { "pryFileNetID": "EAS", "scyFileNetID": "EAS", "actvOFileNet": "PRIMARY", "pryRcvngFileNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "scyRcvngFileNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "drrRqst": "Y", "msrRqst": "Y", "rtfRqst": "Y", "maxFileSize": 245000000, "compression": "Y" }, "msgIntf": { "actvOMsgNet": 1, "pryMsgNetID": "EAS", "scyMsgNetID": "EAS", "pryApiEndpoint": "http://example.com/api/1/resourcename", "scyApiEndpoint": "http://example.com/api/1/resourcename", "participantCommonName": "service-auth-01", "participantAuthenticationCA": "AuthenticationCA Name", "redaMsgAllwd": "Y", "productList": [ { "solutionPurposeId": "APNW", "pryRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "prySndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secSndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" }, { "solutionPurposeId": "APLT", "pryRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "prySndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secSndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" } ], "aosId": [ "ALIA", "LINK" ] } } }, { "cmndRfrnc": "016202006181423016168R", "participantBic": "RTPDID22", "participantName": "ExampleBank01", "technicalBic": "N", "initParameterValidity": "2024-11-08", "endParameterValidity": "2024-11-08", "participantParameters": { "generalInformation": { "participantBic": "RTPDID21", "participantName": "Merrill Lynch", "initValidityDate": "2019-06-21", "endValidityDate": "2019-06-21", "rtStatus": "ENB", "roleChange": "Y", "newBic": "RTPDID21" }, "fileIntf": { "pryFileNetID": "EAS", "scyFileNetID": "EAS", "actvOFileNet": "PRIMARY", "pryRcvngFileNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "scyRcvngFileNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "drrRqst": "Y", "msrRqst": "Y", "rtfRqst": "Y", "maxFileSize": 245000000, "compression": "Y" }, "msgIntf": { "actvOMsgNet": 1, "pryMsgNetID": "EAS", "scyMsgNetID": "EAS", "pryApiEndpoint": "http://example.com/api/1/resourcename", "scyApiEndpoint": "http://example.com/api/1/resourcename", "participantCommonName": "service-auth-01", "participantAuthenticationCA": "AuthenticationCA Name", "redaMsgAllwd": "Y", "productList": [ { "solutionPurposeId": "APNW", "pryRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "prySndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secSndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" }, { "solutionPurposeId": "APLT", "pryRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "prySndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secSndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" } ], "aosId": [ "ALIA", "LINK" ] } } } ] } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/routingTable/reDetails/{senderBic}/{reBic}": { "post": { "tags": [ "Routing Table" ], "operationId": "RE_DETAILS", "summary": "RE Details", "description": "Use the reDetails request to get details of a specific Reachable Entity. ", "parameters": [ { "name": "senderBic", "description": "Participant BIC sending the request\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nXA02: The BIC must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } }, { "name": "reBic", "description": "The BIC of the inquired RE\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nPY01: It must be an enabled, suspended OR inserted Reachable Entity", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ReBic" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "reDetails": { "reBic": "RTPDID21ABC", "participantBic": "RTPDID21", "reName": "Merrill Lynch", "rtStatus": "ENB", "initValidityDate": "2019-06-21", "endValidityDate": "2019-06-21" }, "parametersModificationHistory": [ { "cmndRfrnc": "00520200521074631403L6", "reBic": "RTPDID21ABC", "reName": "Merrill Lynch", "participantBic": "RTPDID21", "initParameterValidity": "2019-06-21", "endParameterValidity": "2019-06-21", "solutionPurposeId": [ "APNW", "APLT" ], "aosId": [ "ALIA", "LINK" ], "reParameters": { "details": { "reBic": "RTPDID21ABC", "reName": "Merrill Lynch", "initValidityDate": "2019-06-21", "endValidityDate": "2019-06-21", "newBic": "RTPDID21", "roleChange": "Y" }, "parameterDetails": { "initParameterValidity": "2019-06-21", "endParameterValidity": "2019-06-21", "participantBic": "RTPDID21", "rtStatus": "ENB" }, "msgIntf": { "solutionPurposeId": [ "APNW", "APLT" ], "aosId": [ "ALIA", "LINK" ] } } }, { "cmndRfrnc": "016202006181423016168R", "reBic": "RTPDID22DEF", "reName": "ExampleBank01", "participantBic": "RTPDID22", "initParameterValidity": "2024-11-08", "endParameterValidity": "2024-11-08", "solutionPurposeId": [ "APNW", "APLT" ], "aosId": [ "ALIA", "LINK" ], "reParameters": { "details": { "reBic": "RTPDID21ABC", "reName": "Merrill Lynch", "initValidityDate": "2019-06-21", "endValidityDate": "2019-06-21", "newBic": "RTPDID21", "roleChange": "Y" }, "parameterDetails": { "initParameterValidity": "2019-06-21", "endParameterValidity": "2019-06-21", "participantBic": "RTPDID21", "rtStatus": "ENB" }, "msgIntf": { "solutionPurposeId": [ "APNW", "APLT" ], "aosId": [ "ALIA", "LINK" ] } } } ] } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/routingTable/updateParticipant/{senderBic}": { "post": { "tags": [ "Routing Table" ], "operationId": "UPDATE_PARTICIPANTS", "summary": "Update participants", "description": "Use updateParticipant request to update a Participant’s service configuration.\nA system check avoid update confirmation of provisioning without any change to the parameters, with the exception of the Effective Date. In case of update confirmation without inserting changings, the request is rejected and the “XA31” error code will be provided in the Response 400 - Bad Request message.", "parameters": [ { "name": "senderBic", "description": "It must be equal to the Participant BIC identified through its certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateParticipantRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "bicRequested": "RTPDID21", "effectiveDate": "2019-06-21", "cmndRfrnc": "00520200521074631403L6", "participantName": "Merrill Lynch", "technicalBic": "Y", "fileIntf": { "pryFileNetID": "EAS", "scyFileNetID": "EAS", "actvOFileNet": "PRIMARY", "pryRcvngFileNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "scyRcvngFileNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "drrRqst": "Y", "msrRqst": "Y", "rtfRqst": "Y", "maxFileSize": 245000000, "compression": "Y" }, "msgIntf": { "pryMsgNetID": "EAS", "scyMsgNetID": "EAS", "participantCommonName": "service-auth-01", "participantAuthenticationCA": "AuthenticationCA Name", "pryApiEndpoint": "http://example.com/api/1/resourcename", "scyApiEndpoint": "http://example.com/api/1/resourcename", "redaMsgAllwd": "Y", "productList": [ { "actionType": "INS", "solutionPurposeId": "APNW", "pryRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "prySndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secSndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" }, { "actionType": "UPD", "solutionPurposeId": "APLT", "pryRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "prySndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secSndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" } ], "aosId": [ "ALIA", "LINK" ] } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateParticipantResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "cmndRfrnc": "00520200521074631403L6" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/routingTable/insertRe/{senderBic}": { "post": { "tags": [ "Routing Table" ], "operationId": "INSERT_RE", "summary": "Insert RE", "description": "Use insertRe request to insert a new Reachable Entity. The request must contain only parameters that must be inserted. ", "parameters": [ { "name": "senderBic", "description": "Sender bic\n\n **Validation Rule(s)** XA02: It must correspond to the BIC in the participant certificate\nXA20: It must be equal to an allowed value", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertReRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "initValidityDate": "2019-06-21", "participantBic": "RTPDID21", "listRe": [ { "reBic": "RTPDID21ABC", "reName": "Merrill Lynch", "solutionPurposeId": [ "APNW", "APLT" ], "aosId": [ "ALIA", "LINK" ] }, { "reBic": "RTPDID22DEF", "reName": "ExampleBank01", "solutionPurposeId": [ "APNW", "APLT" ], "aosId": [ "ALIA", "LINK" ] } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertReResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "cmndRfrnc": "00520200521074631403L6" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/routingTable/updateRe/{senderBic}": { "post": { "tags": [ "Routing Table" ], "operationId": "UPDATE_RE", "summary": "Update RE", "description": "Use updateRe request to update a Reachable Entity service configuration. The request must contain only parameters that must be changed.\nA system check avoid update confirmation of provisioning without any change to the parameters, with the exception of the Effective Date. In case of update confirmation without inserting changings, the request is rejected and the “XA31” error code will be provided in the Response 400 - Bad Request message.", "parameters": [ { "name": "senderBic", "description": "It must correspond to the Participant BIC identified through its certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "participantBic": "RTPDID21", "effectiveDate": "2019-06-21", "listRe": [ { "reBic": "RTPDID21ABC", "cmndRfrnc": "00520200521074631403L6", "newParticipantBic": "RTPDID21", "reName": "Merrill Lynch", "solutionPurposeId": [ "APNW", "APLT" ], "aosId": [ "ALIA", "LINK" ] }, { "reBic": "RTPDID22DEF", "cmndRfrnc": "016202006181423016168R", "newParticipantBic": "RTPDID22", "reName": "ExampleBank01", "solutionPurposeId": [ "APNW", "APLT" ], "aosId": [ "ALIA", "LINK" ] } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "cmndRfrnc": "00520200521074631403L6" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/routingTable/removeBic/{senderBic}": { "post": { "tags": [ "Routing Table" ], "operationId": "REMOVE_BIC", "summary": "Remove BIC", "description": "Use removeBic request to remove a Participant or RE from the routing table. ", "parameters": [ { "name": "senderBic", "description": "Sender bic", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveBicRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "participantBic": "RTPDID21", "reBic": "RTPDID21ABC", "effectiveDate": "2019-06-21" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveBicResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "cmndRfrnc": "00520200521074631403L6" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/userCommands/commandDetails/{senderBic}/{cmndRfrnc}": { "post": { "tags": [ "User Commands" ], "operationId": "COMMAND_DETAILS", "summary": "User Command Details", "description": "Use the commandDetails request to get details of a specific command. ", "parameters": [ { "name": "senderBic", "description": "Participant BIC sending the request\n\n **Validation Rule(s)** XA02: the BIC must be equal to the value associated to the certificate\nXA20: it must e equal to the allowed value", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } }, { "name": "cmndRfrnc", "description": "Command reference, that is the unique reference identification of the command\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CmndRfrnc2" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommandDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "cmndRfrnc": "00520200521074631403L6", "cmndTp": "RESEND_ALL", "cmndStatus": "WTG", "requestDtTm": "2019-06-21T23:20:50.000001", "authRejectDtTm": "2019-06-21T23:20:50.000001", "userIssuer": "SSO01347", "userSprvr": "SSO01347", "detailsRof": { "fileTp": "DRR", "netFileName": "PR02R2PRTPDID21200724003002011.D", "businessDate": "2019-06-21" } } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/userCommands/listCommandsStatus/{senderBic}": { "post": { "tags": [ "User Commands" ], "operationId": "LIST_COMMAND_STATUS", "summary": "List user commands", "description": "Use the listCommands request to retrieve the commands submitted by a user (associated with the senderBic), according to a search criteria.", "parameters": [ { "name": "senderBic", "description": "Participant BIC sending the request\n\n **Validation Rule(s)** XA02: the BIC must be equal to the value associated to the certificate\nXA20: it must e equal to the allowed value", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCommandsStatusRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "cmndRfrnc": "00520200521074631403L6", "cmndTp": "REJECT_MESSAGE", "cmndStatus": "WTG", "requestDtTmFrom": "2019-06-21T23:20:50.000001", "requestDtTmTo": "2019-06-21T23:20:50.000001", "authRejectDtTmFrom": "2019-06-21T23:20:50.000001", "authRejectDtTmTo": "2019-06-21T23:20:50.000001", "userIssr": "SSO01347", "userSprvr": "SSO01347" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCommandsStatusResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "numRcrdList": 1, "cmndList": [ { "cmndRfrnc": "00520200521074631403L6", "participantBic": "RTPDID21", "cmndTp": "REJECT_MESSAGE", "cmndStatus": "WTG", "requestDtTm": "2019-06-21T23:20:50.000001", "authRejectDtTm": "2019-06-21T23:20:50.000001", "userIssr": "SSO01347", "userSprvr": "SSO01347" }, { "cmndRfrnc": "016202006181423016168R", "participantBic": "RTPDID22", "cmndTp": "REJECT_ALL_MESSAGES", "cmndStatus": "EXE", "requestDtTm": "2024-11-08T14:29:00.012345", "authRejectDtTm": "2024-11-08T14:29:00.012345", "userIssr": "SSO02098", "userSprvr": "SSO02098" } ] } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/userCommands/rejectCommand/{senderBic}": { "post": { "tags": [ "User Commands" ], "operationId": "REJECT_COMMAND", "summary": "Reject Commands", "description": "Use rejectCommand request to reject a command or a participant operation (update or insert) in status “to be authorized”. ", "parameters": [ { "name": "senderBic", "description": "Sender bic\n\n **Validation Rule(s)** XA02: It must be equal to the BIC identified through its certificate\nPY01: It must be an enabled or suspended", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectCommandRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "cmndRfrnc": "00520200521074631403L6" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectCommandResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "cmndRfrnc": "00520200521074631403L6" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/retransmission/resendAll/{senderBic}": { "post": { "tags": [ "Retransmission" ], "operationId": "RESEND_ALL", "summary": "Resend All Output File", "description": "Use the resendAll request to make a request for resending all of the output files in status “TSG” or “ERR” and creation date can be maximum after D -2 calendar days.", "parameters": [ { "name": "senderBic", "description": "Participant BIC sending the request\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nXA02: The BIC must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResendAllRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "fileTp": "DRR", "fileStatus": "TSG", "dateFrom": "2019-06-21", "dateTo": "2019-06-21" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResendAllResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "operationItem": { "requestDtTm": "2019-06-21T23:20:50.000001", "cmndRfrnc": "00520200521074631403L6", "cmndStatus": "WTG" } } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/retransmission/retransmitOutputFiles/{senderBic}": { "post": { "tags": [ "Retransmission" ], "operationId": "RETRANSMIT_OUTPUT_FILES", "summary": "Retransmit Output Files", "description": "Use the retransmitOutputFile request to make a request for resending a specific output file (for example a DRR). The status of the requested file shall be “TSG”, “TSD” or “ERR” and creation date can be after maximum D-7 calendar days (where D is the date of the request).", "parameters": [ { "name": "senderBic", "description": "Participant BIC sending the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value\nXA02: The BIC must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetransmitOutputFilesRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "netFileName": "PR02R2PRTPDID21200724003002011.D" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetransmitOutputFilesResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "operationItem": { "requestDtTm": "2019-06-21", "cmndRfrnc": "00520200521074631403L6", "cmndStatus": "WTG" } } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/participantReOperation/reOperationDetails/{senderBic}/{cmndRfrnc}": { "post": { "tags": [ "Operations" ], "operationId": "RE_OPERATION_DETAILS", "summary": "operation details", "description": "It allows participant to retrieve a Reachable Entity operation details", "parameters": [ { "name": "senderBic", "description": "It must be equal to the BIC identified through its certificate\n\n **Validation Rule(s)** XA20: it must correspond to an allowed value\nXA02: The BIC must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } }, { "name": "cmndRfrnc", "description": "The ID reference of the command\n\n **Validation Rule(s)** XA20: it must correspond to an allowed value", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CmndRfrnc2" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReOperationDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "cmndRfrnc": "00520200521074631403L6", "operationTp": "UPDATE_BIC", "operationStatus": "WTG", "userIssr": "SSO01347", "userSprvr": "SSO01347", "requestDtTm": "2019-06-21T23:20:50.000001", "effectiveDate": "2019-06-21", "listReOperationDetails": [ { "bicRequested": "RTPDID21", "participantBic": "RTPDID21", "reName": "Merrill Lynch", "newReBic": "RTPDID21ABC", "newParticipantBic": "RTPDID21ABC", "roleChange": "Y", "solutionPurposeId": [ "APNW", "APLT" ], "aosId": [ "ALIA", "LINK" ] }, { "bicRequested": "RTPDID21ABC", "participantBic": "RTPDID21ABC", "reName": "ExampleBank01", "newReBic": "RTPDID22DEF", "newParticipantBic": "RTPDID22DEF", "roleChange": "N", "solutionPurposeId": [ "APNW", "APLT" ], "aosId": [ "ALIA", "LINK" ] } ], "critical": "Y" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/participantReOperation/participantOperationDetails/{senderBic}/{cmndRfrnc}": { "post": { "tags": [ "Operations" ], "operationId": "PARTICIPANT_OPERATION_DETAILS", "summary": "operation details", "description": "Use reOperationDetails request to retrieve Reachable Entity operation details stored in the RE routing table, based on a customized search criteria.", "parameters": [ { "name": "senderBic", "description": "The BIC of participant sending the request", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } }, { "name": "cmndRfrnc", "description": "Command reference", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CmndRfrnc2" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParticipantOperationDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "cmndRfrnc": "00520200521074631403L6", "operationTp": "UPDATE_BIC", "operationStatus": "WTG", "userIssr": "SSO01347", "userSprvr": "SSO01347", "requestDtTm": "2019-06-21T23:20:50.000001", "authRejectDtTm": "2019-06-21T23:20:50.000001", "effectiveDate": "2019-06-21", "bicRequested": "RTPDID21", "participantName": "Merrill Lynch", "newParticipantBic": "RTPDID21", "roleChange": "Y", "technicalBic": "Y", "fileIntf": { "pryFileNetID": "EAS", "scyFileNetID": "EAS", "actvOFileNet": 1, "pryRcvngFileNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "scyRcvngFileNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "drrRqst": "Y", "msrRqst": "Y", "rtfRqst": "Y", "maxFileSize": 245000000, "compression": "Y" }, "msgIntf": { "actvOMsgNet": 1, "pryMsgNetID": "EAS", "scyMsgNetID": "EAS", "pryApiEndpoint": "http://example.com/api/1/resourcename", "scyApiEndpoint": "http://example.com/api/1/resourcename", "participantCommonName": "service-auth-01", "participantAuthenticationCA": "AuthenticationCA Name", "aosId": [ "ALIA", "LINK" ], "productList": [ { "solutionPurposeId": "APNW", "pryRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "prySndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secSndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" }, { "solutionPurposeId": "APLT", "pryRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secRcvgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "prySndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secSndgNetAd": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" } ] }, "critical": "Y" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/participantReOperation/listOperations/{senderBic}": { "post": { "tags": [ "Operations" ], "operationId": "LIST_DETAILS", "summary": "operation details", "description": "Use listOperations request to retrieve participant operations stored in the Participant and RE routing table, based on a customized search criteria.", "parameters": [ { "name": "senderBic", "description": "Sender bic\n\n **Validation Rule(s)** XA02: It must be equal to the BIC identified through its certificate\nXA20: it mut be equal to the allowed value", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOperationsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "routingTable": "P", "userIssr": "SSO01347", "userSprvr": "SSO01347", "participantBic": "RTPDID21", "reBic": "RTPDID21ABC", "operationTp": "UPDATE_BIC", "operationStatus": "WTG", "authRejectDt": "2019-06-21", "requestDt": "2019-06-21", "effectiveDate": "2019-06-21", "critical": "Y" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOperationsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "operationsList": [ { "cmndRfrnc": "00520200521074631403L6", "routingTable": "P", "userIssr": "SSO01347", "userSprvr": "SSO01347", "participantBic": "RTPDID21", "reBic": "RTPDID21ABC", "operationTp": "UPDATE_BIC", "operationStatus": "WTG", "requestDtTm": "2019-06-21T23:20:50.000001", "authRejectDtTm": "2019-06-21T23:20:50.000001", "effectiveDate": "2019-06-21", "critical": "Y" }, { "cmndRfrnc": "016202006181423016168R", "routingTable": "RE", "userIssr": "SSO02098", "userSprvr": "SSO02098", "participantBic": "RTPDID22", "reBic": "RTPDID22DEF", "operationTp": "AMEND_INSERT_BIC", "operationStatus": "SUB", "requestDtTm": "2024-11-08T14:29:00.012345", "authRejectDtTm": "2024-11-08T14:29:00.012345", "effectiveDate": "2024-11-08", "critical": "N" } ] } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/systemAlerts/listAlerts/{senderBic}": { "post": { "tags": [ "System Alerts" ], "operationId": "LIST_ALERTS", "summary": "List System Alerts", "description": "Use the listAlerts request for a list of issued system alerts according to search criteria.", "parameters": [ { "name": "senderBic", "description": "Participant BIC sending the request\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nXA02: The BIC must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAlertsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "alertDtTmFrom": "2019-06-21T23:20:50.000001", "alertDtTmTo": "2019-06-21T23:20:50.000001", "alertTp": "SEC", "alertGroup": "VALIDATION", "alertCd": "803", "alertDesc": "DRR OUTPUT FILES GENERATION COMPLETED" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAlertsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "numRcrdList": 1, "alertList": [ { "alertCd": "803", "alertDtTm": "2019-06-21T23:20:50.000001", "alertTp": "SEC", "alertDesc": "DRR OUTPUT FILES GENERATION COMPLETED", "alertGroup": "VALIDATION" }, { "alertCd": "777", "alertDtTm": "2024-11-08T14:29:00.012345", "alertTp": "FTL", "alertDesc": "USER SSO12345 WITH BIC RTPDID21 LOGGED-IN PWS WITH NETWORK SIANET", "alertGroup": "ROUTING_REPOSITORY_UPDATE" } ] } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/networkChannel/channelSwitch/{senderBic}": { "put": { "tags": [ "NetworkChannel" ], "operationId": "CHANNEL_SWITCH", "summary": "Switching from primary to secondary network and vice versa. ", "description": "Use channelSwitch to set active network (file and/or message interface) switching from primary to secondary network and vice versa. Note that channel switch does not have effective date because the execution of the command is intraday. ", "parameters": [ { "name": "senderBic", "description": "It must be equal to EBA Clearing BIC.", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelSwitchRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "bicRequested": "RTPDID21" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelSwitchResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestId": "20180501183030100000", "cmndRfrnc": "00520200521074631403L6" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/participantManagement/communicationOfUnavailability/{senderBic}": { "put": { "tags": [ "Participant management" ], "operationId": "COMMUNICATION_OF_UNAVAILABILITY", "summary": "A Participant can communicate his temporary unavailability", "description": "The communicationOfUnavailability request allows to communicate a Participant or RE’s temporary unavailability specifying a BIC8 or BIC11 and the list of CUGs impacted by the unavailability.\n\nUsing this API, R2P users can inform the system about the unavailability or the resumption of availability.\nIt is possible to indicate the time of those events and to send a new message to update a previous one (e.g. to indicate that the expected duration of the unavailability will be shorter / longer).\n\nAll R2P users can access to the information.\n\nThe communicationOfUnavailability request allows to communicate the unavailability for:\n • a Participant (BIC8);\n • a RE (BIC11);\n • both Participant and all connected RE(s) setting the “REsUnavailability” tag to “1”.\n\nTo communicate the unavailability of specific REs, with no impact for its Participant BIC8, it is necessary to send an admi.004 for each affected BIC11.\n", "parameters": [ { "name": "senderBic", "description": "Participant BIC sending the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value\nXA02: it must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationOfUnavailabilityRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "unavailableBic": "RTPDID21", "startDateTime": "2019-05-02T22:22:00.123-01:10", "endDateTime": "2019-05-02T22:22:00.123-01:10", "eventDescription": "Free text to describe the event that causes the unavailability", "eventCode": "INS", "messageId": "P08M59270578EA544566A8DB7D970D", "cugsUnavailable": "CBIU", "resUnavailability": "0", "idOfUnavailableParty": "ID of Unavailable Party as a free" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationOfUnavailabilityResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "unavailableBic": "RTPDID21" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/participantManagement/inquiryUnavailability/{senderBic}": { "post": { "tags": [ "Participant management" ], "operationId": "INQUIRY_UNAVAILABILITY", "summary": "A Participant can inquiry the list of unavailable Participants", "description": "The Inquiry unavailability request allows to inquiry the unavailability of the participants, due to what communicated with the function Communication of Unavailability.", "parameters": [ { "name": "senderBic", "description": "Participant BIC sending the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value\nXA02: it must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquiryUnavailabilityRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "unavailableBic": "RTPDID21" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquiryUnavailabilityResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "list": [ { "unavailableBic": "RTPDID21", "cugsUnavailable": "CBIU", "resUnavailability": "0", "status": "0", "startDateTime": "2019-06-21T23:20:50.000001", "endDateTime": "2024-11-08T14:29:00.012345", "durationOfUnavailability": "01d 11h 21m 05s", "eventDescription": "Free text to describe the event that causes the unavailability", "generationDateTime": "9999-12-31T12:55:45.000001", "messageId": "P08M59270578EA544566A8DB7D970D" }, { "unavailableBic": "RTPDID21ABC", "cugsUnavailable": "RTPP", "resUnavailability": "1", "status": "1", "startDateTime": "2024-11-08T14:29:00.012345", "endDateTime": "9999-12-31T12:55:45.000001", "durationOfUnavailability": "01d 11h 21m 05s", "eventDescription": "Free text to describe the event that causes the unavailability", "generationDateTime": "2019-06-21T23:20:50.000001", "messageId": "P08B59450578EA544526A8DB7D060D" } ] } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/messages/listRedaMessages/{senderBic}": { "post": { "tags": [ "Messages" ], "operationId": "LIST_REDA_MESSAGES", "summary": "List Reda Messages", "description": "Use the listRedaMessages request to retrieve a list of Reda messages according to a search criteria.", "parameters": [ { "name": "senderBic", "description": "The BIC of participant sending the request\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nXA02: The BIC must be equal to the value associated to the certificate", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRedaMessagesRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "msgTp": "reda.070", "dateFrom": "2019-06-21", "dateTo": "2024-11-08", "creationDate": "2025-03-25", "messageID": "2306211715ZZ", "status": "INFL", "debtorBic": "RTPDID21", "creditorBic": "RTPDID21ABC", "sender": "RTPDID23", "receiver": "RTPDID21", "pointer": "001C" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRedaMessagesResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "numRcrdList": 1, "msgList": [ { "msgTp": "reda.070", "processingDT": "2019-06-21T23:20:50.000001", "creationDtTm": "2024-11-08T14:29:00.012345", "msgId": "2306211715ZZ", "status": "INFL", "reason": "AEXR", "creditorBic": "RTPDID21", "debtorBic": "RTPDID21ABC", "sender": "RTPDID23", "receiver": "RTPDID21" }, { "msgTp": "reda.072", "processingDT": "2024-11-08T14:29:00.012345", "creationDtTm": "9999-12-31T12:55:45.000001", "msgId": "2306211013CC", "status": "RJCS", "reason": "CUST", "creditorBic": "RTPDID21ABC", "debtorBic": "RTPDID23", "sender": "RTPDID21", "receiver": "RTPDID21ABC" } ], "pointer": "001C" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } } }, "components": { "securitySchemes": { "oauthBearerToken": { "description": "The access token obtained as a result of OAuth 2.0 flows. SWIFT supports two OAuth grant types depending on the API service.\n* JWT-Bearer grant type [RFC 7523](https://tools.ietf.org/html/rfc7523)\n* Password grant type\n\nThis API uses JWT-Bearer grant type.\n\nPlease visit [SWIFT OAuth Token API](https://developer.swift.com/swift-oauth-token-api) page for more information and examples on how to generate an OAuth token.\n\nIn this declaration only the basic security element to transport the bearer token of an OAuth2 process is declared.\n", "type": "http", "scheme": "bearer", "bearerFormat": "opaque OAuth 2.0" } }, "parameters": {}, "headers": { "X-Request-ID": { "description": "Specify an unique end to end tracking request ID. The element will be populated by the SWIFT API gateway", "schema": { "type": "string" } } }, "schemas": { "AccptdAmt": { "type": "number", "format": "double", "examples": [ 10000.01 ] }, "AccptncDtTm": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "ActionType": { "type": "string", "enum": [ "INS", "UPD", "RMV" ], "examples": [ "INS" ] }, "ActvOFileNet": { "type": "string", "examples": [ "PRIMARY" ] }, "ActvOFileNet1": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 2, "examples": [ 1 ] }, "ActvOMsgNet": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 2, "examples": [ 1 ] }, "AlertCd": { "type": "string", "examples": [ "803" ] }, "AlertDesc": { "type": "string", "minLength": 1, "maxLength": 1000, "examples": [ "DRR OUTPUT FILES GENERATION COMPLETED" ] }, "AlertDtTm": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "AlertDtTmFrom": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "AlertDtTmTo": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "AlertGroup": { "type": "string", "enum": [ "VALIDATION", "ROUTING_REPOSITORY_UPDATE", "DAILY_PROCESS", "COMMANDS" ], "examples": [ "VALIDATION" ] }, "AlertList": { "type": "object", "properties": { "alertCd": { "description": "Alert code", "$ref": "#/components/schemas/AlertCd" }, "alertDtTm": { "description": "Date and Time at which the alert was issued", "$ref": "#/components/schemas/AlertDtTm" }, "alertTp": { "description": "Type of the alert", "$ref": "#/components/schemas/AlertTp" }, "alertDesc": { "description": "Description of the alert", "$ref": "#/components/schemas/AlertDesc" }, "alertGroup": { "description": "It indicates the alert category (ex. validation, commands,..)", "$ref": "#/components/schemas/AlertGroup" } }, "required": [ "alertCd", "alertDtTm", "alertTp", "alertDesc", "alertGroup" ] }, "AlertTp": { "type": "string", "enum": [ "SEC", "FTL", "ERR", "WRN", "NOR" ], "examples": [ "SEC" ] }, "Amount": { "type": "number", "format": "double", "examples": [ 10000.01 ] }, "AmountFrom": { "type": "number", "format": "double", "examples": [ 10000.01 ] }, "AmountTo": { "type": "number", "format": "double", "examples": [ 10000.01 ] }, "AosId": { "type": "string", "enum": [ "ALIA", "LINK", "ZZZZ" ], "examples": [ "ALIA" ] }, "AuthRejectDt": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "AuthRejectDtTm": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "AuthRejectDtTmFrom": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "AuthRejectDtTmTo": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "Bic11": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "minLength": 8, "maxLength": 11, "examples": [ "RTPDID21" ] }, "Bic111": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "examples": [ "RTPDID21" ] }, "BicRequested": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "examples": [ "RTPDID21" ] }, "BicRequested1": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}", "examples": [ "RTPDID21" ] }, "BusinessDate": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "CancellationId": { "type": "string", "minLength": 0, "maxLength": 70, "examples": [ "20180501183030100000" ] }, "ChannelSwitchRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nDT01: it must be a current or a future date", "$ref": "#/components/schemas/DateTime" }, "bicRequested": { "description": "BIC of the Participant or RE used to customize search criteria or BIC who requested [submitted] the operation [command]\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value BIC8\nPY01: unknown BIC in routing table", "$ref": "#/components/schemas/BicRequested1" }, "switchFileIntf": { "description": "Flag to switch the output active file interface from primary to secondary or vice versa\n\n **Validation Rule(s)** XA04 error details: either file interface or message interface must be present\nXA22 error details: secondary file network ID is not set\nXA20", "$ref": "#/components/schemas/SwitchFileIntf" }, "switchMsgIntf": { "description": "Flag to switch the output active message interface from primary to secondary or vice versa\n\n **Validation Rule(s)** XA04 error details: either file interface or message interface must be present\nXA22 error details: secondary message network ID is not set\nXA20", "$ref": "#/components/schemas/SwitchMsgIntf" } }, "required": [ "dateTime", "bicRequested" ] }, "ChannelSwitchResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "cmndRfrnc": { "description": "Command reference, that is the unique reference identification of the command", "$ref": "#/components/schemas/CmndRfrnc" } }, "required": [ "dateTime", "requestId", "cmndRfrnc" ] }, "CmndList": { "type": "object", "properties": { "cmndRfrnc": { "description": "Command reference, that is the unique reference identification of the command", "$ref": "#/components/schemas/CmndRfrnc" }, "participantBic": { "description": "Field not set", "$ref": "#/components/schemas/ParticipantBic" }, "cmndTp": { "description": "The type of command", "$ref": "#/components/schemas/CmndTp1" }, "cmndStatus": { "description": "The status of the command", "$ref": "#/components/schemas/CmndStatus" }, "requestDtTm": { "description": "Date&Time at which the command has been requested", "$ref": "#/components/schemas/RequestDtTm" }, "authRejectDtTm": { "description": "Authorization or Reject Date&Time indicates the date&time at which the command was executed (authorized/rejected)", "$ref": "#/components/schemas/AuthRejectDtTm" }, "userIssr": { "description": "The issuer of the command", "$ref": "#/components/schemas/UserIssr" }, "userSprvr": { "description": "User who authorized/rejected the command", "$ref": "#/components/schemas/UserSprvr1" } }, "required": [ "cmndRfrnc", "cmndStatus", "requestDtTm" ] }, "CmndRfrnc": { "type": "string", "minLength": 1, "maxLength": 22, "examples": [ "00520200521074631403L6" ] }, "CmndRfrnc1": { "type": "string", "examples": [ "00520200521074631403L6" ] }, "CmndRfrnc2": { "description": "Command ref", "type": "string", "minLength": 1, "maxLength": 22, "examples": [ "00520200521074631403L6" ] }, "CmndStatus": { "type": "string", "enum": [ "WTG", "EXE", "RJT", "RJS" ], "examples": [ "WTG" ] }, "CmndTp": { "type": "string", "enum": [ "RESEND_ALL", "FILE_RETRANSMISSION" ], "examples": [ "RESEND_ALL" ] }, "CmndTp1": { "type": "string", "enum": [ "REJECT_MESSAGE", "REJECT_ALL_MESSAGES", "APPROVE_MESSAGE", "APPROVE_ALL_MESSAGE", "INSERT_USER", "REMOVE_USER", "SUSPEND_USER", "RESUME_USER", "UPDATE_USER", "MANUAL_RETRANSMISSION_RTF", "RESEND_ALL", "FILE_RETRANSMISSION", "CHANNEL_SWITCH_MSG", "CHANNEL_SWITCH_FILE" ], "examples": [ "REJECT_MESSAGE" ] }, "CommandDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "cmndRfrnc": { "description": "Command reference, that is the unique reference identification of the command", "$ref": "#/components/schemas/CmndRfrnc2" }, "cmndTp": { "description": "Command Type", "$ref": "#/components/schemas/CmndTp" }, "cmndStatus": { "description": "Command Status", "$ref": "#/components/schemas/CmndStatus" }, "requestDtTm": { "description": "Date&Time at which the command has been requested", "$ref": "#/components/schemas/RequestDtTm" }, "authRejectDtTm": { "description": "Authorization or Reject Date&Time indicates the date&time at which the command was executed (authorized/rejected)", "$ref": "#/components/schemas/AuthRejectDtTm" }, "userIssuer": { "description": "Issuer of the comand", "$ref": "#/components/schemas/UserIssuer" }, "userSprvr": { "description": "User who authorized/rejected the command", "$ref": "#/components/schemas/UserSprvr" }, "detailsRof": { "$ref": "#/components/schemas/DetailsRof" } }, "required": [ "dateTime", "requestId", "cmndRfrnc", "cmndTp", "cmndStatus", "requestDtTm", "userIssuer" ] }, "CommunicationOfUnavailabilityRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation\n\n **Validation Rule(s)** XT33:it must be equal to the allowed format. DT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria" } }, "required": [ "dateTime", "criteria" ] }, "CommunicationOfUnavailabilityResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "unavailableBic": { "description": "BIC of the Participant or APSP that is going to be unavailable.", "$ref": "#/components/schemas/Bic11" } }, "required": [ "dateTime", "unavailableBic" ] }, "Compression": { "type": "string", "enum": [ "Y", "N" ], "examples": [ "Y" ] }, "CreationDtTm": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "CreditorBic": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "examples": [ "RTPDID21" ] }, "Criteria": { "type": "object", "properties": { "unavailableBic": { "description": "BIC of the Participant or RE that is going to be unavailable.\n\n **Validation Rule(s)** It must be equal to the BIC of the sender. If different, it must be one RE of the SenderBic. (ErrorCode XA06).\nField used for duplicate checking (error code AM05)", "$ref": "#/components/schemas/Bic11" }, "startDateTime": { "description": "Start date and time of unavailability.\n\n **Validation Rule(s)** It must always be minor than the “End date and time” (ErrorCode DT01)\nMust be an ISO Date Time with time zone.\nField used for duplicate checking (error code AM05)", "$ref": "#/components/schemas/ZonedDateTime" }, "endDateTime": { "description": "End date and time of unavailability.\n\n **Validation Rule(s)** It must always be greater than the current time (ErrorCode DT01)\nMust be an ISO Date Time with time zone.\nField used for duplicate checking (error code AM05)", "$ref": "#/components/schemas/ZonedDateTime" }, "eventDescription": { "description": "Free text to describe the event that causes the unavailability.\n\n **Validation Rule(s)** UTF-8 character set admitted.\nXT33: it must be equal to the allowed format", "$ref": "#/components/schemas/EventDescription" }, "eventCode": { "description": "Type of operation requested:\n- \"INS\" for new un-availability period insertion\n- \"DEL\" for cancellation of un-availability period previously communicated\n\n **Validation Rule(s)** XT33: must be one of the possible values\nField used for duplicate checking (error code AM05)", "$ref": "#/components/schemas/EventCode" }, "messageId": { "description": "The message ID of the ami.004 message. The stand format includes following fields:\n• BIC8 of sender Participant\n• Current timestamp\nExample:\n12345678aaaa-mm-ddThh:mm:ss:ssss\n\n **Validation Rule(s)** Field used for duplicate checking (error code AM05)", "$ref": "#/components/schemas/MessageId" }, "cugsUnavailable": { "description": "List of CUG(s) impacted by the unavailability\nIf all CUGs are unavailable, the list must include all configured CUGs for the unavailableBic\n\n **Validation Rule(s)** XT33: At least one of the CUG configured in the system for the unavailableBic must be indicated.", "$ref": "#/components/schemas/CugsUnavailable" }, "resUnavailability": { "description": "This flag allow Participant to communicate the unavailability for itself and for all its REs\n\nIf not present or “0” then the unavailability impact only the unavailableBic.\n\nIf present and “1” the unavailability impact both unavailableBic and all connected RE(s)\n\n **Validation Rule(s)** XT33: must be present if the unavailableBic is a Participant BIC8 and must be equal to the allowed values", "$ref": "#/components/schemas/ResUnavailability" }, "idOfUnavailableParty": { "description": "ID of Unavailable Party as a free text", "$ref": "#/components/schemas/IdOfUnavailableParty" } }, "required": [ "unavailableBic", "startDateTime", "endDateTime", "eventCode", "messageId", "cugsUnavailable" ] }, "Criteria1": { "type": "object", "properties": { "unavailableBic": { "description": "BIC of the Participant or RE that could be unavailable.\n\n **Validation Rule(s)** It must be one of the following:\n- Blank: the response shall provide all the BIC present in the admi.004 directory.\n- A direct Participant BIC that is enabled or suspended in the CS repository on the current calendar date (ErrorCode PY01).\n- An RE BIC that is enabled or suspended in the CS repository on the current calendar date (ErrorCode PY01).\nThe list shall be ordered in alphabetic order.", "$ref": "#/components/schemas/Bic11" } } }, "Critical": { "type": "string", "enum": [ "Y", "N" ], "examples": [ "Y" ] }, "CugsUnavailable": { "type": "string", "pattern": "[0-9A-Z]", "maxLength": 35, "examples": [ "CBIU" ] }, "DateFrom": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "DateTime": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "DateTo": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "DateValue": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "DebtorBic": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "examples": [ "RTPDID21" ] }, "Details": { "type": "object", "properties": { "reBic": { "description": "The BIC of reachable entity", "$ref": "#/components/schemas/ReBic" }, "reName": { "description": "The name of reachable entity", "$ref": "#/components/schemas/ReName" }, "initValidityDate": { "description": "The initial validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends from its init validity date (first business operating day)", "$ref": "#/components/schemas/InitValidityDate" }, "endValidityDate": { "description": "The end validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends to its end validity date (the last business operating day)", "$ref": "#/components/schemas/EndValidityDate" }, "newBic": { "description": "New BIC code assigned to a Participant or a reachable entity", "$ref": "#/components/schemas/NewBic" }, "roleChange": { "description": "Specify a role change of the Participant", "$ref": "#/components/schemas/RoleChange" } }, "required": [ "reBic", "reName", "initValidityDate", "endValidityDate" ] }, "DetailsRof": { "type": "object", "properties": { "fileTp": { "description": "The file type", "$ref": "#/components/schemas/FileTp" }, "netFileName": { "description": "The name of the file network", "$ref": "#/components/schemas/NetFileName" }, "businessDate": { "description": "Date&Time in which the retransmitted file has been sent for the first time", "$ref": "#/components/schemas/FrstSndgDtTm" } }, "required": [ "fileTp", "netFileName", "businessDate" ] }, "Drpr": { "type": "object", "properties": { "totNumOfMsgRcv": { "description": "Total number of R2P messages received", "$ref": "#/components/schemas/TotNumOfMsgRcv" }, "totNumP013Rcv": { "description": "Total number of pain.013 received", "$ref": "#/components/schemas/TotNumP013Rcv" }, "totNumP014Rcv": { "description": "Total number of pain.014 received", "$ref": "#/components/schemas/TotNumP014Rcv" }, "totNumP028Rcv": { "description": "Total number of pacs.028 received", "$ref": "#/components/schemas/TotNumP028Rcv" }, "totNumC055Rcv": { "description": "Total number of camt.055 received", "$ref": "#/components/schemas/TotNumC055Rcv" }, "totNumC029Rcv": { "description": "Total number of camt.029 received", "$ref": "#/components/schemas/TotNumC029Rcv" }, "numP013RcvAcwc": { "description": "Number of pain.013 received on the relevant business date and updated as Approved as accepted with change (ACWC)", "$ref": "#/components/schemas/NumP013RcvAcwc" }, "numP013RcvAccp": { "description": "Number of pain.013 received on the relevant business date and updated as accepted customer profile (ACCP).", "$ref": "#/components/schemas/NumP013RcvAccp" }, "numP013RcvApcsAppm": { "description": "Number of pain.013 received on the relevant business date and automatically approved (APCS) or manually approved (APPM)", "$ref": "#/components/schemas/NumP013RcvApcsAppm" }, "numP013RcvActc": { "description": "Number of pain.013 received on the relevant business date and confirmed (ACTC).", "$ref": "#/components/schemas/NumP013RcvActc" }, "numP013RcvAccr": { "description": "Number of pain.013 received on the relevant business date and cancelled (ACCR)", "$ref": "#/components/schemas/NumP013RcvAccr" }, "numP013RcvRjctRjcsRjcm": { "description": "Number of pain.013 received on the relevant business date and updated as rejected (RJCT – RJCS (*) – RJCM)\n(*) Including only pain.013 rejected due to timeout (TM01)", "$ref": "#/components/schemas/NumP013RcvRjctRjcsRjcm" }, "numP014RcvAcwc": { "description": "Number of pain.014 received as approval of a request accepted with change (relevant pain.013 status = ACWC) during the relevant business date", "$ref": "#/components/schemas/NumP014RcvAcwc" }, "numP014RcvAccp": { "description": "Number of pain.014 received as approval of a request accepted without changes (relevant pain.013 status = ACCP) during the relevant business date", "$ref": "#/components/schemas/NumP014RcvAccp" }, "numP014RcvAppm": { "description": "Number of pain.014 received as a result of a manually approval (relevant pain.013 status = APPM) during the relevant business date", "$ref": "#/components/schemas/NumP014RcvAppm" }, "numP014RcvActc": { "description": "Number of pain.014 received as a confirmation (relevant pain.013 status ACTC) during the relevant business date", "$ref": "#/components/schemas/NumP014RcvActc" }, "numP014RcvRjct": { "description": "Number of pain.014 received as reject of a request issued by the Counterparty (relevant pain.013 status = RJCT) or manually by EBA CL (relevant pain.013 status = RJCM) during the relevant business date", "$ref": "#/components/schemas/NumP014RcvRjct" }, "numP014RcvRjcs": { "description": "Number of pain.014 received as rejections generated by CS.\nThis field includes all pain.014 received as a rejection of a message due to validation failure and timeout during the relevant business date", "$ref": "#/components/schemas/NumP014RcvRjcs" }, "numP014RcvNtfd": { "description": "Number of pain.014 received as a response to an investigation", "$ref": "#/components/schemas/NumP014RcvNtfd" }, "numP028RcvNtfd": { "description": "Number of pacs.028 received in status NTFD during the relevant business date.", "$ref": "#/components/schemas/NumP028RcvNtfd" }, "numC055RcvAccr": { "description": "Number of camt.055 received and accepted (status ACCR) during the relevant business date.", "$ref": "#/components/schemas/NumC055RcvAccr" }, "numC055RcvNtfd": { "description": "Number of camt.055 received as a response to an investigation (Original Message Name Id = camt.055) during the relevant business date.", "$ref": "#/components/schemas/NumC055RcvNtfd" }, "numC055RcvRjcr": { "description": "Number of camt.055 received and rejected (status RJCR and RJCS *) during the relevant business date.\n(*) only rejections due to timeout.", "$ref": "#/components/schemas/NumC055RcvRjcr" }, "numC029RcvAccr": { "description": "Number of camt.029 received as acceptance of a cancellation (relevant pain.013 status = ACCR) during the relevant business date", "$ref": "#/components/schemas/NumC029RcvAccr" }, "numC029RcvRjcr": { "description": "Number of camt.029 received as reject of a cancellation (relevant pain.013 status = RJCR) during the relevant business date", "$ref": "#/components/schemas/NumC029RcvRjcr" }, "numC029RcvRjcs": { "description": "Number of camt.029 received on the relevant business date and updated as “Rejected by CS” RJCS", "$ref": "#/components/schemas/NumC029RcvRjcs" }, "numC029RcvNtfd": { "description": "Number of camt.029 received as a response to an investigation (Original Message Name Id = camt.055) during the relevant business date", "$ref": "#/components/schemas/NumC029RcvNtfd" } }, "required": [ "totNumOfMsgRcv", "totNumP013Rcv", "totNumP014Rcv", "totNumP028Rcv", "totNumC055Rcv", "totNumC029Rcv", "numP013RcvAcwc", "numP013RcvAccp", "numP013RcvApcsAppm", "numP013RcvActc", "numP013RcvAccr", "numP013RcvRjctRjcsRjcm", "numP014RcvAcwc", "numP014RcvAccp", "numP014RcvAppm", "numP014RcvActc", "numP014RcvRjct", "numP014RcvRjcs", "numP014RcvNtfd", "numP028RcvNtfd", "numC055RcvAccr", "numC055RcvNtfd", "numC055RcvRjcr", "numC029RcvAccr", "numC029RcvRjcr", "numC029RcvRjcs", "numC029RcvNtfd" ] }, "Drps": { "type": "object", "properties": { "totNumOfMsgSnt": { "description": "Total number of message sent", "$ref": "#/components/schemas/TotNumOfMsgSnt" }, "totNumP013Snt": { "description": "Total number of pain.013 sent", "$ref": "#/components/schemas/TotNumP013Snt" }, "totNumP014Snt": { "description": "Total number of pain.014 sent", "$ref": "#/components/schemas/TotNumP014Snt" }, "totNumP028Snt": { "description": "Total number of pain.028 sent", "$ref": "#/components/schemas/TotNumP028Snt" }, "totNumC055Snt": { "description": "Total number of camt.055 sent", "$ref": "#/components/schemas/TotNumC055Snt" }, "totNumC029Snt": { "description": "Total number of camt.029 sent", "$ref": "#/components/schemas/TotNumC029Snt" }, "numP013SntAccp": { "description": "Number of pain.013 sent during the relevant business date and updated in status “Accepted Customer Profile” (ACCP).", "$ref": "#/components/schemas/NumP013SntAccp" }, "numP013SntAcwc": { "description": "Number of pain.013 sent during the relevant business date and updated in status “Accepted with Change” (ACWC).", "$ref": "#/components/schemas/NumP013SntAcwc" }, "numP013SntApcsAppm": { "description": "Number of pain.013 sent during the relevant business date and updated in status “Automatically approved” (APCS) and “Manually approved” (APPM)", "$ref": "#/components/schemas/NumP013SntApcsAppm" }, "numP013SntActc": { "description": "Number of pain.013 sent during the relevant business date and updated in status “Confirmed by PSP” (ACTC)", "$ref": "#/components/schemas/NumP013SntActc" }, "numP013SntAccr": { "description": "Number of pain.013 sent during the relevant business date and updated in status “Request cancelled” (ACCR)", "$ref": "#/components/schemas/NumP013SntAccr" }, "numP013SntRjctRjcm": { "description": "Number of pain.013 sent during the relevant business date and updated in status “Rejected by PSP” (RJCT) and “Manually rejected” (RJCM).", "$ref": "#/components/schemas/NumP013SntRjctRjcm" }, "numP013SntRjcs": { "description": "Number of pain.013 sent during the relevant business date and updated in status “Rejected by CS” (RJCS)", "$ref": "#/components/schemas/NumP013SntRjcs" }, "numP014SntAccp": { "description": "Number of pain.014 sent during the relevant business date and updated as approval of a request accepted without changes (relevant pain.013 status = ACCP)", "$ref": "#/components/schemas/NumP014SntAccp" }, "numP014SntAcwc": { "description": "Number of pain.014 sent during the relevant business date and updated as approval of a request accepted with change (relevant pain.013 status = ACWC)", "$ref": "#/components/schemas/NumP014SntAcwc" }, "numP014SntActc": { "description": "Number of pain.014 sent during the relevant business date and updated as a confirmation (relevant pain.013 status = ACTC)", "$ref": "#/components/schemas/NumP014SntActc" }, "numP014SntRjReq": { "description": "Number of pain.014 sent during the relevant business date and updated as a reject of a request (relevant pain.013 status = RJCT)", "$ref": "#/components/schemas/NumP014SntRjReq" }, "numP014SntRjcs": { "description": "number of pain.014 sent during the relevant business date and updated in status RJCS", "$ref": "#/components/schemas/NumP014SntRjcs" }, "numP028SntNtfd": { "description": "Number of pacs.028 sent during the relevant business date and updated in status “notified” (NTFD)", "$ref": "#/components/schemas/NumP028SntNtfd" }, "numP028SntVali": { "description": "Number of pacs.028 sent during the relevant business date and updated in status “validated” (VALI)", "$ref": "#/components/schemas/NumP028SntVali" }, "numP028SntRjcs": { "description": "Number of pacs.028 sent during the relevant business date and updated in status “Rejected by CS” (RJCS)", "$ref": "#/components/schemas/NumP028SntRjcs" }, "numC055SntAccr": { "description": "Number of camt.055 sent during the relevant business date and updated in status “Request Cancelled” ACCR", "$ref": "#/components/schemas/NumC055SntAccr" }, "numC055SntRjcs": { "description": "Number of camt.055 sent during the relevant business date and updated in status “Rejected by CS” RJCS", "$ref": "#/components/schemas/NumC055SntRjcs" }, "numC055SntRjcr": { "description": "Number of camt.055 sent during the relevant business date and updated in status “Cancellation Rejected” RJCR", "$ref": "#/components/schemas/NumC055SntRjcr" }, "numC055SntNtfd": { "description": "Number of camt.055 sent as investigation on a RfC during the relevant business date and updated in status “notified” (NTFD)", "$ref": "#/components/schemas/NumC055SntNtfd" }, "numC055SntVali": { "description": "Number of camt.055 sent as investigation on a RfC during the relevant business date and updated in status “validated” (VALI)", "$ref": "#/components/schemas/NumC055SntVali" }, "numC029SntAccr": { "description": "Number of camt.029 sent during the relevant business date and updated as acceptance of a cancellation (relevant pain.013 status = ACCR)", "$ref": "#/components/schemas/NumC029SntAccr" }, "numC029SntRjcr": { "description": "Number of camt.029 sent during the relevant business date and updated as a reject of a cancellation (relevant pain.013 status RJCR)", "$ref": "#/components/schemas/NumC029SntRjcr" }, "numC029SntRjcs": { "description": "Number of camt.029 sent during the relevant business date and updated in status “Rejected by CS” RJCS", "$ref": "#/components/schemas/NumC029SntRjcs" } }, "required": [ "totNumOfMsgSnt", "totNumP013Snt", "totNumP014Snt", "totNumP028Snt", "totNumC055Snt", "totNumC029Snt", "numP013SntAccp", "numP013SntAcwc", "numP013SntApcsAppm", "numP013SntActc", "numP013SntAccr", "numP013SntRjctRjcm", "numP013SntRjcs", "numP014SntAccp", "numP014SntAcwc", "numP014SntActc", "numP014SntRjReq", "numP014SntRjcs", "numP028SntNtfd", "numP028SntVali", "numP028SntRjcs", "numC055SntAccr", "numC055SntRjcs", "numC055SntRjcr", "numC055SntNtfd", "numC055SntVali", "numC029SntAccr", "numC029SntRjcr", "numC029SntRjcs" ] }, "DrrDetails": { "type": "object", "properties": { "drps": { "description": "DRR sent messages section", "$ref": "#/components/schemas/Drps" }, "drpr": { "description": "DRR received messages section", "$ref": "#/components/schemas/Drpr" } }, "required": [ "drps", "drpr" ] }, "DrrRqst": { "type": "string", "enum": [ "Y", "N" ], "examples": [ "Y" ] }, "DurationOfUnavailability": { "type": "string", "pattern": "([0-9]{2}d)\\s(([01]?[0-9]|2[0-3])h)\\s([0-5][0-9]m)\\s([0-5][0-9]s)", "examples": [ "01d 11h 21m 05s" ] }, "EffectiveDate": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "EndParameterValidity": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "EndToEndId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "2306211013CC" ] }, "EndToEndId1": { "type": "string", "minLength": 0, "maxLength": 35, "examples": [ "2306211013CC" ] }, "EndValidityDate": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "ErrorCode": { "type": "string", "examples": [ "XA21" ] }, "ErrorCodeDescription": { "type": "string", "examples": [ "Username not found" ] }, "ErrorResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "errorCode": { "description": "API error code as validation result by the CS", "$ref": "#/components/schemas/ErrorCode" }, "errorCodeDescription": { "description": "API error code description of the error", "$ref": "#/components/schemas/ErrorCodeDescription" }, "requestId": { "description": "The univocal reference per senderBIC and date assigned by the system to the API request", "$ref": "#/components/schemas/RequestId" } }, "required": [ "dateTime", "errorCode", "errorCodeDescription" ] }, "EventCode": { "type": "string", "enum": [ "INS", "DEL" ], "examples": [ "INS" ] }, "EventDescription": { "type": "string", "pattern": "[A-Za-z0-9\\s\\\"\\#\\$\\%\\&\\'\\(\\)\\*\\+\\,\\-\\.\\/\\:\\;\\<\\=\\>\\?\\@\\\\\\_\\`\\{\\}\\~\\]]", "maxLength": 1000, "examples": [ "Free text to describe the event that causes the unavailability" ] }, "ExpiryDate": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "ExpiryDate1": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "FileDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and time of the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "fileTp": { "description": "the type of file\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format", "$ref": "#/components/schemas/FileTp" }, "businessDate": { "description": "Business date (day on which the Service is open)\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/BusinessDate" }, "netFileName": { "description": "Network filename\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format", "$ref": "#/components/schemas/NetFileName" } }, "required": [ "dateTime", "fileTp", "businessDate", "netFileName" ] }, "FileDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "fileTp": { "description": "The type of file", "$ref": "#/components/schemas/FileTp" }, "fileStatus": { "description": "The status of the file", "$ref": "#/components/schemas/FileStatus" }, "network": { "description": "The file network", "$ref": "#/components/schemas/Network" }, "netFileName": { "description": "The network filename", "$ref": "#/components/schemas/NetFileName" }, "fileReference": { "description": "File reference created by CS", "$ref": "#/components/schemas/FileReference" }, "sendingDtTm": { "description": "Output timestamp of the CS", "$ref": "#/components/schemas/SendingDtTm" }, "receiverBic": { "description": "Receiver BIC", "$ref": "#/components/schemas/ReceiverBic" }, "businessDate": { "description": "Business date (day on which the Service is open)", "$ref": "#/components/schemas/BusinessDate" }, "lastStatusUpdt": { "description": "Last update date and time", "$ref": "#/components/schemas/LastStatusUpdt" }, "drrDetails": { "description": "If reportTp is DRR, then the block element drrDetails must be present", "$ref": "#/components/schemas/DrrDetails" }, "msrDetails": { "$ref": "#/components/schemas/MsrDetails" } }, "required": [ "dateTime", "requestId", "fileTp", "fileStatus", "network", "netFileName", "fileReference", "sendingDtTm", "receiverBic", "businessDate", "lastStatusUpdt" ] }, "FileIntf": { "type": "object", "properties": { "pryFileNetID": { "description": "Primary File Network ID indicates the primary network to communicate with R2P CS", "$ref": "#/components/schemas/PryFileNetID" }, "scyFileNetID": { "description": "Secondary File Network ID, the secondary network to communicate with R2P CS", "$ref": "#/components/schemas/ScyFileNetID" }, "actvOFileNet": { "description": "Active Output File Network", "$ref": "#/components/schemas/ActvOFileNet" }, "pryRcvngFileNetAd": { "description": "Primary Receiving File Network Address indicates the identifier by which this Participant is known on the network when receiving files from the R2P System", "$ref": "#/components/schemas/PryRcvngFileNetAd" }, "scyRcvngFileNetAd": { "description": "Secondary Receiving File Network Address, the identifier by which this Participant is known on the network when receiving files from the R2P System", "$ref": "#/components/schemas/ScyRcvngFileNetAd" }, "drrRqst": { "description": "Flag to indicate if DRR file is required.", "$ref": "#/components/schemas/DrrRqst" }, "msrRqst": { "description": "Flag to indicate if MSR file is required.", "$ref": "#/components/schemas/MsrRqst" }, "rtfRqst": { "description": "Flag to indicate if the RTF file is required", "$ref": "#/components/schemas/RtfRqst" }, "maxFileSize": { "description": "Maximum size of output files sent to this Participant", "$ref": "#/components/schemas/MaxFileSize" }, "compression": { "description": "Flag element to opt for file compression", "$ref": "#/components/schemas/Compression" } }, "required": [ "pryFileNetID", "actvOFileNet", "pryRcvngFileNetAd", "drrRqst", "msrRqst", "rtfRqst", "maxFileSize", "compression" ] }, "FileIntf1": { "type": "object", "properties": { "pryFileNetID": { "description": "Primary File Network ID indicates the primary network to communicate with R2P CS. Following values are allowed:\n▪ SIANet (\"EAS\")\n▪ EBICS (\"EBX\")\n▪ SWIFTNet RT single Request Types, one per File Type (\"SWF\")\n▪ SWIFTNet RT multiple Request Types, one per File Type (\"SWA\")\n▪ SWIFTNet S&F single Request Type, one per File Type (\"SWS\")\n▪ SWIFTNet S&F multiple Request Types, one per File Type (\"SWM\")\n\n **Validation Rule(s)** Mandatory if at least one among drrRqst and msrRqst and rtfRqst is set to “Y”\nXA24 error details: pryFileNetID mandatory if the PSP is configured to receive at least one of the output files available in the service .\n\nXA20: if present, it must be equal to the allowed values.", "$ref": "#/components/schemas/PryFileNetID1" }, "scyFileNetID": { "description": "The network through which this Participant connects to the R2P Service. Following values are allowed:\n SIANet (\"EAS\")\n▪ EBICS (\"EBX\")\n▪ SWIFTNet RT single Request Types, one per File Type (\"SWF\")\n▪ SWIFTNet RT multiple Request Types, one per File Type (\"SWA\")\n▪ SWIFTNet S&F single Request Type, one per File Type (\"SWS\")\n▪ SWIFTNet S&F multiple Request Types, one per File Type (\"SWM\")\n\n **Validation Rule(s)** If the active output file network is not the secondary network (2), then “ZZZ” can be used to remove the secondary file network for all of SPs and CUGs (empty element not allowed).\nXA22: secondary file output network cannot be removed if active output parameter is set equal to 2\nThe active output file networkcan be changed by using the dedicated channelSwitch", "$ref": "#/components/schemas/ScyFileNetID1" }, "actvOFileNet": { "description": "Active Output File Network indicates if the CS shall set up the Primary Network or the Secondary Network to send R2P files to the Participant\n\n **Validation Rule(s)** If drrRqst and msrRqst and rtfRqst are equal to “N” then this field is not allowed\nXA23 error details\nXA20: it must be equal to the allowed value\nXA24 error details: This field must be valued If pryFileNetID is present", "$ref": "#/components/schemas/ActvOFileNet" }, "pryRcvngFileNetAd": { "description": "The identifier by which thethis Participant, configured for using this Solution Purpose, is known on the network when receiving MessagesFiles from the R2P TransactionalFile Layer.\n\n **Validation Rule(s)** XA20: it must be in the allowed format\nAM05: it must be different from scyRcvngFileNetAd\nXA23: field not allowed\nXA24 error details: This field must be valued If pryFileNetID is present\nXA04: mandatory fields depending on the presence of the other fields", "$ref": "#/components/schemas/PryRcvngFileNetAd1" }, "scyRcvngFileNetAd": { "description": "The identifier by which thethis Participant, configured for using this Solution Purpose, is known on the network when receiving MessagesFiles from the R2P TransactionalFile Layer.\n\n **Validation Rule(s)** XA20: it must be in the allowed format\nAM05: it must be different from pryRcvngFileNetAd\nXA23: field not allowed\nXA04: mandatory fields depending on the presence of the other fields", "$ref": "#/components/schemas/ScyRcvngFileNetAd1" }, "drrRqst": { "description": "DRR file\n\n **Validation Rule(s)** XA20: Flag to indicate if DRR file is required.", "$ref": "#/components/schemas/DrrRqst" }, "msrRqst": { "description": "MSR file\n\n **Validation Rule(s)** XA20: Flag to indicate if MSR file is required.", "$ref": "#/components/schemas/MsrRqst" }, "rtfRqst": { "description": "RTF file\n\n **Validation Rule(s)** XA20: it must be equal to the allowed values\nFlag to indicate if RTF file is required.", "$ref": "#/components/schemas/RtfRqst" }, "maxFileSize": { "description": "Maximum size of output files allowed by the Service or the Participant\n\n **Validation Rule(s)** XA15: it must be between minimum file size and max file size allowed (see listServiceConfiguration for retrieving these values)", "$ref": "#/components/schemas/MaxFileSize" }, "compression": { "description": "file compression\n\n **Validation Rule(s)** XA20: it must be equal to the allowed values\nFlag element to opt for file compression.", "$ref": "#/components/schemas/Compression" } } }, "FileIntf2": { "type": "object", "properties": { "pryFileNetID": { "description": "Primary File Network ID indicates the primary network to communicate with R2P CS", "$ref": "#/components/schemas/PryFileNetID2" }, "scyFileNetID": { "description": "Secondary File Network ID, the secondary network to communicate with R2P CS", "$ref": "#/components/schemas/ScyFileNetID2" }, "actvOFileNet": { "description": "Active Output File Network indicates if the CS shall set up the Primary Network or the Secondary Network to send R2P files to the Participant", "$ref": "#/components/schemas/ActvOFileNet1" }, "pryRcvngFileNetAd": { "description": "Primary Receiving File Network Address indicates the identifier by which this Participant is known on the network when receiving files from the R2P System", "$ref": "#/components/schemas/PryRcvngFileNetAd" }, "scyRcvngFileNetAd": { "description": "Secondary Receiving File Network Address, the identifier by which this Participant is known on the network when receiving files from the R2P System", "$ref": "#/components/schemas/ScyRcvngFileNetAd" }, "drrRqst": { "description": "Flag to indicate if DRR file is required.", "$ref": "#/components/schemas/DrrRqst" }, "msrRqst": { "description": "Flag to indicate if MSR file is required.", "$ref": "#/components/schemas/MsrRqst" }, "rtfRqst": { "description": "Flag to indicate if RTF file is required.", "$ref": "#/components/schemas/RtfRqst" }, "maxFileSize": { "description": "Maximum size of output files allowed by the Service or the Participant", "$ref": "#/components/schemas/MaxFileSize" }, "compression": { "description": "Flag element to opt for file compression", "$ref": "#/components/schemas/Compression" } } }, "FileList": { "type": "object", "properties": { "fileTp": { "description": "The type of file", "$ref": "#/components/schemas/FileTp" }, "fileReference": { "description": "The file reference of the file", "$ref": "#/components/schemas/FileReference" }, "sendingDtTm": { "description": "Output timestamp of the CS", "$ref": "#/components/schemas/SendingDtTm" }, "fileStatus": { "description": "The status of the file", "$ref": "#/components/schemas/FileStatus" }, "netFileName": { "description": "Network filename", "$ref": "#/components/schemas/NetFileName" }, "network": { "description": "The network used for the reception/sending of the file", "$ref": "#/components/schemas/Network1" } }, "required": [ "fileTp", "fileReference", "sendingDtTm", "fileStatus", "netFileName", "network" ] }, "FileReference": { "type": "string", "minLength": 1, "maxLength": 16, "examples": [ "DR2P200724000012" ] }, "FileStatus": { "type": "string", "enum": [ "TSG", "TSD", "ERR", "RSN" ], "examples": [ "TSG" ] }, "FileTp": { "type": "string", "enum": [ "DRR", "MSR", "RTF" ], "examples": [ "DRR" ] }, "FlagYN": { "type": "string", "enum": [ "Y", "N" ], "minLength": 1, "maxLength": 1, "examples": [ "Y" ] }, "FrstSndgDtTm": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "GeneralInformation": { "type": "object", "properties": { "participantBic": { "description": "The BIC of participant", "$ref": "#/components/schemas/ParticipantBic" }, "participantName": { "description": "The name of Participant", "$ref": "#/components/schemas/ParticipantName1" }, "initValidityDate": { "description": "The initial validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends from its init validity date (first business operating day)", "$ref": "#/components/schemas/InitValidityDate" }, "endValidityDate": { "description": "The end validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends to its end validity date (the last business operating day)", "$ref": "#/components/schemas/EndValidityDate" }, "rtStatus": { "description": "The routing table status", "$ref": "#/components/schemas/RtStatus" }, "roleChange": { "description": "Flag to specify a role change of the Participant", "$ref": "#/components/schemas/RoleChange" }, "newBic": { "description": "New BIC code assigned to a Participant", "$ref": "#/components/schemas/NewBic" } }, "required": [ "participantBic", "participantName", "initValidityDate", "endValidityDate", "rtStatus" ] }, "GetOriginalMessage": { "type": "string", "enum": [ "Y", "N" ], "examples": [ "Y" ] }, "GetParticipantsRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the request\n\n **Validation Rule(s)** XA20: it must be equal to an allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "participantBic": { "description": "The BIC of participant\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value (BIC8)\nPY01: It must be an enabled, suspended Or inserted Participant", "$ref": "#/components/schemas/ParticipantBic" }, "technicalBic": { "description": "It indicates if the BIC is a technical BIC\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value", "$ref": "#/components/schemas/TechnicalBic" }, "rtStatus": { "description": "Participant status in routing table (e.g. disabled, enabled,…)\n\n **Validation Rule(s)** XA20: it must be equal to one of the allowed values", "$ref": "#/components/schemas/RtStatus" }, "initValidityDate": { "description": "The initial validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends from its init validity date (first business operating day)\n\n **Validation Rule(s)** XA20: it must be equal to an allowed format\nDT01", "$ref": "#/components/schemas/InitValidityDate" }, "endValidityDate": { "description": "The end validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends to its end validity date (the last business operating day)\n\n **Validation Rule(s)** XA20: it must be equal to an allowed format\nDT01", "$ref": "#/components/schemas/EndValidityDate" }, "solutionPurposeId": { "description": "Solution Purpose identification\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value", "$ref": "#/components/schemas/SolutionPurposeId" }, "aosId": { "description": "Additional optional services\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } }, "network": { "description": "Network search criteria field to filter the result for one of the following Participant parameters:\n - Both pryMsgNetID and scyMsgNetID for EAS, EBX, SWI, API values\n - Both pryFileNetID scyFileNetID for EAS, EBX, SWF, SWA, SWS, SWM values\n\nThe null means all network congifurations, no filter applied\n\n **Validation Rule(s)** XA20: it must be equal to one of the allowed values", "$ref": "#/components/schemas/NetId" } }, "required": [ "dateTime" ] }, "GetParticipantsResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "numRcrdList": { "description": "Number of items present in the record-list", "$ref": "#/components/schemas/NumRcrdList" }, "participantList": { "description": "The list of participant", "type": "array", "items": { "$ref": "#/components/schemas/ParticipantList" } } }, "required": [ "dateTime", "requestId", "numRcrdList" ] }, "GrntedPmtReqd": { "type": "boolean", "enum": [ true, false ], "examples": [ true ] }, "IdOfUnavailableParty": { "type": "string", "pattern": "[A-Za-z0-9\\s\\\"\\#\\$\\%\\&\\'\\(\\)\\*\\+\\,\\-\\.\\/\\:\\;\\<\\=\\>\\?\\@\\\\\\_\\`\\{\\}\\~\\]]", "minLength": 0, "maxLength": 33, "examples": [ "ID of Unavailable Party as a free" ] }, "InitParameterValidity": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "InitValidityDate": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "InquiryUnavailabilityRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria1" } }, "required": [ "dateTime" ] }, "InquiryUnavailabilityResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "list": { "type": "array", "items": { "$ref": "#/components/schemas/List" } } }, "required": [ "dateTime" ] }, "InsertReRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and Time of the request\n\n **Validation Rule(s)** XA20: it must be equal to the format allowed\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "initValidityDate": { "description": "First business operating day\n\n **Validation Rule(s)** XA15: init validity date must be greater than the current processing date\nDT01: effective date must be set according to critical parameters management constraints", "$ref": "#/components/schemas/InitValidityDate" }, "participantBic": { "description": "The Bic of Participant. Sender BIC\n\n **Validation Rule(s)** XA20: It must be equal to an allowed value\nPY01: It must not be in status changed or disabled on initValidityDate", "$ref": "#/components/schemas/ParticipantBic" }, "listRe": { "description": "The List of Reachable Entities", "type": "array", "minItems": 1, "maxItems": 250, "items": { "$ref": "#/components/schemas/ListRe" } } }, "required": [ "dateTime", "initValidityDate", "participantBic", "listRe" ] }, "InsertReResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and Time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "Request unique identification", "$ref": "#/components/schemas/RequestId" }, "cmndRfrnc": { "description": "The reference of the command", "$ref": "#/components/schemas/CmndRfrnc" } }, "required": [ "dateTime", "requestId", "cmndRfrnc" ] }, "Installments": { "type": "object", "properties": { "instAmt": { "description": "Instalment amount", "$ref": "#/components/schemas/Amount" }, "instReqExecDt": { "description": "Instalment Requested Execution Date", "$ref": "#/components/schemas/ReceivingDtTm" } }, "required": [ "instAmt", "instReqExecDt" ] }, "InstNmb": { "type": "integer", "minimum": 0, "maximum": 20, "examples": [ 3 ] }, "LastStatusUpdt": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "List": { "type": "object", "properties": { "unavailableBic": { "description": "BIC of the Participant or APSP that is going to be unavailable.\nIf no records are present, an empty list is returned.", "$ref": "#/components/schemas/Bic11" }, "cugsUnavailable": { "description": "List of CUG(s) impacted by the unavailability.\nIf all CUGs are unavailable, the list must include all configured CUGs for the unavailableBic", "$ref": "#/components/schemas/CugsUnavailable" }, "resUnavailability": { "description": "This flag allow Participant to communicate the unavailability for itself and for all its REs\n\nIf not present or “0” then the unavailability impact only the unavailableBic.\n\nIf present and “1” the unavailability impact both unavailableBic and all connected RE(s)", "$ref": "#/components/schemas/ResUnavailability" }, "status": { "description": "It can be:\n- 0 (unavailable)\n- 1 (available)", "$ref": "#/components/schemas/Status" }, "startDateTime": { "description": "Start date and time of unavailability CET / CEST.", "$ref": "#/components/schemas/DateTime" }, "endDateTime": { "description": "End date and time of unavailability CET / CEST.", "$ref": "#/components/schemas/DateTime" }, "durationOfUnavailability": { "description": "Duration of unavailability. Calculated as the difference between “End Date and Time” and “Start Date and Time”. It is provided the number of days, hours, minutes and seconds, where:\nDD=days\nHH=hours\nmm=minutes\nss=seconds", "$ref": "#/components/schemas/DurationOfUnavailability" }, "eventDescription": { "description": "Free text to describe the event that causes the unavailability.\nUTF-8 character set admitted.", "$ref": "#/components/schemas/EventDescription" }, "generationDateTime": { "description": "Message generation Date and Time: it corresponds at the date and time CET/CEST when the admi.004 has been generated", "$ref": "#/components/schemas/DateTime" }, "messageId": { "description": "The admi.004 message Identifier.", "$ref": "#/components/schemas/MessageId" } }, "required": [ "status", "startDateTime", "endDateTime", "durationOfUnavailability", "generationDateTime" ] }, "ListAlertsRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the response\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "alertDtTmFrom": { "description": "The lowest value of the date and time range to search\n\n **Validation Rule(s)** XA15 error details: maximum range allowed between “date from” and “date to” is 5 calendar days\nXA15 error details: “date from” must be lower that “date to”\nXA20: it must be equal to the allowed format\nDT01", "$ref": "#/components/schemas/AlertDtTmFrom" }, "alertDtTmTo": { "description": "The highest value of the date and time range to search\n\n **Validation Rule(s)** XA15 error details: maximum range allowed between “date from” and “date to” is 5 calendar days\nXA15 error details: “date from” must be lower that “date to”\nXA20: it must be equal to the allowed format\nDT01", "$ref": "#/components/schemas/AlertDtTmTo" }, "alertTp": { "description": "Type of the alert\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value", "$ref": "#/components/schemas/AlertTp" }, "alertGroup": { "description": "It indicates the alert category (ex. validation, commands,..)\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value", "$ref": "#/components/schemas/AlertGroup" }, "alertCd": { "description": "Alert code\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value", "$ref": "#/components/schemas/AlertCd" }, "alertDesc": { "description": "Alert Description\n\n **Validation Rule(s)** No case sensitivity for this field\nXA20: it must be equal to the allowed format", "$ref": "#/components/schemas/AlertDesc" } }, "required": [ "dateTime" ] }, "ListAlertsResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "numRcrdList": { "description": "Number of items present in the record-list", "$ref": "#/components/schemas/NumRcrdList" }, "alertList": { "description": "List of Alerts", "type": "array", "items": { "$ref": "#/components/schemas/AlertList" } } }, "required": [ "dateTime", "requestId", "numRcrdList" ] }, "ListCommandsStatusRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "cmndRfrnc": { "description": "Command reference, that is the unique reference identification of the command\n\n **Validation Rule(s)** Use cmndRfrnc to get details of a specific command.\nXA20", "$ref": "#/components/schemas/CmndRfrnc" }, "cmndTp": { "description": "The type of command\n\n **Validation Rule(s)** XA20: it must be equal to one of the allowed values\nAllowed values for Participants are:\n- FILE_RETRANSMISSION\n- RESEND_ALL", "$ref": "#/components/schemas/CmndTp1" }, "cmndStatus": { "description": "The status of a command\n\n **Validation Rule(s)** XA20: it must be equal to one of the allowed values", "$ref": "#/components/schemas/CmndStatus" }, "requestDtTmFrom": { "description": "The lowest value of date and time at which the command has been requested\n\n **Validation Rule(s)** XA15: Allowed range: 5 calendar days between dateFrom and dateTo\nXA20: it must be equal to the allowed format\nDT01", "$ref": "#/components/schemas/RequestDtTmFrom" }, "requestDtTmTo": { "description": "The highest value of date and time at which the command has been requested\n\n **Validation Rule(s)** XA15 Allowed range: 5 calendar days between dateFrom and dateTo\nXA20: it must be equal to the allowed format\nDT01", "$ref": "#/components/schemas/RequestDtTmTo" }, "authRejectDtTmFrom": { "description": "The lowest value of the authentication or rejection date and time for search criteria\n\n **Validation Rule(s)** XA15 Allowed range: 5 calendar days between dateFrom and dateTo\nXA20: it must be equal to the allowed format\nDT01", "$ref": "#/components/schemas/AuthRejectDtTmFrom" }, "authRejectDtTmTo": { "description": "The highest value of the authentication or rejection date and time for search criteria\n\n **Validation Rule(s)** XA15 Allowed range: 5 calendar days between dateFrom and dateTo\nXA20: it must be equal to the allowed format\nDT01", "$ref": "#/components/schemas/AuthRejectDtTmTo" }, "userIssr": { "description": "The issuer of the command\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nXA21", "$ref": "#/components/schemas/UserIssr" }, "userSprvr": { "description": "User who authorized/rejected the command\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nXA21", "$ref": "#/components/schemas/UserSprvr1" } }, "required": [ "dateTime" ] }, "ListCommandsStatusResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "numRcrdList": { "description": "Number of items present in the record-list", "$ref": "#/components/schemas/NumRcrdList" }, "cmndList": { "description": "The list of commands", "type": "array", "items": { "$ref": "#/components/schemas/CmndList" } } }, "required": [ "dateTime", "requestId", "numRcrdList" ] }, "ListFilesRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "fileTp": { "description": "The type of file\n\n **Validation Rule(s)** XA20:it must be equal to one of the configured values", "$ref": "#/components/schemas/FileTp" }, "dateFrom": { "description": "The lowest value of date-range searching\n\n **Validation Rule(s)** Used to match creation date as part of creation date&time of files\nAllowed range: 5 calendar days between dateFrom and dateTo\nXA20: it must be equal to the allowed format\nDT01: it must be previus or equal to the current date", "$ref": "#/components/schemas/DateFrom" }, "dateTo": { "description": "The highest value of date-range searching\n\n **Validation Rule(s)** Used to match creation date as part of creation date&time of messages\nAllowed range: 5 calendar days between dateFrom and dateTo\nXA20: it must be equal to the allowed format\nDT01: it must be grater than or equal to the DateFrom", "$ref": "#/components/schemas/DateTo" }, "timeFrom": { "description": "The oldest timestamp of the sending or receiving of the files by the system\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nDT01: it must be previus or equal to the current time", "$ref": "#/components/schemas/TimeFrom" }, "timeTo": { "description": "The maximum time for which the files are requested\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nIt must be greater than or equal to the TimeFrom (ErrorCode DT01)", "$ref": "#/components/schemas/TimeTo" }, "fileReference": { "description": "File reference created by CS\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value", "$ref": "#/components/schemas/FileReference" }, "netFileName": { "description": "Network filename\n\n **Validation Rule(s)** XA20: it must e equal to the allowed value", "$ref": "#/components/schemas/NetFileName" }, "fileStatus": { "description": "The status of the file\n\n **Validation Rule(s)** XA20:it must be equal to one of the configured values", "$ref": "#/components/schemas/FileStatus" }, "pointer": { "description": "The pointer value is provided by the CS when the number of the response record list is higher than the number of records allowed. It can be used (in the subsequent request) to retrieve the next portion of records\n\n **Validation Rule(s)** If the request is the first one, it must not be filled\nIf the previous response returned the pointer with trail equal to “C”, then it can be used to retrieve the next portion of records.", "$ref": "#/components/schemas/Pointer" } }, "required": [ "dateTime", "fileTp", "dateFrom", "timeFrom" ] }, "ListFilesResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "numRcrdList": { "description": "Number of items present in the record-list", "$ref": "#/components/schemas/NumRcrdList" }, "fileList": { "description": "The list of files", "type": "array", "items": { "$ref": "#/components/schemas/FileList" } }, "pointer": { "description": "The pointer value is provided by the CS when the number of the response record list is higher than the number of records allowed. It can be used (in the subsequent request) to retrieve the next portion of records", "$ref": "#/components/schemas/Pointer" } }, "required": [ "dateTime", "requestId", "numRcrdList" ] }, "ListMessagesRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and time of the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "msgTp": { "description": "the type of the message\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value", "$ref": "#/components/schemas/MsgTp" }, "dateFrom": { "description": "The lowest value of date-range searching\n\n **Validation Rule(s)** • Used to match creation date as part of creation date&time of messages\n• XA15 error details: maximum range Aallowed range: 5 calendar days between “date From” and “date to” is 5 calendar days\n• XA15 error details: “date from” must be lower than “date to”", "$ref": "#/components/schemas/DateFrom" }, "dateTo": { "description": "The highest value of date-range searching\n\n **Validation Rule(s)** • Used to match creation date as part of creation date&time of messages\n• XA15 error details: maximum range allowed between “date from” and “date to” is 5 calendar days\n• XA15 error details: “date from” must be lower that “date to”", "$ref": "#/components/schemas/DateTo" }, "solutionPurposeId": { "description": "Solution Purpose identification\n\n **Validation Rule(s)** At least one basic Solution Purpose must be present\nIf solutionPurposeId is a CUG, then the relevant basic SP must be present in the productList\nXA20: it must be equal to an allowed value\nAM05: only one occurence can be present for each value\nXA22: if APNW is present the value CERT, CBIU are not allowed\nXA22: if APLT is present the values REDI, EMBE are not allowed\nXA22: if RTPP is present the values CERT, REDI, EMBE, CBIU are not allowed", "$ref": "#/components/schemas/SolutionPurposeId" }, "aosId": { "description": "Additional Optional Services Identifier\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nAM05: only one occurence can be present for each value", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } }, "referenceId": { "description": "Unique reference identification\n\n **Validation Rule(s)** • If msgTp is pain.013, then referenceId must be the InstrId\n• If msgTp is pain.014, then referenceId must be the StsId\n• If msgTp is camt.055, then referenceId must be the CxlId\n• If msgTp is pacs.028, then referenceId must be the StsReqId\n• If msgTp is camt.029, then referenceId must be the StsId", "$ref": "#/components/schemas/ReferenceId" }, "endToEndId": { "description": "End To End Identification\n\n **Validation Rule(s)** XA20: it must be equal to the allowed values", "$ref": "#/components/schemas/EndToEndId" }, "amountFrom": { "description": "The lowest value of the amount range to search\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value\nXA15: the value must not be outside the allowed range", "$ref": "#/components/schemas/AmountFrom" }, "amountTo": { "description": "The highest value of the amount range to search\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value\nXA15: the value must not be outside the allowed range", "$ref": "#/components/schemas/AmountTo" }, "debtorBic": { "description": "Debtor BIC\n\n **Validation Rule(s)** Any Bic", "$ref": "#/components/schemas/DebtorBic" }, "creditorBic": { "description": "Creditor BIC\n\n **Validation Rule(s)** Any Bic", "$ref": "#/components/schemas/CreditorBic" }, "msgStatus": { "description": "Status of the message in the Central System\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value", "$ref": "#/components/schemas/MsgStatus" }, "r2pRsnCd": { "description": "The reason code\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value", "$ref": "#/components/schemas/R2pRsnCd" }, "xmlMsgSts": { "description": "The xml message status\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value", "$ref": "#/components/schemas/XmlMsgSts" }, "xmlStsRsn": { "description": "Reason code for non-acceptance as provided in the XML response message by the sender PSP\nFor pain.014 message, it could be in a proprietary or code form\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value", "$ref": "#/components/schemas/XmlStsRsn" }, "expiryDate": { "description": "Expiry date of the payment request (date as part of expiry date and time)\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value\nDT01", "$ref": "#/components/schemas/ExpiryDate" }, "grntedPmtReqd": { "description": "Indicates if a payment guaranteed is requested\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value\nIf a payment guarantee is requested by the Payee, this indicator must be set to “Y”. When NO payment guarantee is requested, this indicator must be set to “N\"", "$ref": "#/components/schemas/GrntedPmtReqd" }, "overdue": { "description": "It indicates if the expiry date has passed\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value\nDT01", "$ref": "#/components/schemas/Overdue" }, "pointer": { "description": "The pointer value is provided by the CS when the number of the response record list is higher than the number of records allowed. It can be used (in the subsequent request) to retrieve the next portion of records\n\n **Validation Rule(s)** If the request is the first one, it must not be filled\nIf the previous response returned the pointer with trail equal to “C”, then it can be used to retrieve the next portion of records", "$ref": "#/components/schemas/Pointer" }, "msgSenderBic": { "description": "senderBic\n\n **Validation Rule(s)** XA24 error details: at least one between senderBIC or receiverBIC must be present\nXA22 error details: either Sender Bic or Receiver Bic or both must be equal to the sender or its own RE", "$ref": "#/components/schemas/MsgSenderBic" }, "msgReceiverBic": { "description": "receiverBic\n\n **Validation Rule(s)** XA24 error details: at least one between senderBIC or receiverBIC must be present\nXA22 error details: either senderBic or receiver Bic or both must be equal to the sender or its own RE", "$ref": "#/components/schemas/MsgReceiverBic" }, "pmtInfId": { "description": "Payment Information Id", "$ref": "#/components/schemas/ReferenceId" }, "withCrdNote": { "description": "Possible criteria to filetr for for Credit notes\n\n **Validation Rule(s)** If not specified then no filter for this search criteria field", "$ref": "#/components/schemas/GrntedPmtReqd" } }, "required": [ "dateTime", "msgTp", "dateFrom", "dateTo" ] }, "ListMessagesResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "numRcrdList": { "description": "Number of items present in the record-list", "$ref": "#/components/schemas/NumRcrdList" }, "msgList": { "description": "The list of messages", "type": "array", "items": { "$ref": "#/components/schemas/MsgList" } }, "pointer": { "description": "The pointer value is provided by the CS when the number of the response record list is higher than the number of records allowed. It can be used (in the subsequent request) to retrieve the next portion of records", "$ref": "#/components/schemas/Pointer" } }, "required": [ "dateTime", "requestId", "numRcrdList" ] }, "ListOperationsRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and Time of the Request\n\n **Validation Rule(s)** XA20: it must correspond to the allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "routingTable": { "description": "The participation type of the BIC\n\n **Validation Rule(s)** XA20: it must correspond to an allowed value. Possible values p=participant and re=reachable entities", "$ref": "#/components/schemas/RoutingTable" }, "userIssr": { "description": "The user who issued the operation\n\n **Validation Rule(s)** XA20: it must correspond to the format of the userID", "$ref": "#/components/schemas/UserIssr" }, "userSprvr": { "description": "The user who Authorized or Rejected the operation\n\n **Validation Rule(s)** XA20: it must correspond to the format of the userID", "$ref": "#/components/schemas/UserSprvr1" }, "participantBic": { "description": "The BIC of the participant BIC8\n\n **Validation Rule(s)** XA04 error details: either Participant BIC or RE Bic must be present\nPY01: it must correspond to the sender BIC", "$ref": "#/components/schemas/ParticipantBic" }, "reBic": { "description": "The BIC of the Reachable Entity\n\n **Validation Rule(s)** XA04 error details: either Participant BIC or RE Bic must be present\nPY01: It must correspond to the reachable entity of the sender BIC", "$ref": "#/components/schemas/ReBic" }, "operationTp": { "description": "The type of operation\n\n **Validation Rule(s)** XA20: it must correspond to an allowed value\nThe participant is allowed to INSERT_BIC (RE Only),REMOVE_BIC,UPDATE_BIC,MASSIVE_RE_INSERT", "$ref": "#/components/schemas/OperationTp" }, "operationStatus": { "description": "The status of operation\n\n **Validation Rule(s)** XA20: it must correspond to an allowed value", "$ref": "#/components/schemas/OperationStatus1" }, "authRejectDt": { "description": "The date and time on which the operation has been authorized or rejected\n\n **Validation Rule(s)** XA20: it must correspond to the allowed format", "$ref": "#/components/schemas/AuthRejectDt" }, "requestDt": { "description": "The request date of the operation\n\n **Validation Rule(s)** XA20: it must correspond to the allowed format", "$ref": "#/components/schemas/RequestDt" }, "effectiveDate": { "description": "Th effective date of the operation\n\n **Validation Rule(s)** XA20: it must correspond to the allowed format", "$ref": "#/components/schemas/EffectiveDate" }, "critical": { "description": "Indicate if a parameter is critical or non critical\n\n **Validation Rule(s)** XA20: it must correspond to an allowed value\nIt must be equal to:\nY=Yes or;\nN=No", "$ref": "#/components/schemas/Critical" } }, "required": [ "dateTime" ] }, "ListOperationsResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and Time of the Response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "The requst ID of the response", "$ref": "#/components/schemas/RequestId" }, "operationsList": { "description": "The list of operations", "type": "array", "items": { "$ref": "#/components/schemas/OperationsList" } } }, "required": [ "dateTime", "requestId" ] }, "ListRe": { "type": "object", "properties": { "reBic": { "description": "The Bic of Reachable Entity\n\n **Validation Rule(s)** AM05: if input BIC is already present in routing table, it must be in status disabled or changed on the operation submission date as well as authorization date\nAM05: each BIC can be present only once in the record list of the request", "$ref": "#/components/schemas/ReBic" }, "reName": { "description": "The name of reachable entity\n\n **Validation Rule(s)** XA20", "$ref": "#/components/schemas/ReName" }, "solutionPurposeId": { "description": "The solution purpose ID\n\n **Validation Rule(s)** At least one basic Solution Purpose must be present\nIf solutionPurposeId is a CUG, then the relevant basic SP must be present in the productList\nXA20: it must be equal to an allowed value\nAM05: only one occurence can be present for each value\nXA22: if APNW is present the value CERT, CBIU are not allowed\nXA22: if APLT is present the values REDI, EMBE are not allowed\nXA22: if RTPP is present the values CERT, REDI, EMBE, CBIU are not allowed", "type": "array", "minItems": 1, "maxItems": 10, "items": { "$ref": "#/components/schemas/SolutionPurposeId2" } }, "aosId": { "description": "Additional optional services identifier\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nAM05: only one occurence can be present for each value", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } } }, "required": [ "reBic", "reName", "solutionPurposeId", "aosId" ] }, "ListRe1": { "type": "object", "properties": { "reBic": { "description": "The BIC of the reachable entity\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nPY01: the RE must be linked to the sender BIC in the service routing table", "$ref": "#/components/schemas/ReBic" }, "cmndRfrnc": { "description": "the unique reference identification of the command\n\n **Validation Rule(s)** XA22 error details: the command reference must be in “executed” status and the end parameter validity must be greater than the current business date.\nXA20: it must be equal to an allowed value\nXA24 error details: command reference must be present\nPY01\nif ListRE= 1 the command reference must be present\nif ListRE>1 the command reference have to be optional", "$ref": "#/components/schemas/CmndRfrnc" }, "newParticipantBic": { "description": "It must be used to change the Participant of the Reachable Entity\n\n **Validation Rule(s)** XA23: field not allowed for participant", "$ref": "#/components/schemas/NewParticipantBic" }, "reName": { "description": "The name of the reachable entity", "$ref": "#/components/schemas/ReName" }, "solutionPurposeId": { "description": "Solution Purpose identification\n\n **Validation Rule(s)** At least one basic Solution Purpose must be present\nIf solutionPurposeId is a CUG, then the relevant basic SP must be present in the productList\nXA20: it must be equal to an allowed value\nAM05: only one occurence can be present for each value\nXA22: if APNW is present the value CERT, CBIU are not allowed\nXA22: if APLT is present the values REDI, EMBE are not allowed\nXA22: if RTPP is present the values CERT, REDI, EMBE, CBIU are not allowed", "type": "array", "minItems": 1, "maxItems": 10, "items": { "$ref": "#/components/schemas/SolutionPurposeId2" } }, "aosId": { "description": "Additional optional services identifier\n\n **Validation Rule(s)** If present, then it will replace (overwrite) all of AOS stored:\nif ALIA and LINK are both configured and the update operation is associated only to LINK, then ALIA will be removed\nUse \"ZZZZ” to delete all of AOS (empty element not allowed)\nXA20\nAM05", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } } }, "required": [ "reBic" ] }, "ListRedaMessagesRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and time of the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "msgTp": { "description": "The type of the message:\n- reda.070\n- reda.071\n- reda.072\n- reda.073\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value", "$ref": "#/components/schemas/MsgRedaTp" }, "dateFrom": { "description": "The lowest value of date-range searching\n\n **Validation Rule(s)** • Used to match processing date as part of processing date&time of messages\n• XA15 error details: maximum range allowed range: 5 calendar days between “date From” and “date to” is 5 calendar days\n• XA15 error details: “date from” must be lower than “date to”", "$ref": "#/components/schemas/DateValue" }, "dateTo": { "description": "The highest value of date-range searching\n\n **Validation Rule(s)** • Used to match processing date as part of processing date&time of messages\n• XA15 error details: maximum range allowed between “date from” and “date to” is 5 calendar days\n• XA15 error details: “date from” must be lower that “date to”", "$ref": "#/components/schemas/DateValue" }, "creationDate": { "description": "Creation Date of a message (date part of XML element CreDtTm)\n\n **Validation Rule(s)** • XA15 error details: “can’t be greater than current date”", "$ref": "#/components/schemas/DateValue" }, "messageID": { "description": "Unique reference identification", "$ref": "#/components/schemas/ReferenceId" }, "status": { "description": "Status of the message in the Central System\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value", "$ref": "#/components/schemas/MsgStatus" }, "debtorBic": { "description": "Debtor BIC\n\n **Validation Rule(s)** Any Bic", "$ref": "#/components/schemas/Bic111" }, "creditorBic": { "description": "Creditor BIC\n\n **Validation Rule(s)** Any Bic", "$ref": "#/components/schemas/Bic111" }, "sender": { "description": "Sender BIC\n\n **Validation Rule(s)** XA24 error details: at least one between sender or receiver must be present\nXA22 error details: either Sender Bic or Receiver Bic or both must be equal to the sender or its own RE", "$ref": "#/components/schemas/Bic111" }, "receiver": { "description": "Receiver BIC\n\n **Validation Rule(s)** XA24 error details: at least one between sender or receiver must be present\nXA22 error details: either Sender Bic or Receiver Bic or both must be equal to the sender or its own RE", "$ref": "#/components/schemas/Bic111" }, "pointer": { "description": "The pointer value is provided by the CS when the number of the response record list is higher than the number of records allowed. It can be used (in the subsequent request) to retrieve the next portion of records\n\n **Validation Rule(s)** If the request is the first one, it must not be filled\nIf the previous response returned the pointer with trail equal to “C”, then it can be used to retrieve the next portion of records", "$ref": "#/components/schemas/Pointer" } }, "required": [ "dateTime", "msgTp", "dateFrom", "dateTo" ] }, "ListRedaMessagesResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and time of the response", "$ref": "#/components/schemas/DateTime" }, "numRcrdList": { "description": "Number of items present in the record-list", "$ref": "#/components/schemas/NumRcrdList" }, "msgList": { "description": "The list of messages", "type": "array", "items": { "$ref": "#/components/schemas/MsgList1" } }, "pointer": { "description": "The pointer value is provided by the CS when the number of the response record list is higher than the number of records allowed. It can be used (in the subsequent request) to retrieve the next portion of records", "$ref": "#/components/schemas/Pointer" } }, "required": [ "dateTime", "numRcrdList" ] }, "ListReOperationDetails": { "type": "object", "properties": { "bicRequested": { "description": "The reachable entity to which the operation refers", "$ref": "#/components/schemas/BicRequested" }, "participantBic": { "description": "If operation is UPDATE_BIC with Participant change this field is equal to the previous Participant BIC\nIf operation is INSERT_BIC Or MASSIVE_RE_INSERT then this field is equal to the Participant BIC of the new RE", "$ref": "#/components/schemas/ParticipantBic1" }, "reName": { "description": "Name of the Reachable Entity", "$ref": "#/components/schemas/ReName" }, "newReBic": { "description": "BIC of the new Reachable Entity", "$ref": "#/components/schemas/NewReBic" }, "newParticipantBic": { "description": "If operation requested Participant change, then this field is equal the new Participant BIC", "$ref": "#/components/schemas/NewParticipantBic1" }, "roleChange": { "description": "Specify a role change of the Participant. This operation is not allowed to participant", "$ref": "#/components/schemas/RoleChange" }, "solutionPurposeId": { "description": "The solution purpose identification", "type": "array", "minItems": 0, "maxItems": 10, "items": { "$ref": "#/components/schemas/SolutionPurposeId3" } }, "aosId": { "description": "Additional Optional Services Identifier", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } } }, "required": [ "bicRequested" ] }, "ListREsRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the request\n\n **Validation Rule(s)** XA20: it must be equal to an allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "reBic": { "description": "The BIC of the reachable entity\n\n **Validation Rule(s)** XA20: it must be equal to an allowe value BIC11\nPY01: it must be enabled, suspended or inserted reachable entity", "$ref": "#/components/schemas/ReBic" }, "participantBic": { "description": "The BIC of participant\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value BIC8\nPY01: it must be enabled, suspended or inserted participant", "$ref": "#/components/schemas/ParticipantBic" }, "reName": { "description": "The name of the reachable entity\n\n **Validation Rule(s)** XA20", "$ref": "#/components/schemas/ReName" }, "rtStatus": { "description": "Participant status in routing table (e.g. disabled, enabled,…)\n\n **Validation Rule(s)** XA20: it must be equal to one of the allowed values", "$ref": "#/components/schemas/RtStatus" }, "solutionPurposeId": { "description": "Solution Purpose identification\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value", "$ref": "#/components/schemas/SolutionPurposeId" }, "aosId": { "description": "Additional Optional Services\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nAM05: only one occurence can be present for each value.", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } } }, "required": [ "dateTime" ] }, "ListREsResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "numRcrdList": { "description": "Number of items present in the record-list", "$ref": "#/components/schemas/NumRcrdList" }, "reList": { "description": "The list of reachable entities", "type": "array", "items": { "$ref": "#/components/schemas/ReList" } } }, "required": [ "dateTime", "requestId", "numRcrdList" ] }, "MaxFileSize": { "type": "integer", "format": "int32", "examples": [ 245000000 ] }, "MessageId": { "type": "string", "pattern": "[A-Za-z0-9+\\-:\\.]{1,35}", "maxLength": 35, "examples": [ "P08M59270578EA544566A8DB7D970D" ] }, "Mrpr": { "type": "object", "properties": { "totNumOfMsgRcv": { "description": "Total number of R2P messages received", "$ref": "#/components/schemas/TotNumOfMsgRcv" }, "totNumP013Rcv": { "description": "Total number of pain.013 received", "$ref": "#/components/schemas/TotNumP013Rcv" }, "totNumP014Rcv": { "description": "Total number of pain.014 received", "$ref": "#/components/schemas/TotNumP014Rcv" }, "totNumP028Rcv": { "description": "Total number of pacs.028 received", "$ref": "#/components/schemas/TotNumP028Rcv" }, "totNumC055Rcv": { "description": "Total number of camt.055 received", "$ref": "#/components/schemas/TotNumC055Rcv" }, "totNumC029Rcv": { "description": "Total number of camt.029 received", "$ref": "#/components/schemas/TotNumC029Rcv" }, "numP013RcvAcwc": { "description": "Number of pain.013 received on the relevant business date and updated as Approved as accepted with change (ACWC)", "$ref": "#/components/schemas/NumP013RcvAcwc" }, "numP013RcvAccp": { "description": "Number of pain.013 received on the relevant business date and updated as accepted customer profile (ACCP).", "$ref": "#/components/schemas/NumP013RcvAccp" }, "numP013RcvApcsAppm": { "description": "Number of pain.013 received on the relevant business date and automatically approved (APCS) or manually approved (APPM)", "$ref": "#/components/schemas/NumP013RcvApcsAppm" }, "numP013RcvActc": { "description": "Number of pain.013 received on the relevant business date and confirmed (ACTC)", "$ref": "#/components/schemas/NumP013RcvActc" }, "numP013RcvAccr": { "description": "Number of pain.013 received on the relevant business date and cancelled (ACCR)", "$ref": "#/components/schemas/NumP013RcvAccr" }, "numP013RcvRjctRjcsRjcm": { "description": "Number of pain.013 received on the relevant business date and updated as rejected (RJCT – RJCS (*) – RJCM)\n(*) Including only pain.013 rejected due to timeout (TM01)", "$ref": "#/components/schemas/NumP013RcvRjctRjcsRjcm" }, "numP014RcvAcwc": { "description": "Number of pain.014 received as approval of a request accepted with change (relevant pain.013 status = ACWC) during the relevant business date", "$ref": "#/components/schemas/NumP014RcvAcwc" }, "numP014RcvAccp": { "description": "Number of pain.014 received as approval of a request accepted without changes (relevant pain.013 status = ACCP) during the relevant business date", "$ref": "#/components/schemas/NumP014RcvAccp" }, "numP014RcvAppm": { "description": "Number of pain.014 received as a result of a manually approval (relevant pain.013 status = APPM) during the relevant business date", "$ref": "#/components/schemas/NumP014RcvAppm" }, "numP014RcvActc": { "description": "Number of pain.014 received as a confirmation (relevant pain.013 status ACTC) during the relevant business date", "$ref": "#/components/schemas/NumP014RcvActc" }, "numP014RcvRjct": { "description": "Number of pain.014 received as reject of a request issued by the Counterparty (relevant pain.013 status = RJCT) or manually by EBA CL (relevant pain.013 status = RJCM) during the relevant business date", "$ref": "#/components/schemas/NumP014RcvRjct" }, "numP014RcvRjcs": { "description": "Number of pain.014 received as rejections generated by CS.\nThis field includes all pain.014 received as a rejection of a message due to validation failure and timeout during the relevant business date", "$ref": "#/components/schemas/NumP014RcvRjcs" }, "numP014RcvNtfd": { "description": "Number of pain.014 received as a response to an investigation", "$ref": "#/components/schemas/NumP014RcvNtfd" }, "numP028RcvNtfd": { "description": "Number of pacs.028 received in status NTFD", "$ref": "#/components/schemas/NumP028RcvNtfd" }, "numC055RcvAccr": { "description": "Number of camt.055 received and accepted (status ACCR)", "$ref": "#/components/schemas/NumC055RcvAccr" }, "numC055RcvRjcr": { "description": "Number of camt.055 received and rejected (status RJCR and RJCS *)\n(*) only rejections due to timeout.", "$ref": "#/components/schemas/NumC055RcvRjcr" }, "numC055RcvNtfd": { "description": "Number of camt.055 received as a response to an investigation (Original Message Name Id = camt.055) during the relevant business date.", "$ref": "#/components/schemas/NumC055RcvNtfd" }, "numC029RcvAccr": { "description": "Number of camt.029 received as acceptance of a cancellation", "$ref": "#/components/schemas/NumC029RcvAccr" }, "numC029RcvRjcr": { "description": "Number of camt.029 received on the relevant business date and updated as “Rejected by CS” RJCS.", "$ref": "#/components/schemas/NumC029RcvRjcr" }, "numC029RcvRjcs": { "description": "Number of camt.029 received as reject of a cancellation", "$ref": "#/components/schemas/NumC029RcvRjcs" }, "numC029RcvNtfd": { "description": "Number of camt.029 received as a response to an investigation (Original Message Name Id = camt.055) during the relevant business date.", "$ref": "#/components/schemas/NumC029RcvNtfd" } }, "required": [ "totNumOfMsgRcv", "totNumP013Rcv", "totNumP014Rcv", "totNumP028Rcv", "totNumC055Rcv", "totNumC029Rcv", "numP013RcvAcwc", "numP013RcvAccp", "numP013RcvApcsAppm", "numP013RcvActc", "numP013RcvAccr", "numP013RcvRjctRjcsRjcm", "numP014RcvAcwc", "numP014RcvAccp", "numP014RcvAppm", "numP014RcvActc", "numP014RcvRjct", "numP014RcvRjcs", "numP014RcvNtfd", "numP028RcvNtfd", "numC055RcvAccr", "numC055RcvRjcr", "numC055RcvNtfd", "numC029RcvAccr", "numC029RcvRjcr", "numC029RcvRjcs", "numC029RcvNtfd" ] }, "Mrps": { "type": "object", "properties": { "totNumOfMsgSnt": { "$ref": "#/components/schemas/TotNumOfMsgSnt" }, "totNumP013Snt": { "description": "Total number of pain.013 sent", "$ref": "#/components/schemas/TotNumP013Snt" }, "totNumP014Snt": { "description": "Total number of pain.014 sent", "$ref": "#/components/schemas/TotNumP014Snt" }, "totNumP028Snt": { "description": "Total number of pain.028 sent", "$ref": "#/components/schemas/TotNumP028Snt" }, "totNumC055Snt": { "description": "Total number of camt.055 sent", "$ref": "#/components/schemas/TotNumC055Snt" }, "totNumC029Snt": { "description": "Total number of camt.029 sent", "$ref": "#/components/schemas/TotNumC029Snt" }, "numP013SntAcwc": { "description": "Number of pain.013 sent during the relevant business date and updated in status “Accepted with Change” (ACWC).", "$ref": "#/components/schemas/NumP013SntAcwc" }, "numP013SntAccp": { "description": "Number of pain.013 sent during the relevant business date and updated in status “Accepted Customer Profile” (ACCP).", "$ref": "#/components/schemas/NumP013SntAccp" }, "numP013SntAcspAppm": { "description": "Number of pain.013 sent during the relevant business date and updated in status “Automatically approved” (APCS) and “Manually approved” (APPM)", "$ref": "#/components/schemas/NumP013SntApcsAppm" }, "numP013SntActc": { "description": "Number of pain.013 sent during the relevant business date and updated in status “Confirmed by PSP” (ACTC)", "$ref": "#/components/schemas/NumP013SntActc" }, "numP013SntAccr": { "description": "Number of pain.013 sent during the relevant business date and updated in status “Request cancelled” (ACCR)", "$ref": "#/components/schemas/NumP013SntAccr" }, "numP013SntRjctRjcm": { "description": "Number of pain.013 sent during the relevant business date and updated in status “Rejected by PSP” (RJCT) and “Manually rejected” (RJCM).", "$ref": "#/components/schemas/NumP013SntRjctRjcm" }, "numP013SntRjcs": { "description": "Number of pain.013 sent during the relevant business date and updated in status “Rejected by CS” (RJCS)", "$ref": "#/components/schemas/NumP013SntRjcs" }, "numP014SntAccp": { "description": "Number of pain.014 sent during the relevant business date and updated as approval of a request accepted without changes (relevant pain.013 status = ACCP)", "$ref": "#/components/schemas/NumP014SntAccp" }, "numP014SntActc": { "description": "Number of pain.014 sent during the relevant business date and updated as a confirmation (relevant pain.013 status = ACTC)", "$ref": "#/components/schemas/NumP014SntActc" }, "numP014SntAcwc": { "description": "Number of pain.014 sent during the relevant business date and updated as approval of a request accepted with change (relevant pain.013 status = ACWC)", "$ref": "#/components/schemas/NumP014SntAcwc" }, "numP014SntRjcs": { "description": "number of pain.014 sent during the relevant business date and updated in status RJCS", "$ref": "#/components/schemas/NumP014SntRjcs" }, "numP014SntRjReq": { "description": "Number of pain.014 sent during the relevant business date and updated as a reject of a request (relevant pain.013 status = RJCT)", "$ref": "#/components/schemas/NumP014SntRjReq" }, "numP028SntNtfd": { "description": "Number of pacs.028 sent during the relevant business date and updated in status “notified” (NTFD)", "$ref": "#/components/schemas/NumP028SntNtfd" }, "numP028SntVali": { "description": "Number of pacs.028 sent during the relevant business date and updated in status “validated” (VALI)", "$ref": "#/components/schemas/NumP028SntVali" }, "numP028SntRjcs": { "description": "Number of pacs.028 sent during the relevant business date and updated in status “Rejected by CS” (RJCS)", "$ref": "#/components/schemas/NumP028SntRjcs" }, "numC055SntNtfd": { "description": "Number of camt.055 sent as investigation on a RfC during the relevant business date and updated in status “notified” (NTFD)", "$ref": "#/components/schemas/NumC055SntNtfd" }, "numC055SntVali": { "description": "Number of camt.055 sent as investigation on a RfC during the relevant business date and updated in status “validated” (VALI)", "$ref": "#/components/schemas/NumC055SntVali" }, "numC055SntAccr": { "description": "Number of camt.055 sent during the relevant business date and updated in status “Request Cancelled” ACCR", "$ref": "#/components/schemas/NumC055SntAccr" }, "numC055SntRjcs": { "description": "Number of camt.055 sent during the relevant business date and updated in status “Rejected by CS” RJCS", "$ref": "#/components/schemas/NumC055SntRjcs" }, "numC055SntRjcr": { "description": "Number of camt.055 sent during the relevant business date and updated in status “Cancellation Rejected” RJCR", "$ref": "#/components/schemas/NumC055SntRjcr" }, "numC029SntAccr": { "description": "Number of camt.029 sent during the relevant business date and updated as acceptance of a cancellation (relevant pain.013 status = ACCR)", "$ref": "#/components/schemas/NumC029SntAccr" }, "numC029SntRjcr": { "description": "Number of camt.029 sent during the relevant business date and updated as a reject of a cancellation (relevant pain.013 status RJCR)", "$ref": "#/components/schemas/NumC029SntRjcr" }, "numC029SntRjcs": { "description": "Number of camt.029 sent during the relevant business date and updated in status “Rejected by CS” RJCS", "$ref": "#/components/schemas/NumC029SntRjcs" } }, "required": [ "totNumOfMsgSnt", "totNumP013Snt", "totNumP014Snt", "totNumP028Snt", "totNumC055Snt", "totNumC029Snt", "numP013SntAcwc", "numP013SntAccp", "numP013SntAcspAppm", "numP013SntActc", "numP013SntAccr", "numP013SntRjctRjcm", "numP013SntRjcs", "numP014SntAccp", "numP014SntActc", "numP014SntAcwc", "numP014SntRjcs", "numP014SntRjReq", "numP028SntNtfd", "numP028SntVali", "numP028SntRjcs", "numC055SntNtfd", "numC055SntVali", "numC055SntAccr", "numC055SntRjcs", "numC055SntRjcr", "numC029SntAccr", "numC029SntRjcr", "numC029SntRjcs" ] }, "MsgDetails": { "type": "object", "properties": { "msgTp": { "description": "Message type", "$ref": "#/components/schemas/MsgTp" }, "receivingDtTm": { "description": "Input Timestamp of the CS", "$ref": "#/components/schemas/ReceivingDtTm" }, "sendingDtTm": { "description": "Output timestamp of the CS", "$ref": "#/components/schemas/SendingDtTm" }, "solutionPurposeId": { "description": "Solution Purpose Identification", "$ref": "#/components/schemas/SolutionPurposeId1" }, "creationDtTm": { "description": "Creation Date&Time of a message (XML element CreDtTm)", "$ref": "#/components/schemas/CreationDtTm" }, "referenceId": { "description": "Reference of the original message", "$ref": "#/components/schemas/ReferenceId" }, "endToEndId": { "description": "End To End Identification", "$ref": "#/components/schemas/EndToEndId1" }, "uuid": { "description": "UUID (EPC RFC 4122) generated by the API client for a specific payload.\n The client must set this value in the Idempotency-Key header and must\n reuse the same UUID when retrying the transmission of the same payload.\n The UUID must not be reused for any different payload.", "$ref": "#/components/schemas/Uuid" }, "debtorBic": { "description": "Debtor BIC", "$ref": "#/components/schemas/DebtorBic" }, "creditorBic": { "description": "Creditor BIC", "$ref": "#/components/schemas/CreditorBic" }, "msgSenderBic": { "description": "Participant BIC sending the request", "$ref": "#/components/schemas/MsgSenderBic1" }, "msgReceiverBic": { "description": "Receiver BIC", "$ref": "#/components/schemas/MsgReceiverBic1" }, "amount": { "description": "Amount of a request to pay", "$ref": "#/components/schemas/Amount" }, "msgStatus": { "description": "The status of the message", "$ref": "#/components/schemas/MsgStatus1" }, "r2pRsnCd": { "description": "The reason code", "$ref": "#/components/schemas/R2pRsnCd" }, "xmlMsgSts": { "description": "The xml message status", "$ref": "#/components/schemas/XmlMsgSts" }, "xmlStsRsn": { "description": "Reason code for non-acceptance as provided in the XML response message by the sender PSP\nFor pain.014 field it could be in a proprietary or code form", "$ref": "#/components/schemas/XmlStsRsn" }, "aosId": { "description": "Additional Optional Service", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } }, "orgnlInformation": { "$ref": "#/components/schemas/OrgnlInformation" }, "expiryDate": { "description": "Expiry date of the payment request (date as part of expiry date and time)", "$ref": "#/components/schemas/ExpiryDate1" }, "overdue": { "description": "It indicates if the expiry date has passed", "$ref": "#/components/schemas/Overdue" }, "acceptedAmt": { "description": "Accepted amount", "$ref": "#/components/schemas/AccptdAmt" }, "accptncDtTm": { "description": "Acceptation date time", "$ref": "#/components/schemas/AccptncDtTm" }, "reqExeDt": { "description": "Requested Execution Date", "$ref": "#/components/schemas/ReqExeDt" }, "grntedPmtReqd": { "description": "Idicates if a payment guaranteed is requested", "$ref": "#/components/schemas/GrntedPmtReqd" }, "pmtInfId": { "description": "Payment Information Id", "$ref": "#/components/schemas/ReferenceId" }, "crdNoteAmt": { "description": "Credit Note Amount", "$ref": "#/components/schemas/Amount" }, "instNmb": { "description": "Number of instalments", "$ref": "#/components/schemas/InstNmb" }, "resourceId": { "description": "Dynamic value into response path for r-messages.\nIt refers to original pain.013 the r-message is referring to", "$ref": "#/components/schemas/ResourceId" }, "cancellationId": { "description": "Dynamic value into response path for investigation on cancellation camt.055.\nIt refers to original cancellation camt.055 the camt.029 is referring to", "$ref": "#/components/schemas/CancellationId" }, "installments": { "description": "Instalments", "$ref": "#/components/schemas/Installments" } }, "required": [ "msgTp", "receivingDtTm", "sendingDtTm", "creationDtTm", "referenceId", "endToEndId", "debtorBic", "creditorBic", "msgSenderBic", "msgReceiverBic", "msgStatus" ] }, "MsgDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the request\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "msgTp": { "description": "Message type\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value", "$ref": "#/components/schemas/MsgTp" }, "creationDtTm": { "description": "Creation Date&Time of a message (XML element CreDtTm)\n\n **Validation Rule(s)** XA20: it must be equal to an allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/CreationDtTm" }, "referenceId": { "description": "Reference of the original message\n\n **Validation Rule(s)** • If msgTp is pain.013, then referenceId is the InstrId\n• If msgTp is pain.014, then referenceId is the StsId\n• If msgTp is camt.055, then referenceId is the CxlId\n• If msgTp is pacs.028, then referenceId is the StsReqId\n• If msgTp is camt.029 then referenceId is the StsId", "$ref": "#/components/schemas/ReferenceId" }, "creditorBic": { "description": "Creditor BIC\n\n **Validation Rule(s)** XA04 error details: either Creditor Bic or Debtor Bic must be present\nXA24 error details: if message type is pain.013 Or camt.055 Or pacs.028, then Creditor Bic must be present\nXA22 error details: if Creditor Bic is present and is not equal to the Sender or its own RE, then the request is not allowed", "$ref": "#/components/schemas/CreditorBic" }, "debtorBic": { "description": "Debtor BIC\n\n **Validation Rule(s)** XA04 error details: either Creditor Bic or Debtor Bic must be present\nXA24 error details: if message type is pain.014 then Debtor Bic must be present\nXA22 error details: if Debtor Bic is present and is not equal to the Sender or its own RE, then the request is not allowed", "$ref": "#/components/schemas/DebtorBic" }, "msgStatus": { "description": "The status of the message\n\n **Validation Rule(s)** XA20: it must be equal to one of the allowed values", "$ref": "#/components/schemas/MsgStatus1" }, "r2pRsnCd": { "description": "Reason code\n\n **Validation Rule(s)** XA20: it must be equal to one of the allowed values", "$ref": "#/components/schemas/R2pRsnCd" }, "getOriginalMessage": { "description": "field used to get the original XML message\n\n **Validation Rule(s)** XA20: it must be equal to the allowed values\nIf getOriginalXml is “true”, then originalXml must be present and msgDetails must not be present\nIf getOriginalXml is “false”, then msgDetails must be present", "$ref": "#/components/schemas/GetOriginalMessage" } }, "required": [ "dateTime", "msgTp", "creationDtTm", "referenceId", "getOriginalMessage" ] }, "MsgDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "originalMessage": { "description": "field used to get the original XML message", "$ref": "#/components/schemas/OriginalMessage" }, "msgDetails": { "$ref": "#/components/schemas/MsgDetails" } }, "required": [ "dateTime", "requestId", "msgDetails" ] }, "MsgIntf": { "type": "object", "properties": { "actvOMsgNet": { "description": "Active Output Message Network indicates if the CS shall set up the Primary Network or the Secondary Network to send R2P messages to the Participant", "$ref": "#/components/schemas/ActvOMsgNet" }, "pryMsgNetID": { "description": "Primary Message Network ID indicates the primary network to communicate with R2P CS", "$ref": "#/components/schemas/PryMsgNetID" }, "scyMsgNetID": { "description": "Secondary Message Network ID, the secondary network to communicate with R2P CS", "$ref": "#/components/schemas/ScyMsgNetID" }, "pryApiEndpoint": { "description": "End point network address, to be compiled if api msg is used as primary way of communication from participant", "$ref": "#/components/schemas/PryApiEndpoint" }, "scyApiEndpoint": { "description": "End point network address, to be compiled if api msg is used as primary way of communication from participant", "$ref": "#/components/schemas/ScyApiEndpoint" }, "participantCommonName": { "description": "Mandatory field if 'API' value has been set for pryMsgNetID or scyMsgNetID network configuration, to be disabled if no API network for participant has been configured.", "$ref": "#/components/schemas/ParticipantCommonName" }, "participantAuthenticationCA": { "description": "Optional field if 'API' value has been set for pryMsgNetID or scyMsgNetID network configuration, to be disabled if no API network for participant has been configured.", "$ref": "#/components/schemas/ParticipantAuthenticationCA" }, "redaMsgAllwd": { "description": "Flag (Y/N) indicates if Participant is allowed or not to send/receive reda messages for activation.", "$ref": "#/components/schemas/FlagYN" }, "productList": { "description": "Solution Purposes configurations", "type": "array", "minItems": 1, "maxItems": 10, "items": { "$ref": "#/components/schemas/ProductList" } }, "aosId": { "description": "Additional Optional Identifier", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } } }, "required": [ "actvOMsgNet", "pryMsgNetID", "redaMsgAllwd", "productList" ] }, "MsgIntf1": { "type": "object", "properties": { "solutionPurposeId": { "description": "Solution Purpose identification", "type": "array", "minItems": 1, "maxItems": 10, "items": { "$ref": "#/components/schemas/SolutionPurposeId2" } }, "aosId": { "description": "Additional optional service identifier", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } } }, "required": [ "solutionPurposeId" ] }, "MsgIntf2": { "type": "object", "properties": { "pryMsgNetID": { "description": "Primary Message Network ID indicates the primary network to communicate with R2P CS\n\n **Validation Rule(s)** XA20: It must be equal to the allowed network", "$ref": "#/components/schemas/PryMsgNetID" }, "scyMsgNetID": { "description": "Secondary Message Network ID, the secondary network to communicate with R2P CS\n\n **Validation Rule(s)** If the active output msg network is not the secondary network (2), then “ZZZ” can be used to remove the secondary message network for all of SPs and CUGs (empty element not allowed)\nXA22: secondary message network cannot be removed because is active", "$ref": "#/components/schemas/ScyMsgNetID" }, "participantCommonName": { "description": "Name under which the Participant is recognised by the CS in the handshaking phase\n\n **Validation Rule(s)** Mandatory field if 'API' value has been set for pryMsgNetID or scyMsgNetID network configuration, to be disabled if no API network for participant has been configured.", "$ref": "#/components/schemas/ParticipantCommonName" }, "participantAuthenticationCA": { "description": "name of the CA (certification authority) that issued the certificate used by the participant\n\n **Validation Rule(s)** Optional field if 'API' value has been set for pryMsgNetID or scyMsgNetID network configuration, to be disabled if no API network for participant has been configured.", "$ref": "#/components/schemas/ParticipantAuthenticationCA" }, "pryApiEndpoint": { "description": "End point network address, to be compiled if api msg is used as primary way of communication from participant\n\n **Validation Rule(s)** To be compiled if api msg is used as primary way of communication from participant\nXA23: field not allowed\nXA04: mandatory fields depending on the presence of the other fields", "$ref": "#/components/schemas/PryApiEndpoint" }, "scyApiEndpoint": { "description": "End point network address, to be compiled if api msg is used as primary way of communication from participant\n\n **Validation Rule(s)** To be compiled if api msg is used as primary way of communication from participant\nXA23: field not allowed\nXA04: mandatory fields depending on the presence of the other fields", "$ref": "#/components/schemas/ScyApiEndpoint" }, "redaMsgAllwd": { "description": "Flag (Y/N) indicates if Participant is allowed or not to send/receive reda messages for activation.\n\n **Validation Rule(s)** Allowed values:\nY – can exchange reda message\nN – can’t exchange reda message\nXA20: it must be equal to the allowed value", "$ref": "#/components/schemas/FlagYN" }, "productList": { "type": "array", "items": { "$ref": "#/components/schemas/ProductList1" } }, "aosId": { "description": "Additional Optional Service identifier signed by the PSP\n\n **Validation Rule(s)** If present, then it will replace (overwrite) all of AOS stored:\nif ALIA and LINK are both configured and the update operation is associated only to LINK, then ALIA will be removed\nUse \"ZZZZ” to delete all of AOS (empty element not allowed)\nXA20\nAM05", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } } }, "required": [ "redaMsgAllwd" ] }, "MsgIntf3": { "type": "object", "properties": { "actvOMsgNet": { "description": "Active Output Message Network indicates if the CS shall set up the Primary Network or the Secondary Network to send R2P messages to the Participant", "$ref": "#/components/schemas/ActvOMsgNet" }, "pryMsgNetID": { "description": "Primary Message Network ID indicates the primary network to communicate with R2P CS", "$ref": "#/components/schemas/PryMsgNetID" }, "scyMsgNetID": { "description": "Secondary Message Network ID, the secondary network to communicate with R2P CS", "$ref": "#/components/schemas/ScyMsgNetID" }, "pryApiEndpoint": { "description": "End point network address, to be compiled if api msg is used as primary way of communication from participant", "$ref": "#/components/schemas/PryApiEndpoint" }, "scyApiEndpoint": { "description": "End point network address, to be compiled if api msg is used as primary way of communication from participant", "$ref": "#/components/schemas/ScyApiEndpoint" }, "participantCommonName": { "description": "Mandatory field if 'API' value has been set for pryMsgNetID or scyMsgNetID network configuration, to be disabled if no API network for participant has been configured.", "$ref": "#/components/schemas/ParticipantCommonName" }, "participantAuthenticationCA": { "description": "Optional field if 'API' value has been set for pryMsgNetID or scyMsgNetID network configuration, to be disabled if no API network for participant has been configured.", "$ref": "#/components/schemas/ParticipantAuthenticationCA" }, "aosId": { "description": "Additional Optional Service identifier signed by the PSP", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } }, "productList": { "type": "array", "minItems": 1, "maxItems": 10, "items": { "$ref": "#/components/schemas/ProductList2" } } } }, "MsgList": { "type": "object", "properties": { "solutionPurposeId": { "description": "Solution Purpose Identification", "$ref": "#/components/schemas/SolutionPurposeId" }, "aosId": { "description": "Additional Optional Services", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } }, "msgTp": { "description": "Message Type", "$ref": "#/components/schemas/MsgTp" }, "creationDtTm": { "description": "Creation Date&Time of a message (XML element CreDtTm)", "$ref": "#/components/schemas/CreationDtTm" }, "referenceId": { "description": "Reference ID of the message", "$ref": "#/components/schemas/ReferenceId" }, "amount": { "description": "Amount of a request to pay", "$ref": "#/components/schemas/Amount" }, "endToEndId": { "description": "End To End Identification", "$ref": "#/components/schemas/EndToEndId" }, "creditorBic": { "description": "The creditor BIC", "$ref": "#/components/schemas/CreditorBic" }, "debtorBic": { "description": "The debtor BIC", "$ref": "#/components/schemas/DebtorBic" }, "msgStatus": { "description": "The status of the message", "$ref": "#/components/schemas/MsgStatus" }, "r2pRsnCd": { "description": "The reason code", "$ref": "#/components/schemas/R2pRsnCd" }, "xmlMsgSts": { "description": "Status reason response code as provided in the XML response message by the sender PSP", "$ref": "#/components/schemas/XmlMsgSts" }, "xmlStsRsn": { "description": "Reason code for non-acceptance as provided in the XML response message by the sender PSP\nFor pain.024 message, it could be in a proprietary or code form", "$ref": "#/components/schemas/XmlStsRsn" }, "expiryDate": { "description": "Expiry date of the payment request (date as part of expiry date and time)", "$ref": "#/components/schemas/ExpiryDate" }, "grntedPmtReqd": { "description": "Indicates if a payment guaranteed is requested", "$ref": "#/components/schemas/GrntedPmtReqd" }, "overdue": { "description": "It indicates if the expiry date has passed", "$ref": "#/components/schemas/Overdue" }, "pmtInfId": { "description": "Payment Information Id", "$ref": "#/components/schemas/ReferenceId" }, "crdNoteAmt": { "description": "Credit Note Amount", "$ref": "#/components/schemas/Amount" } }, "required": [ "msgTp", "creationDtTm", "referenceId", "endToEndId", "creditorBic", "debtorBic", "msgStatus" ] }, "MsgList1": { "type": "object", "properties": { "msgTp": { "description": "Message Type:\n- reda.070\n- reda.071\n- reda.072\n- reda.073", "$ref": "#/components/schemas/MsgRedaTp" }, "processingDT": { "description": "Processing date&time", "$ref": "#/components/schemas/CreationDtTm" }, "creationDtTm": { "description": "Creation Date&Time of a message (XML element CreDtTm)", "$ref": "#/components/schemas/CreationDtTm" }, "msgId": { "description": "Message ID", "$ref": "#/components/schemas/ReferenceId" }, "status": { "description": "The status of the message", "$ref": "#/components/schemas/MsgStatus" }, "reason": { "description": "Reason for eventual rejection of the message", "$ref": "#/components/schemas/XmlStsRsn" }, "creditorBic": { "description": "The creditor BIC", "$ref": "#/components/schemas/Bic111" }, "debtorBic": { "description": "The debtor BIC", "$ref": "#/components/schemas/Bic111" }, "sender": { "description": "Sender BIC", "$ref": "#/components/schemas/Bic111" }, "receiver": { "description": "Receiver BIC", "$ref": "#/components/schemas/Bic111" } }, "required": [ "msgTp", "processingDT", "creationDtTm", "msgId", "status", "creditorBic", "debtorBic", "sender", "receiver" ] }, "MsgReceiverBic": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "examples": [ "RTPDID21" ] }, "MsgReceiverBic1": { "description": "msgReceiverBic", "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "examples": [ "RTPDID21" ] }, "MsgRedaTp": { "type": "string", "enum": [ "reda.070", "reda.071", "reda.072", "reda.073" ], "examples": [ "reda.070" ] }, "MsgSenderBic": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "examples": [ "RTPDID21" ] }, "MsgSenderBic1": { "description": "msgSenderBic", "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "examples": [ "RTPDID21" ] }, "MsgStatus": { "type": "string", "enum": [ "INFL", "RJCS", "RJCT", "NTFD", "VALI", "ACTC", "ACCP", "ACWC", "ACCR", "RJCR", "APPM", "RJCM", "APCS" ], "examples": [ "INFL" ] }, "MsgStatus1": { "type": "string", "enum": [ "INFL", "RJCS", "RJCT", "NTFD", "VALI", "ACTC", "ACCP", "ACWC", "APCS", "ACCR", "RJCR", "APPM", "RJCM" ], "examples": [ "INFL" ] }, "MsgTp": { "type": "string", "pattern": "(pain\\.013){1}|(pain\\.014){1}|(pacs\\.028){1}|(camt\\.055){1}|(camt\\.029){1}", "examples": [ "pain.013" ] }, "MsrDetails": { "type": "object", "properties": { "mrps": { "$ref": "#/components/schemas/Mrps" }, "mrpr": { "$ref": "#/components/schemas/Mrpr" } }, "required": [ "mrps", "mrpr" ] }, "MsrRqst": { "type": "string", "enum": [ "Y", "N" ], "examples": [ "Y" ] }, "NetFileName": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "PR02R2PRTPDID21200724003002011.D" ] }, "NetId": { "type": "string", "enum": [ "EAS", "EBX", "SWA", "SWF", "ZZZ", "SWS", "SWM", "SWI", "API" ], "pattern": "\\S+.*", "examples": [ "EAS" ] }, "Network": { "type": "string", "enum": [ "EAS", "EBX", "ZZZ", "SWA", "SWF", "SWS", "SWM" ], "examples": [ "EAS" ] }, "Network1": { "type": "string", "enum": [ "EAS", "EBX", "ZZZ", "SWS", "SWA", "SWM", "SWF" ], "examples": [ "EAS" ] }, "NewBic": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "examples": [ "RTPDID21" ] }, "NewParticipantBic": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}", "examples": [ "RTPDID21" ] }, "NewParticipantBic1": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3})", "examples": [ "RTPDID21ABC" ] }, "NewReBic": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3})", "examples": [ "RTPDID21ABC" ] }, "NumC029RcvAccr": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumC029RcvNtfd": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumC029RcvRjcr": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumC029RcvRjcs": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumC029SntAccr": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumC029SntRjcr": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumC029SntRjcs": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumC055RcvAccr": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumC055RcvNtfd": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumC055RcvRjcr": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumC055SntAccr": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumC055SntNtfd": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumC055SntRjcr": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumC055SntRjcs": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumC055SntVali": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP013RcvAccp": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP013RcvAccr": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP013RcvActc": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP013RcvAcwc": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP013RcvApcsAppm": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP013RcvRjctRjcsRjcm": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP013SntAccp": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP013SntAccr": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP013SntActc": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP013SntAcwc": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP013SntApcsAppm": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP013SntRjcs": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP013SntRjctRjcm": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP014RcvAccp": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP014RcvActc": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP014RcvAcwc": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP014RcvAppm": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP014RcvNtfd": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP014RcvRjcs": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP014RcvRjct": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP014SntAccp": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP014SntActc": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP014SntAcwc": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP014SntRjcs": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP014SntRjReq": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP028RcvNtfd": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP028SntNtfd": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP028SntRjcs": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumP028SntVali": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "NumRcrdList": { "type": "integer", "format": "int32", "examples": [ 1 ] }, "OperationItem": { "type": "object", "properties": { "requestDtTm": { "description": "Date&Time at which the command has been requested", "$ref": "#/components/schemas/RequestDtTm" }, "cmndRfrnc": { "description": "Command reference, that is the unique reference identification of the command", "$ref": "#/components/schemas/CmndRfrnc" }, "cmndStatus": { "description": "The status of the command", "$ref": "#/components/schemas/CmndStatus" } }, "required": [ "requestDtTm", "cmndRfrnc", "cmndStatus" ] }, "OperationItem1": { "type": "object", "properties": { "requestDtTm": { "description": "Date&Time at which the command has been requested", "$ref": "#/components/schemas/RequestDtTm1" }, "cmndRfrnc": { "description": "Command reference, that is the unique reference identification of the command", "$ref": "#/components/schemas/CmndRfrnc" }, "cmndStatus": { "description": "The status of a command", "$ref": "#/components/schemas/CmndStatus" } }, "required": [ "requestDtTm", "cmndRfrnc", "cmndStatus" ] }, "OperationsList": { "type": "object", "properties": { "cmndRfrnc": { "description": "The unique ID reference of the command", "$ref": "#/components/schemas/CmndRfrnc" }, "routingTable": { "description": "The participation type of the BIC", "$ref": "#/components/schemas/RoutingTable" }, "userIssr": { "description": "The user who issued the operation", "$ref": "#/components/schemas/UserIssr" }, "userSprvr": { "description": "The user who authorized or rejected the operation", "$ref": "#/components/schemas/UserSprvr1" }, "participantBic": { "description": "The BIC of the participant BIC8", "$ref": "#/components/schemas/ParticipantBic" }, "reBic": { "description": "The BIC of the reachable entity", "$ref": "#/components/schemas/ReBic" }, "operationTp": { "description": "Te type of operation\nThe participant is allowed to INSERT_BIC,REMOVE_BIC,UPDATE_BIC,MASSIVE_RE_INSERT", "$ref": "#/components/schemas/OperationTp" }, "operationStatus": { "description": "The status of operation", "$ref": "#/components/schemas/OperationStatus1" }, "requestDtTm": { "description": "The request date and time of the operation", "$ref": "#/components/schemas/RequestDtTm" }, "authRejectDtTm": { "description": "The date and time on which the operation has been authorized or rejected", "$ref": "#/components/schemas/AuthRejectDtTm" }, "effectiveDate": { "description": "The effective date of the operation", "$ref": "#/components/schemas/EffectiveDate" }, "critical": { "description": "Indicate if a parameter is critical or non critical", "$ref": "#/components/schemas/Critical" } }, "required": [ "cmndRfrnc", "routingTable", "userIssr", "operationTp", "operationStatus", "effectiveDate", "critical" ] }, "OperationStatus": { "type": "string", "enum": [ "WTG", "EXE", "RJT", "RJS", "SUB" ], "examples": [ "WTG" ] }, "OperationStatus1": { "type": "string", "enum": [ "WTG", "SUB", "ATH", "RJT", "RJS", "EXE" ], "minLength": 1, "maxLength": 3, "examples": [ "WTG" ] }, "OperationTp": { "type": "string", "enum": [ "AMEND_REMOVE_BIC", "AMEND_INSERT_BIC", "AMEND_UPDATE_BIC", "CHANGE_BIC", "INSERT_BIC", "REMOVE_BIC", "RESUME_BIC", "REVOKE_REMOVE_BIC", "REVOKE_INSERT_BIC", "REVOKE_UPDATE_BIC", "ROLE_CHANGE_INS_P2RE", "ROLE_CHANGE_MERGE_P2RE", "ROLE_CHANGE_INS_RE2P", "ROLE_CHANGE_MERGE_RE2P", "SUSPEND_BIC", "UPDATE_BIC", "MASSIVE_RE_INSERT", "MASSIVE_RE_UPDATE" ], "examples": [ "UPDATE_BIC" ] }, "OrgnlAmount": { "type": "number", "format": "double", "examples": [ 10000.01 ] }, "OrgnlCreditorBic": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "examples": [ "RTPDID21" ] }, "OrgnlDebtorBic": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "examples": [ "RTPDID21" ] }, "OrgnlEndToEnd": { "type": "string", "minLength": 0, "maxLength": 35, "examples": [ "2306211013CC" ] }, "OrgnlInformation": { "type": "object", "properties": { "orgnlDebtorBic": { "description": "Original Debtor BIC", "$ref": "#/components/schemas/OrgnlDebtorBic" }, "orgnlCreditorBic": { "description": "Original Creditor BIC", "$ref": "#/components/schemas/OrgnlCreditorBic" }, "orgnlReferenceId": { "description": "Reference of the original message", "$ref": "#/components/schemas/OrgnlReferenceId" }, "orgnlAmount": { "description": "Original amount", "$ref": "#/components/schemas/OrgnlAmount" }, "orgnlEndToEnd": { "description": "Original End To End Identification", "$ref": "#/components/schemas/OrgnlEndToEnd" } }, "required": [ "orgnlDebtorBic", "orgnlCreditorBic", "orgnlReferenceId", "orgnlEndToEnd" ] }, "OrgnlReferenceId": { "type": "string", "minLength": 0, "maxLength": 35, "examples": [ "2306211715YY" ] }, "OriginalMessage": { "type": "string", "examples": [ "2306211715YY" ] }, "Overdue": { "type": "string", "enum": [ "Y", "N" ], "examples": [ "Y" ] }, "ParameterDetails": { "type": "object", "properties": { "initParameterValidity": { "description": "The initial validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends from its init validity date (first business operating day)", "$ref": "#/components/schemas/InitParameterValidity" }, "endParameterValidity": { "description": "The end validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends to its end validity date (the last business operating day)", "$ref": "#/components/schemas/EndParameterValidity" }, "participantBic": { "description": "The BIC of participant", "$ref": "#/components/schemas/ParticipantBic" }, "rtStatus": { "description": "Participant status in routing table (e.g. disabled, enabled,…)", "$ref": "#/components/schemas/RtStatus" } }, "required": [ "initParameterValidity", "endParameterValidity", "participantBic", "rtStatus" ] }, "ParametersModificationHistory": { "type": "object", "properties": { "cmndRfrnc": { "description": "Command reference, that is the unique reference identification of the command\nRelated to the relevant change", "$ref": "#/components/schemas/CmndRfrnc" }, "participantBic": { "description": "The BIC of participant", "$ref": "#/components/schemas/ParticipantBic" }, "participantName": { "description": "The name of Participant", "$ref": "#/components/schemas/ParticipantName1" }, "technicalBic": { "description": "It indicates if the BIC is a technical BIC", "$ref": "#/components/schemas/TechnicalBic" }, "initParameterValidity": { "description": "The initial validity date of a time-related validity parameters change", "$ref": "#/components/schemas/InitParameterValidity" }, "endParameterValidity": { "description": "The end validity date of a time-related validity parameters change", "$ref": "#/components/schemas/EndParameterValidity" }, "participantParameters": { "$ref": "#/components/schemas/ParticipantParameters" } }, "required": [ "cmndRfrnc", "participantBic", "participantName", "technicalBic", "initParameterValidity", "endParameterValidity" ] }, "ParametersModificationHistory1": { "type": "object", "properties": { "cmndRfrnc": { "description": "command reference related to the relevant change", "$ref": "#/components/schemas/CmndRfrnc1" }, "reBic": { "description": "The BIC of the reachable entity", "$ref": "#/components/schemas/ReBic" }, "reName": { "description": "The name of reachable entity", "$ref": "#/components/schemas/ReName" }, "participantBic": { "description": "The BIC of participant", "$ref": "#/components/schemas/ParticipantBic" }, "initParameterValidity": { "description": "The initial validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends from its init validity date (first business operating day)", "$ref": "#/components/schemas/InitParameterValidity" }, "endParameterValidity": { "description": "The end validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends to its end validity date (the last business operating day)", "$ref": "#/components/schemas/EndParameterValidity" }, "solutionPurposeId": { "description": "Solution Purpose identification", "type": "array", "minItems": 1, "maxItems": 10, "items": { "$ref": "#/components/schemas/SolutionPurposeId2" } }, "aosId": { "description": "Additional optional service identifier", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } }, "reParameters": { "$ref": "#/components/schemas/ReParameters" } }, "required": [ "cmndRfrnc", "reBic", "reName", "participantBic", "initParameterValidity", "endParameterValidity" ] }, "ParticipantAuthenticationCA": { "type": "string", "minLength": 0, "maxLength": 35, "examples": [ "AuthenticationCA Name" ] }, "ParticipantBic": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}", "examples": [ "RTPDID21" ] }, "ParticipantBic1": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "examples": [ "RTPDID21" ] }, "ParticipantCommonName": { "type": "string", "minLength": 0, "maxLength": 2048, "examples": [ "service-auth-01" ] }, "ParticipantDetails": { "type": "object", "properties": { "participantBic": { "description": "The BIC of participant", "$ref": "#/components/schemas/ParticipantBic" }, "participantName": { "description": "The name of Participant", "$ref": "#/components/schemas/ParticipantName1" }, "technicalBic": { "description": "It indicates if the BIC is a technical BIC", "$ref": "#/components/schemas/TechnicalBic" }, "rtStatus": { "description": "The routing table status", "$ref": "#/components/schemas/RtStatus" }, "initValidityDate": { "description": "The initial validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends from its init validity date (first business operating day)", "$ref": "#/components/schemas/InitValidityDate" }, "endValidityDate": { "description": "The end validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends to its end validity date (the last business operating day)", "$ref": "#/components/schemas/EndValidityDate" } }, "required": [ "participantBic", "participantName", "technicalBic", "rtStatus", "initValidityDate", "endValidityDate" ] }, "ParticipantDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "participantDetails": { "$ref": "#/components/schemas/ParticipantDetails" }, "parametersModificationHistory": { "type": "array", "items": { "$ref": "#/components/schemas/ParametersModificationHistory" } } }, "required": [ "dateTime", "requestId" ] }, "ParticipantList": { "type": "object", "properties": { "participantBic": { "description": "The Participant BIC", "$ref": "#/components/schemas/ParticipantBic" }, "participantName": { "description": "The name of Participant", "$ref": "#/components/schemas/ParticipantName" }, "technicalBic": { "description": "It indicates if the BIC is a technical BIC", "$ref": "#/components/schemas/TechnicalBic" }, "rtStatus": { "description": "Participant status in routing table (e.g. disabled, enabled,…)", "$ref": "#/components/schemas/RtStatus" }, "initValidityDate": { "description": "The initial validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends from its init validity date (first business operating day)", "$ref": "#/components/schemas/InitValidityDate" }, "endValidityDate": { "description": "The end validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends to its end validity date (the last business operating day)", "$ref": "#/components/schemas/EndValidityDate" }, "solutionPurposeId": { "description": "Solution Purpose identification", "$ref": "#/components/schemas/SolutionPurposeId" }, "aosId": { "description": "Additional Optional services", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } } }, "required": [ "participantBic", "participantName", "technicalBic", "rtStatus" ] }, "ParticipantName": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "Merrill Lynch" ] }, "ParticipantName1": { "type": "string", "pattern": "\\S+.*", "minLength": 1, "maxLength": 50, "examples": [ "Merrill Lynch" ] }, "ParticipantName2": { "type": "string", "examples": [ "Merrill Lynch" ] }, "ParticipantOperationDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "The reqeust ID of the response", "$ref": "#/components/schemas/RequestId" }, "cmndRfrnc": { "$ref": "#/components/schemas/CmndRfrnc2" }, "operationTp": { "description": "Te type of operation\nThe participant is allowed to INSERT_BIC,REMOVE_BIC,UPDATE_BIC,MASSIVE_RE_INSERT", "$ref": "#/components/schemas/OperationTp" }, "operationStatus": { "description": "The status of operation", "$ref": "#/components/schemas/OperationStatus" }, "userIssr": { "description": "the user who issued the operation", "$ref": "#/components/schemas/UserIssr" }, "userSprvr": { "description": "the user who authorized or reject the operation", "$ref": "#/components/schemas/UserSprvr1" }, "requestDtTm": { "description": "The request date and time of the operation", "$ref": "#/components/schemas/RequestDtTm" }, "authRejectDtTm": { "description": "The date and time on which the operation has been authorized or rejected", "$ref": "#/components/schemas/AuthRejectDtTm" }, "effectiveDate": { "description": "The effective date of the operation", "$ref": "#/components/schemas/EffectiveDate" }, "bicRequested": { "description": "This field is equal to the previous BIC for which the operation has been performed", "$ref": "#/components/schemas/BicRequested" }, "participantName": { "description": "The name of the participant", "$ref": "#/components/schemas/ParticipantName2" }, "newParticipantBic": { "description": "This field is equal to the new BIC if EBACL performed a change role or a change BIC operation", "$ref": "#/components/schemas/NewParticipantBic" }, "roleChange": { "description": "This field indicates whether EBACL performed a change role operation on the relevant BIC", "$ref": "#/components/schemas/RoleChange" }, "technicalBic": { "description": "The technical BIC", "$ref": "#/components/schemas/TechnicalBic" }, "fileIntf": { "$ref": "#/components/schemas/FileIntf2" }, "msgIntf": { "$ref": "#/components/schemas/MsgIntf3" }, "critical": { "description": "Indicate if a parameter is critical or non critical", "$ref": "#/components/schemas/Critical" } }, "required": [ "dateTime", "requestId", "cmndRfrnc", "operationTp", "operationStatus", "userIssr", "requestDtTm", "effectiveDate", "bicRequested" ] }, "ParticipantParameters": { "type": "object", "properties": { "generalInformation": { "$ref": "#/components/schemas/GeneralInformation" }, "fileIntf": { "$ref": "#/components/schemas/FileIntf" }, "msgIntf": { "$ref": "#/components/schemas/MsgIntf" } }, "required": [ "generalInformation", "fileIntf", "msgIntf" ] }, "Pointer": { "type": "string", "pattern": "[0-9]{3}[CL]{1}", "examples": [ "001C" ] }, "ProductList": { "type": "object", "properties": { "solutionPurposeId": { "description": "Solution Purposes Identification", "$ref": "#/components/schemas/SolutionPurposeId" }, "pryRcvgNetAd": { "description": "Primary Receiving Network Address indicates the identifier by which the Participant is known on the network when receiving messages from the R2P message Layer", "$ref": "#/components/schemas/PryRcvgNetAd" }, "secRcvgNetAd": { "description": "Secondary Receiving Network Address, the identifier by which this Participant, configured for using this Product Type, is known on the network when receiving messages from the R2P Transactional Layer.", "$ref": "#/components/schemas/SecRcvgNetAd" }, "prySndgNetAd": { "description": "Primary Sending Network Address indicates the identifier by which the Participant is known on the network when sending messages to the R2P message Layer", "$ref": "#/components/schemas/PrySndgNetAd" }, "secSndgNetAd": { "description": "The identifier by which this Participant, configured for using this Product Type, is known on the network when sending messages from the R2P Transactional Layer.", "$ref": "#/components/schemas/SecSndgNetAd" } }, "required": [ "solutionPurposeId", "pryRcvgNetAd", "prySndgNetAd" ] }, "ProductList1": { "type": "object", "properties": { "actionType": { "description": "Indicates the action type of update on the product (ex. insert, remove..)\n\n **Validation Rule(s)** If input solutionPurposeId is the only SP stored, then “remove” is not allowed\nIf input solutionPurposeId is already present as SP stored, then “insert” is not allowed\nIf input solutionPurposeId is not present as SP stored, then “update” is not allowed", "$ref": "#/components/schemas/ActionType" }, "solutionPurposeId": { "description": "Solution Purpose identification\n\n **Validation Rule(s)** At least one basic Solution Purpose must be present\nIf solutionPurposeId is a CUG, then the relevant basic SP must be present in the productList\nXA20: it must be equal to an allowed value\nAM05: only one occurence can be present for each value\nXA22: if APNW is present the value CERT, CBIU are not allowed\nXA22: if APLT is present the values REDI, EMBE are not allowed\nXA22: if RTPP is present the values CERT, REDI, EMBE, CBIU are not allowed", "$ref": "#/components/schemas/SolutionPurposeId" }, "pryRcvgNetAd": { "description": "Primary Receiving Network Address indicates the identifier by which the Participant is known on the network when receiving messages from the R2P message Layer\n\n **Validation Rule(s)** If pryMsgNetID is equal to SWIFTNet, SIANet, EBICS, then the field may be present\nXA20: It must be set in the allowed format\nAM05: it must be different from scyRcvngNetAd\nXA23: field not allowed\nXA04: mandatory fields depending on the presence of the other fields", "$ref": "#/components/schemas/PryRcvgNetAd" }, "secRcvgNetAd": { "description": "Secondary Receiving Network Address, the identifier by which this Participant, configured for using this Product Type, is known on the network when receiving messages from the R2P Transactional Layer.\n\n **Validation Rule(s)** If scyMsgNetID is equal to SWIFTNet, SIANet, EBICS, then the field must be present\nXA20: It must be set in the allowed format\nAM05: it must be different from scyRcvngNetAd\nXA23: field not allowed\nXA04: if scyMsgNetID is equal to SWIFTNet, SIANet or EBICS, then the scyRcvNetAd must be present", "$ref": "#/components/schemas/SecRcvgNetAd" }, "prySndgNetAd": { "description": "Primary Sending Network Address indicates the identifier by which the Participant is known on the network when sending messages to the R2P message Layer\n\n **Validation Rule(s)** If pryMsgNetID is equal to SWIFTNet, SIANet, EBICS, then the field may be present\nXA20: It must be set in the allowed format\nAM05: it must be different from secSndgNetAd\nXA23: field not allowed\nXA04: mandatory fields depending on the presence of the other fields", "$ref": "#/components/schemas/PrySndgNetAd" }, "secSndgNetAd": { "description": "The identifier by which this Participant, configured for using this Product Type, is known on the network when sending messages from the R2P Transactional Layer.\n\n **Validation Rule(s)** If scyMsgNetID is equal to SWIFTNet, SIANet, EBICS, then the field may be present\nXA20: It must be set in the allowed format\nAM05: it must be different from prySndgNetAd\nXA23: field not allowed\nXA04: mandatory fields depending on the presence of the other fields", "$ref": "#/components/schemas/SecSndgNetAd" } }, "required": [ "actionType", "solutionPurposeId" ] }, "ProductList2": { "type": "object", "properties": { "solutionPurposeId": { "description": "Solution Purpose Identification", "$ref": "#/components/schemas/SolutionPurposeId" }, "pryRcvgNetAd": { "description": "Primary Receiving Network Address indicates the identifier by which the Participant is known on the network when receiving messages from the R2P message Layer", "$ref": "#/components/schemas/PryRcvgNetAd" }, "secRcvgNetAd": { "description": "Secondary Receiving Network Address, the identifier by which this Participant, configured for using this Product Type, is known on the network when receiving messages from the R2P Transactional Layer.", "$ref": "#/components/schemas/SecRcvgNetAd" }, "prySndgNetAd": { "description": "Primary Sending Network Address indicates the identifier by which the Participant is known on the network when sending messages to the R2P message Layer", "$ref": "#/components/schemas/PrySndgNetAd" }, "secSndgNetAd": { "description": "The identifier by which this Participant, configured for using this Product Type, is known on the network when sending messages from the R2P Transactional Layer.", "$ref": "#/components/schemas/SecSndgNetAd" } } }, "PryApiEndpoint": { "type": "string", "minLength": 0, "maxLength": 100, "examples": [ "http://example.com/api/1/resourcename" ] }, "PryFileNetID": { "type": "string", "enum": [ "EAS", "EBX", "SWA", "SWS", "SWM", "SWF", "ZZZ" ], "examples": [ "EAS" ] }, "PryFileNetID1": { "type": "string", "enum": [ "EAS", "EBX", "SWA", "SWF", "ZZZ", "SWS", "SWM" ], "pattern": "\\S+.*", "examples": [ "EAS" ] }, "PryFileNetID2": { "type": "string", "enum": [ "EAS", "EBX", "SWA", "SWF", "ZZZ", "SWS", "SWM" ], "examples": [ "EAS" ] }, "PryMsgNetID": { "type": "string", "enum": [ "EAS", "EBX", "SWI", "ZZZ", "API" ], "examples": [ "EAS" ] }, "PryRcvgNetAd": { "type": "string", "pattern": "\\S+.*", "minLength": 1, "maxLength": 100, "examples": [ "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" ] }, "PryRcvngFileNetAd": { "type": "string", "pattern": "\\S+.*", "minLength": 0, "maxLength": 100, "examples": [ "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" ] }, "PryRcvngFileNetAd1": { "type": "string", "minLength": 0, "maxLength": 100, "examples": [ "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" ] }, "PrySndgNetAd": { "type": "string", "pattern": "\\S+.*", "minLength": 1, "maxLength": 100, "examples": [ "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" ] }, "R2pRsnCd": { "type": "string", "minLength": 0, "maxLength": 35, "examples": [ "XT07" ] }, "ReBic": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3})", "examples": [ "RTPDID21ABC" ] }, "ReceiverBic": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "examples": [ "RTPDID21" ] }, "ReceivingDtTm": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "ReDetails": { "type": "object", "properties": { "reBic": { "description": "Bic of the reachable entity", "$ref": "#/components/schemas/ReBic" }, "participantBic": { "description": "BIC of participant", "$ref": "#/components/schemas/ParticipantBic" }, "reName": { "description": "Name of reachable entity", "$ref": "#/components/schemas/ReName" }, "rtStatus": { "description": "Participant status in routing table (e.g. disabled, enabled,…)", "$ref": "#/components/schemas/RtStatus" }, "initValidityDate": { "description": "The initial validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends from its init validity date (first business operating day)", "$ref": "#/components/schemas/InitValidityDate" }, "endValidityDate": { "description": "The end validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends to its end validity date (the last business operating day)", "$ref": "#/components/schemas/EndValidityDate" } }, "required": [ "reBic", "participantBic", "reName", "rtStatus", "initValidityDate", "endValidityDate" ] }, "ReDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the responsse", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "reDetails": { "$ref": "#/components/schemas/ReDetails" }, "parametersModificationHistory": { "type": "array", "items": { "$ref": "#/components/schemas/ParametersModificationHistory1" } } }, "required": [ "dateTime", "requestId" ] }, "ReferenceId": { "type": "string", "minLength": 1, "maxLength": 35, "examples": [ "2306211715ZZ" ] }, "RejectCommandRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format", "$ref": "#/components/schemas/DateTime" }, "cmndRfrnc": { "description": "The unique reference identification of the command\n\n **Validation Rule(s)** XA22: the command reference must be in “executed” status and the end parameter validity must be greater than the current business date.", "$ref": "#/components/schemas/CmndRfrnc" } }, "required": [ "dateTime", "cmndRfrnc" ] }, "RejectCommandResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "Unique reference identification", "$ref": "#/components/schemas/RequestId" }, "cmndRfrnc": { "description": "The unique reference identification of the command", "$ref": "#/components/schemas/CmndRfrnc" } }, "required": [ "dateTime", "requestId", "cmndRfrnc" ] }, "ReList": { "type": "object", "properties": { "reBic": { "description": "The BIC of reachable entity", "$ref": "#/components/schemas/ReBic" }, "participantBic": { "description": "The BIC of participant", "$ref": "#/components/schemas/ParticipantBic" }, "reName": { "description": "The name of reachable entity", "$ref": "#/components/schemas/ReName" }, "solutionPurposeId": { "description": "Solution Purpose identification", "$ref": "#/components/schemas/SolutionPurposeId" }, "aosId": { "description": "Additional Optional Services", "type": "array", "minItems": 0, "maxItems": 30, "items": { "$ref": "#/components/schemas/AosId" } }, "rtStatus": { "description": "Participant status in routing table (e.g. disabled, enabled,…)", "$ref": "#/components/schemas/RtStatus" }, "initValidityDate": { "description": "The initial validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends from its init validity date (first business operating day)", "$ref": "#/components/schemas/InitValidityDate" }, "endValidityDate": { "description": "The end validity date of a time-related validity change of a PSP (or a user's PSP), which means that a change validity extends to its end validity date (the last business operating day)", "$ref": "#/components/schemas/EndValidityDate" } }, "required": [ "reBic", "participantBic", "reName", "rtStatus", "initValidityDate", "endValidityDate" ] }, "RemoveBicRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and Time of the Request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "participantBic": { "description": "The Bic of the Participant\n\n **Validation Rule(s)** XA23: field not allowed for participant", "$ref": "#/components/schemas/ParticipantBic" }, "reBic": { "description": "The BIC of the reachable entity\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nPY01: it must be a reachable entity of the sender BIC", "$ref": "#/components/schemas/ReBic" }, "effectiveDate": { "description": "The effective date of the request\n\n **Validation Rule(s)** XA15 error details: effective date cannot be greater than end validity date\nXA22 error details: another configuration with effective date equal to or greater than remove BIC effective date is already existing\nDT01: it must be the current or a future date according to effective management for critical operations", "$ref": "#/components/schemas/EffectiveDate" } }, "required": [ "dateTime", "effectiveDate" ] }, "RemoveBicResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and Time of the Response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "The unique request identification", "$ref": "#/components/schemas/RequestId" }, "cmndRfrnc": { "description": "If the request has been successfully processed, then this field contains the command reference of the operation stored as type of REMOVE_BIC", "$ref": "#/components/schemas/CmndRfrnc" } }, "required": [ "dateTime", "requestId", "cmndRfrnc" ] }, "ReName": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "Merrill Lynch" ] }, "ReOperationDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and Time of the Response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "The requst ID of the response", "$ref": "#/components/schemas/RequestId" }, "cmndRfrnc": { "description": "The ID reference of the command", "$ref": "#/components/schemas/CmndRfrnc2" }, "operationTp": { "description": "The type of operation\nThe participant is allowed only to INSERT_BIC,REMOVE_BIC,UPDATE_BIC,MASSIVE_RE_INSERT", "$ref": "#/components/schemas/OperationTp" }, "operationStatus": { "description": "The status of operation", "$ref": "#/components/schemas/OperationStatus" }, "userIssr": { "description": "The user who issued the operation", "$ref": "#/components/schemas/UserIssr" }, "userSprvr": { "description": "The user who authorized or rejected the operation", "$ref": "#/components/schemas/UserSprvr1" }, "requestDtTm": { "description": "The request date and time of the operation", "$ref": "#/components/schemas/RequestDtTm" }, "effectiveDate": { "description": "The effective date of the operation", "$ref": "#/components/schemas/EffectiveDate" }, "listReOperationDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ListReOperationDetails" } }, "critical": { "description": "Indicate if a parameter is critical or non critical", "$ref": "#/components/schemas/Critical" } }, "required": [ "dateTime", "requestId", "cmndRfrnc", "operationTp", "operationStatus", "userIssr", "requestDtTm", "effectiveDate", "listReOperationDetails", "critical" ] }, "ReParameters": { "type": "object", "properties": { "details": { "$ref": "#/components/schemas/Details" }, "parameterDetails": { "$ref": "#/components/schemas/ParameterDetails" }, "msgIntf": { "$ref": "#/components/schemas/MsgIntf1" } }, "required": [ "details", "msgIntf" ] }, "ReqExeDt": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "RequestDt": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "RequestDtTm": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "RequestDtTm1": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "RequestDtTmFrom": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "RequestDtTmTo": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "RequestId": { "type": "string", "minLength": 1, "maxLength": 36, "examples": [ "20180501183030100000" ] }, "ResendAllRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the request\n\n **Validation Rule(s)** XA20: it must be equal to an allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "fileTp": { "description": "The type of the file\n\n **Validation Rule(s)** XA20: it must be equal to one of the configured values", "$ref": "#/components/schemas/FileTp" }, "fileStatus": { "description": "The status of the file\n\n **Validation Rule(s)** XA20: it must be equal to one of the configured values\nXA22: The status of the requested file shall be “TSG” or “ERR”.", "$ref": "#/components/schemas/FileStatus" }, "dateFrom": { "description": "The lowest value of date-range searching\n\n **Validation Rule(s)** Used to match creation date as part of creation date&time of files\nXA20: it must be equal to an allowed format\nXA15: retransmission can be requested for files with creation date maximum D-2 calendar days\nDT01: It must be previous or equal to the current date", "$ref": "#/components/schemas/DateFrom" }, "dateTo": { "description": "The highest value of date-range searching\n\n **Validation Rule(s)** Used to match creation date as part of creation date&time of files\nXA20: it must be equal to an allowed format\nDT01: It must be greater than or equal to the DateFrom\nXA15", "$ref": "#/components/schemas/DateTo" } }, "required": [ "dateTime", "fileTp", "fileStatus", "dateFrom" ] }, "ResendAllResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "operationItem": { "$ref": "#/components/schemas/OperationItem" } }, "required": [ "dateTime", "requestId", "operationItem" ] }, "ResourceId": { "type": "string", "minLength": 0, "maxLength": 70, "examples": [ "2306211715ZZ" ] }, "ResUnavailability": { "type": "string", "enum": [ "0", "1" ], "maxLength": 1, "examples": [ "0" ] }, "RetransmitOutputFilesRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "netFileName": { "description": "Name of the file network\n\n **Validation Rule(s)** XA20 error details: invalid network filename\nXA15 error details: Retransmission can be requested for files with creation date maximum D-7 calendar days\nXA22 error details: file with invalid status\nXA22 error details: reached maximum number of 5 attempts", "$ref": "#/components/schemas/NetFileName" } }, "required": [ "dateTime", "netFileName" ] }, "RetransmitOutputFilesResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation date and time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "operationItem": { "$ref": "#/components/schemas/OperationItem1" } }, "required": [ "dateTime", "requestId", "operationItem" ] }, "RoleChange": { "type": "string", "enum": [ "Y", "N" ], "examples": [ "Y" ] }, "RoutingTable": { "type": "string", "enum": [ "P", "RE" ], "examples": [ "P" ] }, "RtfRqst": { "type": "string", "enum": [ "Y", "N" ], "examples": [ "Y" ] }, "RtStatus": { "type": "string", "enum": [ "ENB", "SUS", "DIS", "CNG", "INS" ], "examples": [ "ENB" ] }, "ScyApiEndpoint": { "type": "string", "minLength": 0, "maxLength": 100, "examples": [ "http://example.com/api/1/resourcename" ] }, "ScyFileNetID": { "type": "string", "enum": [ "EAS", "EBX", "SWA", "SWS", "SWM", "SWF", "ZZZ" ], "examples": [ "EAS" ] }, "ScyFileNetID1": { "type": "string", "enum": [ "EAS", "EBX", "SWA", "SWF", "ZZZ", "SWS", "SWM" ], "pattern": "\\S+.*", "examples": [ "EAS" ] }, "ScyFileNetID2": { "type": "string", "enum": [ "EAS", "EBX", "SWA", "SWF", "ZZZ", "SWS", "SWM" ], "examples": [ "EAS" ] }, "ScyMsgNetID": { "type": "string", "enum": [ "EAS", "EBX", "SWI", "ZZZ", "API" ], "examples": [ "EAS" ] }, "ScyRcvngFileNetAd": { "type": "string", "pattern": "\\S+.*", "minLength": 0, "maxLength": 100, "examples": [ "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" ] }, "ScyRcvngFileNetAd1": { "type": "string", "minLength": 0, "maxLength": 100, "examples": [ "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" ] }, "SecRcvgNetAd": { "type": "string", "pattern": "\\S+.*", "minLength": 1, "maxLength": 100, "examples": [ "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" ] }, "SecSndgNetAd": { "type": "string", "pattern": "\\S+.*", "minLength": 1, "maxLength": 100, "examples": [ "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" ] }, "SenderBic": { "description": "Sender bic", "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}", "examples": [ "RTPDID21" ] }, "SendingDtTm": { "type": "string", "pattern": "[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(.[0-9]{1,6}){0,1}", "examples": [ "2019-06-21T23:20:50.000001" ] }, "SolutionPurposeId": { "type": "string", "enum": [ "APNW", "APLT", "REDI", "EMBE", "CERT", "RTPP", "CBIU" ], "examples": [ "APNW" ] }, "SolutionPurposeId1": { "type": "string", "minLength": 0, "maxLength": 35, "examples": [ "APNW" ] }, "SolutionPurposeId2": { "type": "string", "enum": [ "APNW", "APLT", "REDI", "EMBE", "CERT", "RTPP", "CBIU" ], "examples": [ "APNW" ] }, "SolutionPurposeId3": { "type": "string", "enum": [ "APNW", "APLT", "REDI", "EMBE", "CERT", "RTPP", "CBIU" ], "examples": [ "APNW" ] }, "Status": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "SwitchFileIntf": { "type": "boolean", "enum": [ true, false ], "examples": [ true ] }, "SwitchMsgIntf": { "type": "boolean", "enum": [ true, false ], "examples": [ true ] }, "TechnicalBic": { "type": "string", "enum": [ "Y", "N" ], "examples": [ "Y" ] }, "TimeFrom": { "type": "string", "examples": [ "16:00:00" ] }, "TimeTo": { "type": "string", "examples": [ "16:00:00" ] }, "TotNumC029Rcv": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "TotNumC029Snt": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "TotNumC055Rcv": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "TotNumC055Snt": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "TotNumOfMsgRcv": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "TotNumOfMsgSnt": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "TotNumP013Rcv": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "TotNumP013Snt": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "TotNumP014Rcv": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "TotNumP014Snt": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "TotNumP028Rcv": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "TotNumP028Snt": { "type": "string", "pattern": "[0-9]{0,15}", "examples": [ "12" ] }, "UpdateParticipantRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and Time ofthe request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "bicRequested": { "description": "BIC of the Participant or RE used to customize search criteria or BIC who requested the operation\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nPY01: participant must have status “Enabled”, “Inserted” or “Suspended”", "$ref": "#/components/schemas/BicRequested" }, "effectiveDate": { "description": "The effective date of the request\n\n **Validation Rule(s)** DT01: effective date must be greater than the current processing date and set according to critical/non critical process depending on involved parameters\nXA15: effective date must be between \"initial validity date\" and \"end validity date\"\nXA22: another configuration with the same effective date is already existing for the participant\nXA20: It must be equal to the allowed format", "$ref": "#/components/schemas/EffectiveDate" }, "cmndRfrnc": { "description": "The unique reference identification of the command\n\n **Validation Rule(s)** XA22: the command reference must be in “executed” status and the end parameter validity must be greater than the current business date.", "$ref": "#/components/schemas/CmndRfrnc" }, "participantName": { "description": "The name of the Participant", "$ref": "#/components/schemas/ParticipantName1" }, "technicalBic": { "description": "Indicates if the BIC is technical or not\n\n **Validation Rule(s)** indicates if the participant is a Technical BIC\nXA20: it must be equal to an allowed value", "$ref": "#/components/schemas/TechnicalBic" }, "fileIntf": { "$ref": "#/components/schemas/FileIntf1" }, "msgIntf": { "$ref": "#/components/schemas/MsgIntf2" } }, "required": [ "dateTime", "bicRequested", "effectiveDate", "cmndRfrnc" ] }, "UpdateParticipantResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and Time of the Response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "cmndRfrnc": { "description": "If the request has been successfully processed, then this field contains the command reference of the operation stored as type of UPDATE_BIC", "$ref": "#/components/schemas/CmndRfrnc" } }, "required": [ "dateTime", "requestId", "cmndRfrnc" ] }, "UpdateReRequest": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and time of the request\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nDT01: it must be a valid date", "$ref": "#/components/schemas/DateTime" }, "participantBic": { "description": "The BIC of the participant. Sender BIC\n\n **Validation Rule(s)** XA20: it must be equal to an allowed value\nPY01: must have status “Enabled”, “Inserted” or “Suspended” Participant\nPY01: it must correspond to the sender BIC", "$ref": "#/components/schemas/ParticipantBic1" }, "effectiveDate": { "description": "The effective date of the request\n\n **Validation Rule(s)** DT01: effective date must be managed according to critical/non critical process depending on involved parameters\nXA15: effective date must be between \"initial validity date\" and \"end validity date\"\nXA22: another configuration with the same effective date is already existing", "$ref": "#/components/schemas/EffectiveDate" }, "listRe": { "description": " **Validation Rule(s)** Only one occurence of RE BIC is allowed, since MASSIVE_UPDATE is not foreseen for Participants", "type": "array", "minItems": 1, "maxItems": 250, "items": { "$ref": "#/components/schemas/ListRe1" } } }, "required": [ "dateTime", "participantBic", "effectiveDate", "listRe" ] }, "UpdateReResponse": { "type": "object", "properties": { "dateTime": { "description": "Creation Date and Time of the response", "$ref": "#/components/schemas/DateTime" }, "requestId": { "description": "API request unique identification created by the CS", "$ref": "#/components/schemas/RequestId" }, "cmndRfrnc": { "description": "If listRe=1 and the request has been successfully processed, then this field contains the command reference of the operation stored as type of UPDATE_BIC", "$ref": "#/components/schemas/CmndRfrnc" } }, "required": [ "dateTime", "requestId", "cmndRfrnc" ] }, "UserIssr": { "type": "string", "minLength": 1, "maxLength": 8, "examples": [ "SSO01347" ] }, "UserIssuer": { "type": "string", "minLength": 0, "maxLength": 8, "examples": [ "SSO01347" ] }, "UserSprvr": { "type": "string", "minLength": 0, "maxLength": 8, "examples": [ "SSO01347" ] }, "UserSprvr1": { "type": "string", "minLength": 1, "maxLength": 8, "examples": [ "SSO01347" ] }, "Uuid": { "description": "UUID (EPC RFC 4122) generated by the API client for a specific payload.", "type": "string", "minLength": 36, "maxLength": 36, "examples": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] }, "XmlMsgSts": { "type": "string", "minLength": 0, "maxLength": 35, "examples": [ "RJCS" ] }, "XmlStsRsn": { "type": "string", "minLength": 0, "maxLength": 35, "examples": [ "AEXR" ] }, "ZonedDateTime": { "description": "Standard ISO Date-Time with time zoned.", "type": "string", "pattern": "[0-9]{4,4}\\-[0-9]{2,2}\\-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(\\.[0-9]{1,6}){0,1}(([+-][0-9]{2,2}:[0-9]{2,2})|Z)", "examples": [ "2019-05-02T22:22:00.123-01:10" ] }, "Errors": { "description": "Container to return multiple ErrorMessage object. Collection of error can be useful when API needs to return multiple errors, for example validation errors. When the response code conveys application-specific functional semantics and consumer can parse machine-readable error code, this block can be useful. The error response must contain at least one error object.", "type": "array", "items": { "$ref": "#/components/schemas/ErrorMessage" } }, "ErrorMessage": { "description": "Custom error schema to support detailed error message.", "type": "object", "additionalProperties": false, "required": [ "code", "severity", "text" ], "properties": { "severity": { "description": "Specifies the severity of the error.", "type": "string", "enum": [ "Fatal", "Transient", "Logic" ] }, "code": { "description": "Specifies the custom error code as defined by the service provider.", "type": "string", "minLength": 3, "maxLength": 70 }, "text": { "description": "Specifies the detail error message identifying the cause of the error.", "type": "string", "minLength": 1, "maxLength": 255 }, "user_message": { "description": "A human-readable text describing the error.", "type": "string", "minLength": 1, "maxLength": 255 }, "more_info": { "description": "Specifies an URL to find more information about the error.", "type": "string", "format": "uri" } } } }, "responses": { "ErrorResponse_204": { "description": "No Content", "content": { "text/plain": { "schema": { "type": "string", "examples": [ "TSTBICXX204" ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "ErrorResponse_401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "type": "string", "examples": [ "TSTBICXX401" ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "ErrorResponse_403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "type": "string", "examples": [ "TSTBICXX403" ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "ErrorResponse_404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string", "examples": [ "TSTBICXX404" ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "ErrorResponse_429": { "description": "Too many requests", "content": { "text/plain": { "schema": { "type": "string", "examples": [ "TSTBICXX429" ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "ErrorResponse_500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "type": "string", "examples": [ "TSTBICXX500" ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } } } } }