{ "openapi": "3.1.0", "info": { "version": "5.2", "title": "EBACL RT1 REST API - PWS", "description": "PWS RESTful API for interacting with RT1 services", "contact": { "name": "EBA", "url": "https://www.eba.europa.eu/homepage" }, "x-info-creation-date": "2026-06-12", "x-info-release": "V20261115", "x-info-oasis-version": "3.0.20", "x-info-customization": "SWIFT" }, "servers": [ { "url": "https://api.swiftnet.sipn.swift.com/ebacl-rt1/v1", "description": "Live Environment" }, { "url": "https://api-test.swiftnet.sipn.swift.com/ebacl-rt1-pilot/v1", "description": "Test Environment" }, { "url": "https://api.common.swiftnet.sipn.swift.com/ebacl-rt1/v1", "description": "Extended availability Live environment" }, { "url": "https://api-pilot.common.swiftnet.sipn.swift.com/ebacl-rt1-pilot/v1", "description": "Extended availability Test environment" } ], "tags": [ { "name": "Command inquiry", "description": "Command inquiry" }, { "name": "Interest calculation", "description": "Interest calculation" }, { "name": "Liquidity management", "description": "Liquidity management" }, { "name": "List Throttling Parameters", "description": "List Throttling Parameters" }, { "name": "Participant management", "description": "Participant management" }, { "name": "TIPS Messages", "description": "TIPS Messages" }, { "name": "Transaction inquiry", "description": "Transaction inquiry" } ], "security": [ { "oauthBearerToken": [] } ], "paths": { "/currentNetPosition/{senderBic}": { "post": { "tags": [ "Liquidity management" ], "operationId": "currentNetPosition", "summary": "A Participant can inquiry real time liquidity position", "description": "The Current Position request allows the Participant to inquire about its real time liquidity position in the SCT Inst.\nUpon receiving this Request, the SCT Inst will inquire the real time Position of the inquiring Participant and returns the value of the timestamp of the reading.\nThe result of the inquiry done for a Participant that is not part of a Liquidity Branch Funds Balance will always be a positive value. If the Participant belongs to a Liquidity Branch Funds Balance, it is possible that the Current Position is a negative value.\nThe SCT Inst will always verify if the Participant is part of a Liquidity Branch Funds Balance, if this the case the Response will contain the Position of both the Participant and the Position of all Liquidity Branch Funds Balances the Participant is a member of.\nThe response contains the current Position of the Participant.\nIf the Participant is an LP, the system will return the current Position of each LSP for whose liquidity management it is responsible for.\nIn the case that the Participant is a member of one or more Liquidity Branch Funds Balances, the “BranchFundsBalanceId” and “BranchFundsBalancePosition” elements contain the Branch Funds Balance identification and the current position of the Branch Funds Balance to which the Participant belongs to. If the Participant is the Owner of one or more Liquidity Branch Funds Balances, the section “OwnedBranchFundsBalance” is repeated for each Liquidity Branch Funds Balance that is owns. The “OwnedMember” for each “OwnedBranchFundsBalance” lists the members of the Branch Funds Balance and the Position of each member.", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended, r-only or inserted Participant (ErrorCode PY01)\nIf the BIC is valued but different from the SenderBic, the SenderBic must be the Owner of the branchFundsBalanceId (ErrorCode XA06)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentNetPositionResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "senderPosition": { "bic": "IPSDID21", "sign": "C", "amount": 9.99, "timestamp": "2019-06-21T23:20:50.000001" }, "lspsPosition": [ { "bic": "IPSDID21", "sign": "C", "amount": 9.99, "timestamp": "2019-06-21T23:20:50.000001" }, { "bic": "CIPTBITM", "sign": "D", "amount": 2000.11, "timestamp": "2024-11-08T14:29:00.012345" } ], "branchFundsBalancePosition": { "branchFundsBalanceId": "IPSDID2100001", "amount": 9.99 }, "ownedBranchFundsBalanceList": [ { "ownedBranchFundsBalanceInfo": { "branchFundsBalanceId": "IPSDID2100001", "amount": 9.99 }, "ownedMemberList": [ { "bic": "IPSDID21", "sign": "C", "amount": 9.99, "timestamp": "2019-06-21T23:20:50.000001" }, { "bic": "CIPTBITM", "sign": "D", "amount": 2000.11, "timestamp": "2024-11-08T14:29:00.012345" } ] } ] } } } } }, "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" } } } }, "/defaultPosition/{senderBic}": { "put": { "tags": [ "Liquidity management" ], "operationId": "defaultPosition", "summary": "A Participant can set default values (Base, Lower, and Upper)", "description": "The Set Default Position request allows the Participant to set its default position for one day specific of the week, from Monday to Sunday, and for one or more specific LACs of that day. The Participant can set the lower, base, upper and reset to base position values for each LAC specified. Only the values of the specified LACs will be modified.\nIf the Participant is an LSP whose liquidity management is delegated the request is rejected with ErrorCode XA14.\nIf the Participant is an LP, it is allowed to send the SetDefaultPosition Request on behalf of the LSPs whose liquidity management is responsible for.\nThe response contains the EffectiveDate that was calculated by the system as the first occurrence for application of the new default values. This date is the next TARGET relative to the processing date of the request.\nIf the pair Day – LAC in the request is the next one with respect to the current one in the system, the new values are applied only if the API Request is received within the “Liquidity Agenda Grace Time” system parameter that represents the minimum time interval remaining to the end of the current LAC, otherwise the request is rejected.\nThe request must anyway be submitted within the “Routing Grace Time”, the system parameter that represents the time limit before midnight for the Participants to submit requests for updates, otherwise it is rejected with ErrorCode XA08.", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, r-only or inserted Participant (ErrorCode PY01)\nThe SenderBic liquidity must be managed by the SenderBic itself (ErrorCode XA14)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultPositionRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "lspBic": "IPSDID21", "defaultDayValues": { "day": 1, "defaultLACValues": [ { "lac": "1", "base": 30004958.23, "lower": 13402.53, "upper": 49.2, "resetToBasePosition": "0", "sendAccountQueryToTips": "0" }, { "lac": "2", "base": 13402.53, "lower": 49.2, "upper": 30004958.23, "resetToBasePosition": "1", "sendAccountQueryToTips": "1" } ] } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultPositionResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "effectiveDate": "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" } } } }, "/getDefaultPosition/{senderBic}": { "post": { "tags": [ "Liquidity management" ], "operationId": "getDefaultPosition", "summary": "A Participant can inquiry default values (Base, Lower, and Upper)", "description": "The DefaultNetPosition request allows the Participant to retrieve the default values in the SCT Inst for the days in the week, from Monday to Sunday, and all LACs of these days.\nIf the Participant is an LP, it is allowed to send the getDefaultPosition Request regarding the positions of the LSPs on whose behalf such LP is configured to perform liquidity management functions.\nOnly the Owner of a Liquidity Branch Funds Balance is allowed to inquire the default values of a BIC that is a Member of its Branch Funds Balance, in this case it must specify the Branch Funds BalanceId and the MemberBic belonging to the Branch Funds Balance for which the request is sent.\nThe response returns the values for each day of week and each LAC for each specific day.", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended, r-only or inserted Participant (ErrorCode PY01)\nIf the BIC is valued but different from the SenderBic, the SenderBic must be the Owner of the branchFundsBalanceId (ErrorCode XA06)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDefaultPositionRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "lspBic": "IPSDID21", "memberBic": "CIPTBITM", "branchFundsBalanceId": "IPSDID2100001" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDefaultPositionResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "values": { "lspBic": "IPSDID21", "lspBicDefaultDayValues": [ { "day": 1, "defaultLACValues": [ { "lac": "1", "base": 30004958.23, "lower": 13402.53, "upper": 49.2, "resetToBasePosition": "0", "sendAccountQueryToTips": "0" }, { "lac": "2", "base": 13402.53, "lower": 49.2, "upper": 30004958.23, "resetToBasePosition": "1", "sendAccountQueryToTips": "1" } ] }, { "day": 2, "defaultLACValues": [ { "lac": "1", "base": 30004958.23, "lower": 13402.53, "upper": 49.2, "resetToBasePosition": "0", "sendAccountQueryToTips": "0" }, { "lac": "2", "base": 13402.53, "lower": 49.2, "upper": 30004958.23, "resetToBasePosition": "1", "sendAccountQueryToTips": "1" } ] } ], "memberBic": "CIPTBITM", "branchFundsBalanceId": "IPSDID2100001", "memberDefaultDayValues": [ { "day": 1, "defaultLACValues": [ { "lac": "1", "base": 30004958.23, "lower": 13402.53, "upper": 49.2, "resetToBasePosition": "0", "sendAccountQueryToTips": "0" }, { "lac": "2", "base": 13402.53, "lower": 49.2, "upper": 30004958.23, "resetToBasePosition": "1", "sendAccountQueryToTips": "1" } ] }, { "day": 2, "defaultLACValues": [ { "lac": "1", "base": 30004958.23, "lower": 13402.53, "upper": 49.2, "resetToBasePosition": "0", "sendAccountQueryToTips": "0" }, { "lac": "2", "base": 13402.53, "lower": 49.2, "upper": 30004958.23, "resetToBasePosition": "1", "sendAccountQueryToTips": "1" } ] } ] } } } } } }, "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" } } } }, "/exceptionPositionCalendar/{senderBic}": { "put": { "tags": [ "Liquidity management" ], "operationId": "exceptionPositionCalendar", "summary": "A Participant can set exception position values (Base, Lower, and Upper)", "description": "The Set Exception Position Calendar request allows the Participant to set the desired position in the SCT Inst for LACs later than the current LAC of the current Business Date, or for LACs of a Business Date in the future, that is no further than one year from the current date.\nIf the Participant is an LSP whose liquidity management is delegated, the request is rejected with ErrorCode XA14.\nIf the Participant is an LP, it is allowed to send the SetExceptionPositionCalendar Request on behalf of those LSPs whose liquidity management is responsible for.\n\nFor a LAC of the selected Business Date, the Participant can specify its (or those of the specified LSPBic) lower, base and upper values: they will be exceptionally applied at the occurrence of the BusinessDate and LAC as an exception to the default values of the day of the week associated to the BusinessDate.\nIf the pair BusinessDate – LAC in the request is the next one with respect to the current Business Date-LAC of the system, the new values are applied only if the API Request is received within the “Liquidity Agenda Grace Time” system parameter, that represents the minimum time interval remaining to the end of the current LAC, otherwise the request is rejected.\nThe request must anyway be submitted within the “Routing Grace Time”, the system parameter that represents the time limit before midnight for the Participants to submit requests for updates, otherwise it is rejected with ErrorCode XA08.", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, r-only or inserted Participant (ErrorCode PY01)\nThe SenderBic liquidity must be managed by the SenderBic itself (ErrorCode XA14)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionPositionCalendarRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "lspBic": "IPSDID21", "businessDate": "2019-06-21", "exceptionLacValues": [ { "lac": "1", "base": 30004958.23, "lower": 13402.53, "upper": 49.2, "resetToBasePosition": "0", "sendAccountQueryToTips": "0" }, { "lac": "2", "base": 13402.53, "lower": 49.2, "upper": 30004958.23, "resetToBasePosition": "0", "sendAccountQueryToTips": "0" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionPositionCalendarResponse" }, "examples": { "OK": { "value": { "dateTime": "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" } } } }, "/getExceptionPositionCalendar/{senderBic}": { "post": { "tags": [ "Liquidity management" ], "operationId": "getExceptionPositionCalendar", "summary": "A Participant can inquiry exception position values (Base, Lower, and Upper)", "description": "The GetExceptionCalendar request allows the Participant to retrieve its own set of values (lower, base,upper and reset to base position) that will be applied for each LAC of a specific day in the future (or for the current business date). It is possible to inquire the calendar up to one year from the current day.\nIf the Participant is an LP, it is allowed to send the GetExceptionPositionCalendar Request for those LSPs whose liquidity management is responsible for.\nOnly the Owner of a Liquidity Branch Funds Balance can inquire the values of a Member belonging to its Branch Funds Balance.\nThe returned values are the ones that will be really applied by the system, if an exception was set for the Business Date, it will be returned in place of the default values. If no exception was set for the Business Date, it will be returned the default values.\nThe response contains the values for the request Business Day.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended, r-only or inserted Participant (Error Code PY01)\nIf the BIC is valued but different from the SenderBic, the SenderBic must be the Owner of the branchFundsBalanceId (ErrorCode XA06)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExceptionPositionCalendarRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "lspBic": "IPSDID21", "businessDate": "2019-06-21", "memberBic": "CIPTBITM", "branchFundsBalanceId": "IPSDID2100001" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExceptionPositionCalendarResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "response": { "lspBic": "IPSDID21", "bicExceptionDayValues": [ { "lac": "1", "base": 30004958.23, "lower": 13402.53, "upper": 49.2, "resetToBasePosition": "0", "sendAccountQueryToTips": "0" }, { "lac": "2", "base": 13402.53, "lower": 49.2, "upper": 30004958.23, "resetToBasePosition": "1", "sendAccountQueryToTips": "1" } ], "memberBic": "CIPTBITM", "branchFundsBalanceId": "IPSDID2100001", "businessDate": "2019-06-21", "memberExceptionDayValues": [ { "lac": "1", "base": 30004958.23, "lower": 13402.53, "upper": 49.2, "resetToBasePosition": "0", "sendAccountQueryToTips": "0" }, { "lac": "2", "base": 13402.53, "lower": 49.2, "upper": 30004958.23, "resetToBasePosition": "1", "sendAccountQueryToTips": "1" } ] } } } } } }, "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" } } } }, "/defunding/{senderBic}": { "put": { "tags": [ "Liquidity management" ], "operationId": "releaseLiquidiy", "summary": "A Participant can defund a position", "description": "The ReleaseLiquidity request allows the Participant to defund the desired amount from its Position in the SCT Inst to its DCA account in TIPS; the system shall check that the amount to be defunded is less than or equal to the available position of the Participant in the system and, if not, the request shall be rejected.\nThe Participant is allowed to ask for the defunding of the entire amount corresponding to its position.\nIf the Participant belongs to a Branch Funds Balance and the Liquidity Position of the Branch Funds Balance is lesser than the amount to be defunded, the request shall be rejected.\nIf the Participant is an LSP whose liquidity management is delegated, the request is rejected with ErrorCode XA14.\nIf the Participant is an LP, it is allowed to send the ReleaseLiquidity Request on behalf of the LSPs whose liquidity management is responsible for.\nIf the Participant is the Owner of a Branch Funds Balance, it is allowed to use this request to defund the liquidity of another not-suspended BIC that is a Member of the Branch Funds Balance, from the Position of the MemberBic in the system to the DCA account of the MemberBic in TIPS.\nThe response contains the confirmation or rejection of the request.\nIf the Participant is in Technical Isolation, the request is rejected with ErrorCode XA23\n\nPlease, note that the request can be sent to SCT Inst only if the “FREEZE TIPS Exchange Liquidity” command has not been issued, otherwise the request will be rejected with ErrorCode XA09.", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, r-only or inserted Participant (ErrorCode PY01)\nIf the MemberBIC is valued and different from the SenderBic, the SenderBIC must be the Owner of the branchFundsBalanceId (ErrorCode XA06)\nThe SenderBic liquidity must be managed by the SenderBic itself (ErrorCode XA14)\nThe SenderBic must not be isolated (“Technical Isolation” flag equal to “No”) (ErrorCode XA23)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefundingRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "releaseInfo": { "amount": 9.99, "lspBic": "IPSDID21", "memberBic": "CIPTBITM", "branchFundsBalanceId": "IPSDID2100001" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefundingResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "remainingAmount": 9.99 } } } } }, "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" } } } }, "/funding/{senderBic}": { "put": { "tags": [ "Liquidity management" ], "operationId": "funding", "summary": "A Participant can issue a request for funding its position", "description": "The PreFunding request allows the Participant to request for the transfer of a specified amount from their DCA account in TIPS to the RT1 Technical Account in TIPS, thus to their position in the SCT Inst System.\nIf the Participant is an LSP whose liquidity management is delegated, the request is rejected with ErrorCode XA14.\nIf the Participant is an LP, it is allowed to send the PreFunding Request on behalf of the LSPs whose liquidity management is responsible for.\nIf the Participant is the Owner of a Branch Funds Balance, it is allowed to use this functionality to move the liquidity of a not-suspended BIC that is Member of the Branch Funds Balance, from the DCA account of the MemberBic in TIPS to the Position of the MemberBic in the system.\nIf the Participant is in Technical Isolation, the request is rejected with ErrorCode XA23\nAfter receiving the Request for Prefunding by the Participant, the system sends a camt.050 message to TIPS with the instructions to make the funds available, and afterwards, when the system receives the camt.054 message from TIPS, it increases the position of the Participant with the required amount.\nThe requests for pre-funding are sent from the SCT Inst to TIPS and are asynchronous meaning that the application of the funds to the position of the Participant will be subject to a time delay.\nThe positive response is a confirmation that the request has been sent to TIPS for processing.\n\nPlease, note that the request can be sent to SCT Inst only only if the “FREEZE TIPS Exchange Liquidity” command has not been issued, otherwise the request will be rejected with ErrorCode XA09.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02).\nIt must be an enabled, r-only or inserted Participant (ErrorCode PY01)\nIt the MemberBic is valued but different from the SenderBic, the SenderBic must be the Owner of the branchFundsBalanceId (ErrorCode XA06)\nThe SenderBic liquidity must be managed by the SenderBic itself (ErrorCode XA14)\nThe SenderBic must not be isolated (“Technical Isolation” flag equal to “No”) (ErrorCode XA23)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "fundingInfo": { "amount": 9.99, "lspBic": "IPSDID21", "memberBic": "CIPTBITM", "branchFundsBalanceId": "IPSDID2100001" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingResponse" }, "examples": { "OK": { "value": { "dateTime": "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" } } } }, "/liquidityTransfer/{senderBic}": { "put": { "tags": [ "Liquidity management" ], "operationId": "liquidityTransfer", "summary": "A Participant can transfer a specific amount from one Participant to another Participant within a Branch Funds Balance", "description": "The LiquidityTransfer request allows the Owner of the Liquidity Branch Funds Balance to request for the transfer of a specific amount from one Participant to another Participant, both not-suspended and belonging to the same Branch Funds Balance. The transfer of funds has an immediate effect meaning positions have already been adjusted upon receipt of the response to the request. The response contains the confirmation that the funds have been moved between the Participants.", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled or r-only Participant (Error Code PY01)\nIt must be the Owner of the branchFundsBalanceId (ErrorCode XA06)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiquidityTransferRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "liquidityTransferInfo": { "lenderBic": "IPSDID21", "receiverBic": "CIPTBITM", "branchFundsBalanceId": "IPSDID2100001", "amount": 9.99 } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiquidityTransferResponse" }, "examples": { "OK": { "value": { "dateTime": "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" } } } }, "/listInstructionsFundingDefundingTIPS/{senderBic}": { "post": { "tags": [ "Liquidity management" ], "operationId": "listInstructionsFundingDefunding", "summary": "A Participant can inquiry one specific or the list of Funding and Defunding Instructions issued in TIPS for a BIC", "description": "The ListInstructionsFundingDefunding request returns a list of all instructions present in the SCT Inst for a specific BIC and is sorted by Date.\nIt is possible to fill one or more fields as filtering criteria: in that case, the API Response returns the full set of rows corresponding to the filter criteria.\nIf the Participant is an LP, it is allowed to inquire the instructions of the LSPs whose liquidity management is responsible for.\nIf the Participant is the Owner of a Branch Funds Balance, it is allowed to inquire the instructions of another BIC that is a Member of the Branch Funds Balance that it owns.\nThe configuration of LSP and Branch Funds Balances taken into account for checks by the system is the one present at the moment in which the API Request is received: no restriction is applied to old stored instructions for which a different configuration was active.\nIf all the checks pass, but the system does not find any instruction related to the filtering criteria of the Request, the reason Code 204 – No Record Found is returned.\nThe resulting list shall contain a maximum of 1000 rows satisfying the criteria, in the case that the result has more than 1000 matching instructions, the response will contain an offset. By resubmitting the same request with a different offset value the Participant can retrieve all matching instructions", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** Must be equal to the BIC of the Participants certificate (ErrorCode XA02)\nIt must be an enabled, suspended or r-only Participant (Error Code PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInstructionsFundingDefundingTIPSRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "liquidityOperation": "REL", "lspbranchFundsBalanceMemBic": "IPSDID21", "type": "CPFR", "reference": "ID028472018304", "status": "WTG", "dateFrom": "2019-06-21", "dateTo": "2024-08-11", "amountRangeFrom": 9.99, "amountRangeTo": 2000.11, "debAccoOwnBic": "IPSDID21XXX", "credAccoOwnBic": "CIPTBITMXXX" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInstructionsFundingDefundingTIPSResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "response": { "lspbranchFundsBalanceMemBic": "IPSDID21", "numInstructions": 1, "instructions": [ { "type": "CPFR", "reference": "ID028472018304", "status": "WTG", "date": "2019-06-21", "lac": "1", "amount": 9.99, "debAccoOwnBic": "IPSDID21XXX", "credAccoOwnBic": "CIPTBITMXXX", "participantToBeDebitedBic": "IPSDID21", "participantToBeCreditedBic": "CIPTBITM", "time": "0.5731597222222222" }, { "type": "APFR", "reference": "ID0452050454", "status": "STD", "date": "2024-08-11", "lac": "2", "amount": 2000.11, "debAccoOwnBic": "CIPTBITMXXX", "credAccoOwnBic": "COURFR2TXXX", "participantToBeDebitedBic": "CIPTBITM", "participantToBeCreditedBic": "COURFR2T", "time": "0.5731597222222222" } ] }, "endOfList": "0", "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } }, "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" } } } }, "/instructionDetails/{senderBic}/{referenceId}": { "post": { "tags": [ "Liquidity management" ], "operationId": "instructionDeteils", "summary": "A Participant can inquiry the details of a specific liquidity instruction related to a funding/defunding exchanged with TIPS", "description": "A Participant can inquire the detail of any single instruction related to an adjustment exchanged with TIPS", "parameters": [ { "name": "senderBic", "description": "sender Bic", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } }, { "name": "referenceId", "description": "instruction", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Reference" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstructionDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "instructions": { "lspbranchFundsBalanceMembBic": "IPSDID21", "instructionType": "CPFR", "liquidityMessId": "P08M59270578EA544566A8DB7D970D", "liquidityInstractionId": "P08B59450578EA544526A8DB7D060D", "status": "WTG", "date": "2019-06-21", "lac": "1", "amount": 9.99, "debtorAccountOwnerBic": "IPSDID21XXX", "creditorAccountOwnerBic": "CIPTBITMXXX", "participantToBeDebitedBic": "CIPTBITM", "participantToBeCreditedBic": "COURFR2T", "accountToBeDebited": "IT60X0542811101000000123456", "accountToBeCredited": "DE89370400440532013000", "bookingDataTime": "2019-06-21T23:20:50.000001", "rt1PositionUpdateDataTime": "2024-11-08T14:29:00.012345" } } } } } }, "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" } } } }, "/listLACsConfiguration/{senderBic}": { "post": { "tags": [ "Liquidity management" ], "operationId": "listLACsConfiguration", "summary": "“listLACsConfiguration” allow Participants to retrieve LAC cut-offs", "description": "“listLACsConfiguration” allow Participants to retrieve LAC cut-offs", "parameters": [ { "name": "senderBic", "description": "The BIC of EBA CL sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLACsConfigurationRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "defaultValues": "0" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLACsConfigurationResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "lacParameters": [ { "lac": "01", "lacSendingCutOffTime": "10:00", "lacAdjustmentTime": "16:00:00" }, { "lac": "02", "lacSendingCutOffTime": "11:00", "lacAdjustmentTime": "00:00:01" } ], "otherSystemCutOff": { "openingTime": "16:00:00", "taw1Start": "2024-11-12:2024-11-11", "taw1End": "2024-11-12:2024-11-11", "taw2Start": "2024-11-12:2024-11-11", "taw2End": "2024-11-12:2024-11-11" } } } } } }, "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" } } } }, "/listMessage/{senderBic}": { "post": { "tags": [ "TIPS Messages" ], "operationId": "listMessage", "summary": "A Participant can inquiry one specific or the list of messages exchanged with TIPS", "description": "A Participant can inquire about the list of the relevant messages exchanged with TIPS.\nFor camt.003/004 shall be excluded all the RT1-destined messages.", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMessageRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "messageType": "camt.054", "intraserviceLtoType": "FUN", "messageId": "P08M59270578EA544566A8DB7D970D", "senderReceiverBic": "IPSDID21", "requestedThrough": "A2A", "processingDtFrom": "2019-06-21", "processingTmFrom": "16:00:00", "processingDtTo": "2024-08-11", "processingTmTo": "00:00:01", "messageStatus": "NTF", "debAccOwnBic": "IPSDID21XXX", "creAccOwnBic": "CIPTBITMXXX", "settlDate": "9999-12-31", "origMessId": "P08B59450578EA544526A8DB7D060D", "ltoTipsStatus": "RREJ", "accOrCmbId": "IT60X0542811101000000123456", "accUser": "DE89370400440532013000", "tipsTimestampDtFrom": "2019-06-21", "tipsTimestampTmFrom": "23:59:59", "tipsTimestampDtTo": "2024-08-11", "tipsTimestampTmTo": "16:00:00", "businessError": "XA01", "origTransactionId": "CCT000000776156310", "messageTypeCamt005": "Pacs.008", "paymentStatus": "PSTL" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMessageResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "listMessages": [ { "messageType": "camt.054", "senderReceiverBic": "IPSDID21", "messageId": "P08M59270578EA544566A8DB7D970D", "accountNumber": "IT60X0542811101000000123456", "processingDtTm": "2019-06-21T23:20:50.000001", "messageStatus": "NTF", "debAccOwnBic": "IPSDID21XXX", "creAccOwnBic": "CIPTBITMXXX", "ltoType": "FUN", "settlDate": "2019-06-21", "amount": 9.99, "origMessId": "P08B59450578EA544526A8DB7D060D", "ltoTipsStatus": "RREJ", "accOrCmbId": "DE89370400440532013000", "accOrCmbUser": "BE68539007547034", "tipsTimestampRetrieval": "2024-11-08T14:29:00.012345", "businessError": "XA01", "returnAcctTp": "CFCN", "originalTransactionId": "CCT000000776156310", "originalMessageType": "camt.005", "messageTypeCamt005": "Pacs.008", "paymentStatus": "PSTL" }, { "messageType": "camt.025", "senderReceiverBic": "CIPTBITM", "messageId": "P08B59450578EA544526A8DB7D060D", "accountNumber": "DE89370400440532013000", "processingDtTm": "2024-11-08T14:29:00.012345", "messageStatus": "RJS", "debAccOwnBic": "CIPTBITMXXX", "creAccOwnBic": "COURFR2TXXX", "ltoType": "DEF", "settlDate": "2024-08-11", "amount": 2000.11, "origMessId": "P08R59805521EA544566A8DB7P998C", "ltoTipsStatus": "RCON", "accOrCmbId": "BE68539007547034", "accOrCmbUser": "IT60X0542811101000000123456", "tipsTimestampRetrieval": "9999-12-31T12:55:45.000001", "businessError": "XA01", "returnAcctTp": "CFCN", "originalTransactionId": "CCT000000776156311", "originalMessageType": "camt.005", "messageTypeCamt005": "Pacs.004", "paymentStatus": "STLD" } ], "endOfList": "0", "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } }, "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" } } } }, "/messageDetails/{senderBic}": { "post": { "tags": [ "TIPS Messages" ], "operationId": "messageDetails", "summary": "A Participant can inquiry the detail of a specific message exchanged with TIPS", "description": "The MessageDetails request allows the Participant to retrieve the details of a specific message, exchanged with TIPS", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "messageType": "camt.054", "messageId": "P08M59270578EA544566A8DB7D970D", "senderReceiverBic": "IPSDID21", "processingDtTm": "2019-06-21T23:20:50.000001" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "messageDetails": { "messageType": "camt.054", "camt050ReFromPartDtTm": "2019-06-21T23:20:50.000001", "transmStatusTransDtTm": "2024-11-08T14:29:00.012345", "errStatusTransDtTm": "9999-12-31T12:55:45.000001", "notStatusTransDtTm": "2019-06-21T23:20:50.000001", "rejStatusTransDtTm": "2024-11-08T14:29:00.012345", "senderBic": "IPSDID21", "messageId": "P08M59270578EA544566A8DB7D970D", "processDataTime": "9999-12-31T12:55:45.000001", "messageStatus": "STD", "liquiTransfId": "INSTRID", "endToEndId": "444596268999", "credAccOwnBic": "IPSDID21XXX", "debAccoOwnBic": "CIPTBITMXXX", "accToBeCred": "IT60X0542811101000000123456", "amountToBeTraser": 9.99, "accToBeDeb": "DE89370400440532013000", "settlDate": "2019-06-21", "requestedThrough": "A2A", "camt025ReceDtTmFromTIPS": "2019-06-21T23:20:50.000001", "receiverBic": "IPSDID21XXX", "tipsTimestamp": "2024-11-08T14:29:00.012345", "origMessId": "P08B59450578EA544526A8DB7D060D", "ltoTipsStatus": "RREJ", "addInfo": "Addinitional Information", "camt054ReceDtTmFromTIPS": "9999-12-31T12:55:45.000001", "notificationId": "210910113003", "accountId": "BE68539007547034", "notificationAmount": 2000.11, "creditDebitIndicator": "CRDT", "debtorBic": "CIPTBITMXXX", "debtorAccountId": "IT60X0542811101000000123456", "creditorBic": "COURFR2TXXX", "creditorAccountId": "DE89370400440532013000", "instructionIdentifcation": "Original Liquidity Transfer reference in Credit/debit Notification (camt.054)", "camt003RecFromPartDtTm": "2019-06-21T23:20:50.000001", "camt004RecDtTmFromTips": "2024-11-08T14:29:00.012345", "accOrCmbId": "BE68539007547034", "accOrCmbUserBic": "IT60X0542811101000000123456", "businessErr": "SC01", "businessErrDes": "Generic Error", "tipsAccoId": "DE89370400440532013000", "currBalance": 389.05, "accCredDebIndic": "DEB", "tipsPartBic": "COURFR2TXXX", "restrictionTypeId": "BLCK", "processingType": "BLCK", "tipsCmbIdentifier": "CMB Id in Return Account camt.004", "cmbLimitAmt": 10, "cmbHeadroom": 1500, "cmbStatus": "NTF", "returnAcctTp": "CFCN", "camt005ReceFromPartDtTm": "9999-12-31T12:55:45.000001", "origTransId": "CCT000000776156310", "participantBic": "IPSDID21XXX", "camt006RecDtTmFromTips": "2019-06-21T23:20:50.000001", "origTransType": "008", "origTransAmount": 9.99, "origInstructingAg": "IPSDPF21XXX", "fnalPayStatusCode": "STLD", "fnalPayStatusTimestamp": "16:00:00", "acceptanceTimestamp": "00:00:01", "receptionTimestamp": "23:59:59", "forwardingTimestamp": "16:00:00", "confReceptTimestamp": "00:00:01", "confToOrigTimestamp": "23:59:59", "reason": "CNOR", "operationalError": "Error occurred when processing the originating query message type Payment Status Query Response (camt.006)", "RT1GrossBalance": 2000.11 } } } } } }, "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" } } } }, "/generateOutboundLto/{senderBic}": { "put": { "tags": [ "TIPS Messages" ], "operationId": "generateOutboundLto", "summary": "A Participant can request the generation of an Outbound LTO", "description": "This API is available for Liquidity Provider Participants only. This API allows a Liquidity Provider to request the generation of an outbound LTO message for a specific Beneficairy PSP. The relevant camt.050 message is then forwarded to TIPS\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Liquidity Provider (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateOutboundLtoRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "participantBic": "IPSDID21", "beneficiaryBicCode": "IPSDID21XXX", "beneficiaryName": "BFF Bank", "beneficiaryAcc": "IT60X0542811101000000123456", "amount": 9.99 } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateOutboundLtoResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "referenceId": "ID028472018304", "messageId": "P08M59270578EA54" } } } } }, "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" } } } }, "/generatePaymentStatusQuery/{senderBic}": { "put": { "tags": [ "TIPS Messages" ], "operationId": "generatePaymentStatusQuery", "summary": "A Participant can request the generation of a Payment Status Query", "description": "A Participant can request the generation of a Payment Status Query Message to be sent to TIPS in order to retrieve the satus of a previously exchanged pacs.008 or pacs.004 message.\nIf the Participant is in Technical Isolation, the request is rejected with ErrorCode XA23.", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Participant (ErrorCode PY01)\nThe SenderBic must not be isolated (“Technical Isolation” flag equal to “No”) (ErrorCode XA23)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratePaymentStatusQueryRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "participantBic": "IPSDID21XXX", "date": "2019-05-02T22:22:00.123-01:10", "transactionId": "TXID20231003JMMVPACS8040", "transactionType": "PRR", "csm": "RT1-TIPS" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratePaymentStatusQueryResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "referenceId": "ID028472018304", "messageId": "P08M59270578EA544566A8DB7D970D" } } } } }, "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" } } } }, "/getAccountBalance/{senderBic}": { "post": { "tags": [ "TIPS Messages" ], "operationId": "getAccountBalance", "summary": "A Participant can request the generation of a get Account Balance to inquiry its DCA account", "description": "This API is available for Liquidity Provider Participants only. This API allows a Liquidity Provider to request the generation of a get Account balance message in order to inquiry its DCA account. The relevant camt.003 message is then forwarded to TIPS.\nIf the Participant is in Technical Isolation, the request is rejected with ErrorCode XA23.", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Liquidity Provider (ErrorCode PY01)\nThe SenderBic must not be isolated (“Technical Isolation” flag equal to “No”) (ErrorCode XA23)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAccountBalanceRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "participantBic": "IPSDID21" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAccountBalanceResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "referenceId": "ID028472018304", "messageId": "P08M59270578EA544566A8DB7D970D" } } } } }, "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" } } } }, "/listBeneficiary/{senderBic}": { "post": { "tags": [ "TIPS Messages" ], "operationId": "listBeneficiary", "summary": "A Participant can inquiry its Beneficiary PSPs", "description": "The List Beneficiary request allows the Liquidity Provider to retrieve all Beneficiaries configured in the System for its BIC", "parameters": [ { "name": "senderBic", "description": "Bic\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Liquidity Provider (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBeneficiaryRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "participantBic": "IPSDID21" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBeneficiaryResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "listBeneficiary": [ { "beneficiaryBic": "IPSDID21XXX", "beneficiaryName": "Paolo Rossi, R. Verdi", "beneficiaryAccount": "IT60X0542811101000000123456" }, { "beneficiaryBic": "CIPTBITMXXX", "beneficiaryName": "Giacomo Giletti", "beneficiaryAccount": "DE89370400440532013000" } ], "endOfList": "0", "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } }, "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" } } } }, "/beneficiaryManagement/{senderBic}": { "put": { "tags": [ "TIPS Messages" ], "operationId": "beneficiaryManagement", "summary": "A Participant can manage its Beneficiary PSPs", "description": "A Liquidity Provider can manage its beneficiary BICs", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Liquidity Provider (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BeneficiaryManagementRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "participantBic": "IPSDID21", "beneficiaryBic": "IPSDID21XXX", "operationType": "INS", "beneficiaryName": "BFF Bank", "beneficiaryAcc": "IT60X0542811101000000123456" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BeneficiaryManagementResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "referenceId": "ID028472018304" } } } } }, "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" } } } }, "/getParticipants/{senderBic}": { "post": { "tags": [ "Participant management" ], "operationId": "getParticipants", "summary": "Searches the participants", "description": "The getParticipants request returns a list of all Participants present in the SCT Inst and is sorted by BIC and InitValidityDate.\nIt is possible to fill one or more fields as filtering criteria: in that case, the API Response returns the full set of rows corresponding to the filter criteria.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** Must be equal to the BIC of the Participants certificate (ErrorCode XA02)\nSending Participant must not have status “Disabled” or “Changed” (ErrorCode PY01)", "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", "criteria": { "bic": "IPSDID21", "technicalBic": "0", "lsp": "0", "tipsAccountOwnerBic": "IPSDID21XXX", "aos": "A01", "status": "ALL", "tipsAdherence": "0", "productId": "INST" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetParticipantsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "responseList": [ { "bic": "IPSDID21", "technicalBic": "0", "lsp": "0", "name": "BFF Bank", "tipsAccountOwnerBic": "IPSDID21XXX", "tipsUserBic": "CIPTBITMXXX", "submittedAOSinst": "A01", "submittedAOSeolo": "A02", "status": "ALL", "initValidityDate": "2019-06-21", "endValidityDate": "2024-08-11", "tipsAdherence": "0", "network": "EAS", "newBic": "CIPTBITM", "newRole": "N", "productList": [ { "productId": "INST" }, { "productId": "EOLO" } ] }, { "bic": "CIPTBITM", "technicalBic": "1", "lsp": "1", "name": "Banca Mediolanum", "tipsAccountOwnerBic": "CIPTBITMXXX", "tipsUserBic": "COURFR2TXXX", "submittedAOSinst": "A02", "submittedAOSeolo": "A03", "status": "CNG", "initValidityDate": "2024-08-11", "endValidityDate": "9999-12-31", "tipsAdherence": "1", "network": "EBX", "newBic": "COURFR2T", "newRole": "Y", "productList": [ { "productId": "INST" }, { "productId": "EOLO" } ] } ] } } } } }, "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" } } } }, "/participantDetails/{senderBic}/{bic}": { "post": { "tags": [ "Participant management" ], "operationId": "participantDetails", "summary": "A Participant can inquiry the details of a single BIC and the parameter modification history with details", "description": "The participantDetails request allows a Participant to retrieve the details of a specified Participant in the SCT Inst.\nIf the inquiring Participant asks for their own details they are allowed to download the complete set of parameters, otherwise they can see only a subset of the whole set.\nThe response contains a list of the parameter modifications associated to the BIC, containing the old configurations, the current one, and the new planned one if it has been already authorized.\n", "parameters": [ { "name": "senderBic", "description": "sender Bic\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must not be a disabled or changed Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } }, { "name": "bic", "description": "Bic", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Bic8" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParticipantDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "bic": "IPSDID21", "technicalBic": "0", "name": "BFF Bank", "lsp": "0", "initValidityDate": "2019-06-21", "endValidityDate": "2024-08-11", "status": "CNG", "parametersHistory": [ { "automaticLiquidityAdjustment": "0", "intraLACAuthAdjst": "1", "initParameterValidity": "2019-06-21", "endParameterValidity": "2024-08-11", "bic": "IPSDID21", "technicalBic": "0", "name": "BFF Bank", "tipsOwnerBic": "IPSDID21XXX", "liquidityManagement": "0", "dcaCashAcctNm": "1234", "tipsUserBic": "CIPTBITMXXX", "submittedAOSinst": "A01", "submittedAOSeolo": "A02", "newBic": "CIPTBITM", "newRole": "N", "branchFundsBalanceId": "IPSDID2100001", "roleChange": "0", "psrReq": "0", "rsfReq": "0", "drrReq": "0", "msrReq": "0", "maxFileSize": 245000000, "compression": "0", "bbTimeoutMgm": "0", "bbPositiveCnf": "0", "tipsAdherence": "0", "tipsNetworkOption": "EAS", "transactionalPrimaryNetId": "EAS", "transactionalSecondaryNetId": "EAS", "transactionalActiveOutputNet": 1, "filePrimaryNetId": "EAS", "fileSecondaryNetId": "EAS", "fileActiveOutputNet": 1, "primaryFileIntRecNetId": "EAS", "secondaryFileIntRecNetId": "EAS", "productList": [ { "productId": "INST", "primaryRecNetId": "EAS", "secondaryRecNetId": "EAS", "primarySendNetId": "EAS", "secondarySendNetId": "EAS", "admissionProfile": "CAD" }, { "productId": "EOLO", "primaryRecNetId": "EBX", "secondaryRecNetId": "EBX", "primarySendNetId": "EBX", "secondarySendNetId": "EBX", "admissionProfile": "CRD" } ], "currenciesList": [ { "currencyCode": "EUR", "currencyDescr": "Euro" }, { "currencyCode": "GBP", "currencyDescr": "Great British pound" } ] }, { "automaticLiquidityAdjustment": "1", "intraLACAuthAdjst": "0", "initParameterValidity": "2024-08-11", "endParameterValidity": "9999-12-31", "bic": "CIPTBITM", "technicalBic": "1", "name": "Banca Mediolanum", "tipsOwnerBic": "CIPTBITMXXX", "liquidityManagement": "1", "dcaCashAcctNm": "4353", "tipsUserBic": "COURFR2TXXX", "submittedAOSinst": "A02", "submittedAOSeolo": "A03", "newBic": "COURFR2T", "newRole": "Y", "branchFundsBalanceId": "CIPTBITM00001", "roleChange": "1", "psrReq": "1", "rsfReq": "1", "drrReq": "1", "msrReq": "1", "maxFileSize": 123000000, "compression": "1", "bbTimeoutMgm": "1", "bbPositiveCnf": "1", "tipsAdherence": "1", "tipsNetworkOption": "SWI", "transactionalPrimaryNetId": "EBX", "transactionalSecondaryNetId": "EBX", "transactionalActiveOutputNet": 1, "filePrimaryNetId": "EBX", "fileSecondaryNetId": "EBX", "fileActiveOutputNet": 2, "primaryFileIntRecNetId": "EBX", "secondaryFileIntRecNetId": "EBX", "productList": [ { "productId": "INST", "primaryRecNetId": "EAS", "secondaryRecNetId": "EAS", "primarySendNetId": "EAS", "secondarySendNetId": "EAS", "admissionProfile": "CAD" }, { "productId": "EOLO", "primaryRecNetId": "EBX", "secondaryRecNetId": "EBX", "primarySendNetId": "EBX", "secondarySendNetId": "EBX", "admissionProfile": "CRD" } ], "currenciesList": [ { "currencyCode": "EUR", "currencyDescr": "Euro" }, { "currencyCode": "GBP", "currencyDescr": "Great British pound" } ] } ] } } } } }, "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" } } } }, "/updateParticipant/{senderBic}": { "put": { "tags": [ "Participant management" ], "operationId": "participant", "summary": "A Participant can update its own configuration", "description": "The UpdateParticipant request allows a Participant to update its configuration in the SCT Inst.\nThe Participant can fill only the new values of the configuration elements that have to be changed; elements that are not present in the request are not involved in the change and the system will keep the existing values for them.\nIf the Participant is an LSP, it is allowed to submit a request for change of its Liquidity Management.\nIf the Participant is an LP, it is not allowed to change its own Liquidity Management parameter.\nThe positive response contains the ReferenceId of the take in charge request for change by the system, but the effective modification of the master data has not been executed yet. Application will only take place after final authorization of the Dual Control by EBA CLEARING. The ReferenceId can be subsequently used in the CommandStatusInquiry request to get the status of the submitted command, see ref. 1.1.\nThe request must anyway be submitted within the “Routing Grace Time”, the system parameter that represents the time limit before midnight for the Participants to submit requests for updates, otherwise it is rejected with ErrorCode XA08.\nThe parameters provided in this API are classified as Critical or non-critical, see ref. 10.20\nDepending on the nature of the parameter, Critical or Not Critical, checks performed on the effective date change:\nFor Critical parameter:\n• if the command is issued on between Monday W1, and Tuesday the first effective date will be the Tuesday of the W3 week\n• if the command is issued between Tuesday Wednesday and Sunday W1 the first effective date will be the Tuesday of the W4\nFor Not Critical parameter:\n• the effective date must be grater than the current business date, , with respect to the End Validity Date configured for the Participant.\nIn case the provisioning operation is inserted without changings (with the exception of the Effective Date), the command is rejected with error code XA31.\n\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateParticipantRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "automaticLiquidityAdjustment": "0", "intraLACAuthAdjst": "1", "liquidityManagement": "0", "tipsAdherence": "0", "technicalBic": "0", "tipsUserBic": "IPSDID21XXX", "bbTimeoutMgm": "0", "tipsDcaAccountId": "1234", "tipsAccountOwnerBic": "CIPTBITMXXX", "name": "BFF Bank", "bbPositiveCnf": "0", "psrReq": "0", "rsfReq": "0", "drrReq": "0", "msrReq": "0", "maxFileSize": 245000000, "compression": "0", "tipsNetworkOption": "EAS", "transactionalPrimaryNetId": "EAS", "transactionalSecondaryNetId": "EAS", "filePrimaryNetId": "EAS", "fileSecondaryNetId": "EAS", "submittedAOSinst": "A01", "submittedAOSeolo": "A02", "primaryFileIntRecNetId": "EAS", "secondaryFileIntRecNetId": "EAS", "effectiveDate": "2019-06-21", "productList": [ { "actionType": "INS", "productId": "INST", "primaryRecNetId": "EAS", "secondaryRecNetId": "EAS", "primarySendNetId": "EAS", "secondarySendNetId": "EAS", "admissionProfile": "CAD" }, { "actionType": "UPD", "productId": "EOLO", "primaryRecNetId": "EBX", "secondaryRecNetId": "EBX", "primarySendNetId": "EBX", "secondarySendNetId": "EBX", "admissionProfile": "CRD" } ] } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateParticipantResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "requestStatus": "ATH", "referenceId": "ID028472018304" } } } } }, "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" } } } }, "/listAPs/{senderBic}": { "post": { "tags": [ "Participant management" ], "operationId": "ListAPs", "summary": "A Participant can inquiry the list of all the AP", "description": "The ListAPs request allows the Participant to retrieve the list of all APs in the SCT Inst sorted by BIC, DPBIC, and Status.\nIt is possible to fill one or more fields as filtering criteria: in this case the response returns the full set of rows matching the criteria.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended, inserted or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAPsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "bicAp": "IPSDID21XXX", "dpBic": "IPSDID21", "aos": "A01", "status": "ALL", "productId": "INST" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAPsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "apList": [ { "bicAp": "IPSDID21XXX", "dpBic": "IPSDID21", "name": "BFF Bank", "submittedAOSinst": "A01", "submittedAOSeolo": "A02", "status": "ALL", "initParticipantValidity": "2019-06-21", "endParticipantValidity": "2024-08-11", "tipsUserBic": "IPSDID21XXX", "newBic": "CIPTBITMXXX", "newRole": "N", "productList": [ { "productId": "INST" }, { "productId": "EOLO" } ] }, { "bicAp": "CIPTBITMXXX", "dpBic": "CIPTBITM", "name": "Banca Mediolanum", "submittedAOSinst": "A02", "submittedAOSeolo": "A03", "status": "CNG", "initParticipantValidity": "2024-08-11", "endParticipantValidity": "9999-12-31", "tipsUserBic": "CIPTBITMXXX", "newBic": "COURFR2TXXX", "newRole": "Y", "productList": [ { "productId": "INST" }, { "productId": "EOLO" } ] } ] } } } } }, "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" } } } }, "/apDetails/{senderBic}/{bicAp}": { "post": { "tags": [ "Participant management" ], "operationId": "APDetails", "summary": "A Participant can inquiry the details of a single AP and its parameter modification history", "description": "The APDetails request allows the Participant to retrieve the details of an AP.\nThe response contains the details of the specified AP.\nA request addressed to an AP belonging to the sending participant will be responded with the full set of information available.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended, inserted or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } }, { "name": "bicAp", "description": "The BIC of the inquired AP", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/BicAp" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "apDetail": [ { "paramHistory": { "bicAp": "IPSDID21XXX", "dpBic": "IPSDID21", "name": "BFF Bank", "submittedAOSinst": "A01", "submittedAOSEolo": "A02", "status": "CNG", "initParticipantValidity": "2019-06-21", "endParticipantValidity": "2024-08-11" }, "details": [ { "newBic": "IPSDID21XXX", "tipsUserBic": "IPSDID21XXX", "bbPositiveCnf": "0", "bbTimeoutMgm": "0", "roleChange": "0", "productList": [ { "productId": "INST", "admissionProfile": "CAD" }, { "productId": "EOLO", "admissionProfile": "CRD" } ] }, { "newBic": "CIPTBITMXXX", "tipsUserBic": "CIPTBITMXXX", "bbPositiveCnf": "1", "bbTimeoutMgm": "1", "roleChange": "1", "productList": [ { "productId": "INST", "admissionProfile": "CAD" }, { "productId": "EOLO", "admissionProfile": "CRD" } ] } ] } ] } } } } }, "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" } } } }, "/updateAP/{senderBic}": { "put": { "tags": [ "Participant management" ], "operationId": "UpdateAP", "summary": "A Participant can update the configuration of one of its AP", "description": "The UpdateAP request allows the Participant to update the configuration of a specific AP that the Participant manages in the SCT Inst.\nThe positive response contains the ReferenceId of the take in charge request for change by the system, but the effective modification of the master data has not been executed yet. Application will only take place after final authorization of the Dual Control by EBA CLEARING. The ReferenceId can be subsequently used in the CommandStatusInquiry request to get the status of the submitted command, see ref. 1.1.\nThe negative response contains the Code 204 if no record satisfying the set criteria is found.\nThe request must anyway be submitted within the “Routing Grace Time”, the system parameter that represents the time limit before midnight for the Participants to submit requests for updates, otherwise it is rejected with ErrorCode XA08\nIn case the provisioning operation is inserted without changings (with the exception of the Effective Date), the command is rejected with error code XA31.", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, inserted or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAPRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "bbPositiveCnf": "0", "bbTimeoutMgm": "0", "bicAp": "IPSDID21XXX", "name": "BFF Bank", "submittedAOSinst": "A01", "submittedAOSeolo": "A02", "tipsUserBic": "CIPTBITMXXX", "effectiveDate": "2019-06-21", "productList": [ { "productId": "INST", "admissionProfile": "CAD" }, { "productId": "EOLO", "admissionProfile": "CRD" } ] } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAPResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "referenceId": "ID028472018304", "requestStatus": "ATH" } } } } }, "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" } } } }, "/changeStatusAP/{senderBic}": { "put": { "tags": [ "Participant management" ], "operationId": "ChangeStatusAP", "summary": "A Participant can set one of its APs in R-Only or Disable status", "description": "The ChangeStatusAP request allows the Participant to change the status of an AP that it manages in the SCT Inst, to:\n- r-only (“RON”) if it was a valid AP (enabled) or to\n- Disabled (“DIS”) if it was an r-only AP.\nThe positive response contains the ReferenceId of the take in charge request for change by the system, but the effective modification of the master data has not been executed yet. Application will only take place after final authorization of the Dual Control by EBA CLEARING. The ReferenceId can be subsequently used in the CommandStatusInquiry request to get the status of the submitted command, see ref. 1.1.\nThe negative response contains the Code 204 if no record satisfying the set criteria is found.\nThe request must anyway be submitted within the “Routing Grace Time”, the system parameter that represents the time limit before midnight for the Participants to submit requests for updates, otherwise it is rejected with ErrorCode XA08.\nThe removal (status set as Disabled) can be performed on a non-target day.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, inserted or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeStatusAPRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "bicAp": "IPSDID21XXX", "newStatus": "DIS", "effectiveDate": "2019-06-21", "effectiveEndValidityDate": "2024-08-11" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeStatusAPResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "referenceId": "ID028472018304" } } } } }, "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" } } } }, "/insertAP/{senderBic}": { "put": { "tags": [ "Participant management" ], "operationId": "InsertAP", "summary": "A Participant can insert one AP, linked to him", "description": "The InsertAP request allows the Participant to add a new AP that it wants to manage in the SCT Inst.\nThe positive response contains the ReferenceId of the take in charge request for change by the system, but the effective modification of the master data has not been executed yet. Application will only take place after final authorization of the Dual Control by EBA CLEARING. The ReferenceId can be subsequently used in the CommandStatusInquiry request to get the status of the submitted command, see ref. 1.1.\nThe request must anyway be submitted within the “Routing Grace Time”, the system parameter that represents the time limit before midnight for the Participants to submit requests for updates, otherwise it is rejected with ErrorCode XA08.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, inserted or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertAPRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "bicAp": "IPSDID21XXX", "name": "BFF Bank", "submittedAOSinst": "A01", "submittedAOSeolo": "A02", "bbPositiveCnf": "0", "bbTimeoutMgm": "0", "tipsUserBic": "CIPTBITMXXX", "initParticipantValidity": "2019-06-21", "endParticipantValidity": "2024-08-11", "productList": [ { "productId": "INST", "admissionProfile": "CAD" }, { "productId": "EOLO", "admissionProfile": "CRD" } ] } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertAPResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "referenceId": "ID028472018304" } } } } }, "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" } } } }, "/communicationOfUnavailability/{senderBic}": { "put": { "tags": [ "Participant management" ], "operationId": "CommunicationOfUnavailability", "summary": "A Participant can communicate his temporary unavailability", "description": "The Communication of unavailability request allows the Participant to communicate his temporary unavailability.\nUsing this API, RT1 user can inform the system about the unavailability or the resumption of availability. It 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). Optionally, RT1 users can indicate whether all the other RT1 users shall be informed. In such a case, all RT1 users can access to the information.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, r-only or suspended Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationOfUnavailabilityRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "eventCode": "INS", "unavailableBic": "IPSDID21XXX", "messageId": "P08M59270578EA544566A8DB7D970D", "startDateTime": "2019-05-02T22:22:00.123-01:10", "endDateTime": "2019-05-02T22:22:00.123-01:10", "eventDescription": "PARTICIPANT BIC8CODE IS NOT PRESENT", "productsUnavailable": "INST", "apspsUnavailability": "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": "IPSDID21XXX" } } } } }, "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" } } } }, "/inquiryUnavailability/{senderBic}": { "post": { "tags": [ "Participant management" ], "operationId": "inquiryUnavailability", "summary": "A Participant can inquiry the list of unavailable Participants", "description": "The Inquiry Unavailability request allows the RT1 user to inquire about the unavailability of:\n• RT1 Participants, based on what has been communicated through the Communication of Unavailability function.\n• A TIPS Participants, based on the messages sent by TIPS to RT1.\nThe two search options are mutually exclusive, as follows:\n• When “fromTIPS” is set to “1”, the search result includes all CS admi.004 messages received from TIPS. If present, the element “unavailableBic” is not taken into account.\n• When “fromTIPS” is set to “0” or is not present, the search result includes any admi.004 message, both CS admi.004 (triggered by an admi.004 received from TIPS) and admi.004 received from RT1 Participants. If “unavailableBic” is present and set to a specific BIC code, it is used as a filter.\n• When the request is sent without the elements “unavailableBic” and “fromTIPS”, the search result includes all current or future unavailability periods generated by any RT1 Participant, as well as all current or future unavailability periods generated by CS with the TIPS BIC as sender BIC.\n\nIf the unavailability has been communicated for a specific RT1 Participant and for all its APSPs (“BIC Code” = BIC8 and “APSPs Unavailability” checked), the APSP BICs unavailability information shall be available in the “Inquiry Unavailability” functionality even if the unavailability information has been required for a Participant BIC8 in “BIC Code” searching criteria field.", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, r-only or suspended Participant (ErrorCode PY01)", "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": "IPSDID21XXX", "fromTIPS": "0" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquiryUnavailabilityResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "list": [ { "senderBIC": "IPSDID21XXX", "unavailableBic": "CIPTBITMXXX", "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", "productsUnavailable": "INST", "apspsUnavailability": "0" }, { "senderBIC": "CIPTBITMXXX", "unavailableBic": "COURFR2TXXX", "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", "productsUnavailable": "EOLO", "apspsUnavailability": "1" } ] } } } } }, "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" } } } }, "/listParticipantOperation/{senderBic}": { "post": { "tags": [ "Participant management" ], "operationId": "ListParticipantOperation", "summary": "A Participant can inquiry the list of its Participants’ Operation", "description": "The List Participant Operation request allows the Participant to retrieve the list of a specific operations based on a search filter.\nThe response returns the requested details or Code 204 if no record satisfying the criteria is found.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must not be a disabled or changed Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListParticipantOperationRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "operationType": "INS", "referenceId": "ID028472018304", "critical": "0", "status": "WTG", "requestor": "ID20391", "dateOfRequestFrom": "2019-06-21", "dateOfRequestTo": "2024-08-11", "confirmer": "ID403821", "dateOfConfirmFrom": "6/21/2019", "dateOfConfirmTo": "6/21/2019", "authorizer": "CO0A222", "dateOfExecutionFrom": "9999-12-31", "dateOfExecutionTo": "2019-06-21" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListParticipantOperationResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "numRecordFound": 1, "responseList": [ { "operationType": "INS", "referenceId": "ID028472018304", "critical": "0", "status": "WTG", "requestor": "ID20391", "dateOfRequest": "2019-06-21", "confirmer": "ID403821", "dateOfConfirm": "6/21/2019", "authorizer": "CO0A222", "dateOfExecution": "2024-08-11" }, { "operationType": "REM", "referenceId": "ID0452050454", "critical": "1", "status": "SUB", "requestor": "ID84739", "dateOfRequest": "2024-08-11", "confirmer": "ID039284", "dateOfConfirm": "6/21/2019", "authorizer": "ID74823", "dateOfExecution": "9999-12-31" } ], "endOfList": "0", "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } }, "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" } } } }, "/participantOperationDetails/{senderBic}/{referenceId}": { "post": { "tags": [ "Participant management" ], "operationId": "ParticipantOperationDetails", "summary": "A Participant can inquiry the detail of a specific Participant Operation command", "description": "The Participant Operation Details request allows the Participant to retrieve the details of specific provisioning operations based on a search filter.\nThe response returns the requested details or Code 204 if no record satisfying the criteria is found.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must not be a disabled or changed Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } }, { "name": "referenceId", "description": "Unique reference ID of the operation", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ReferenceId1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParticipantOperationDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "operationDetails": { "operationType": "INS", "referenceId": "ID028472018304", "critical": "0", "status": "WTG", "requestor": "ID20391", "dateOfRequest": "2019-06-21", "confirmer": "ID403821", "dateOfConfirm": "6/21/2019", "authorizer": "CO0A222", "dateOfExecution": "2024-08-11", "initParameterValidity": "9999-12-31", "endParameterValidity": "2019-06-21" }, "participantOperationDetails": { "dpBic": "IPSDID21", "name": "BFF Bank", "initParticipantValidity": "2019-06-21", "endParticipantValidity": "2024-08-11", "technicalBic": "0", "bbPositiveCnf": "0", "bbTimeoutMgm": "0", "liquidityManagement": "0", "branchFundsBalanceId": "IPSDID2100001", "tipsAdherence": "0", "tipsNetwOpt": "EAS", "compression": "0", "LSP": "0", "automaticLiquidityAdjus": "0", "tipsUserBic": "IPSDID21XXX", "tipsAccoOwnBic": "IPSDID21XXX", "tipsDcaCashAccountNumber": "123456IPHSITM0DCA0001", "activeOutNet": 1, "primaryFileIntRecNetId": "EAS", "secondaryFileIntRecNetId": "EAS", "msrReq": "0", "psrReq": "0", "rsfReq": "0", "drrReq": "0", "maxFileSize": 1, "submittedAOS": "A01", "traInterfActiveOutputNet": 2, "filePrimaryNetId": "EAS", "fileSecondaryNetId": "EAS", "transactionalPrimaryNetId": "EAS", "transactionalSecondaryNetId": "EAS", "productList": [ { "productId": "INST", "primaryRecNetId": "EAS", "primarySendNetId": "EAS", "secondaryRecNetId": "EAS", "secondarySendNetId": "EAS", "admissionProfile": "CAD" }, { "productId": "EOLO", "primaryRecNetId": "EBX", "primarySendNetId": "EBX", "secondaryRecNetId": "EBX", "secondarySendNetId": "EBX", "admissionProfile": "CRD" } ] }, "apOperationDetails": { "bicCode": "IPSDID21XXX", "name": "BFF Bank", "participantBic": "IPSDID21", "participantName": "Banca Mediolanum", "admissionProfile": "CAD", "bbPositiveCnf": "0", "bbTimeoutMgm": "0", "ProductIds": "INST", "aosListInst": "A01", "aosListEolo": "A02", "tipsUserBic": "IPSDID21XXX", "endValidityDate": "2019-06-21", "currentPBICCode": "IPSDPF21XXX", "requesterPBICCode": "IPSDPF21XXX" }, "massiveInsertDetails": [ { "bicCode": "IPSDID21XXX", "name": "BFF Bank", "dpBic": "CIPTBITMXXX", "admissionProfile": "CAD-INSTCRD-EOLOCAD-IXPB", "submittedAOSinst": "A01", "submittedAOSeolo": "A02", "initValidity": "2019-06-21", "endValidity": "2024-08-11", "productId": "INST", "bbPositiveCnf": "0", "tipsUserBic": "IPSDID21XXX" }, { "bicCode": "CIPTBITMXXX", "name": "Banca Mediolanum", "dpBic": "COURFR2TXXX", "admissionProfile": "CAD-INSTCRD-EOLOCAD-IXPB", "submittedAOSinst": "A02", "submittedAOSeolo": "A03", "initValidity": "2024-08-11", "endValidity": "9999-12-31", "productId": "EOLO", "bbPositiveCnf": "1", "tipsUserBic": "CIPTBITMXXX" } ] } } } } }, "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" } } } }, "/rejectParticipantOperation/{senderBic}/{referenceId}": { "put": { "tags": [ "Participant management" ], "operationId": "RejectParticipantOperation", "summary": "A Participant can reject a Participant Operation command", "description": "The Reject Participant Operation allows the Participant to reject a specific change operation submitted and not yet authorized. (See 10.11)\nThe response contains the confirmation or rejection of the request, Code 204 is returned if no record is found satisfying the selected criteria.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } }, { "name": "referenceId", "description": "The ReferenceId generated by the CS when the request to update was sent\n\n **Validation Rule(s)** The change operation corresponding to the ReferenceId must not have been authorized yet (ErrorCode XA07", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ReferenceId1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectParticipantOperationResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "operationItem": { "submissionDate": "2019-06-21T23:20:50.000001", "referenceId": "ID028472018304", "requestStatus": "ATH" } } } } } }, "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" } } } }, "/manageAAURT1ASTA/{senderBic}": { "put": { "tags": [ "Participant management" ], "operationId": "manageAAURT1ASTA", "summary": "Allow Participant to manage the BIC11 registered in TIPS as AAU (Authorised Account User) of the RT1 ASTA (Ancillary System Technical Account).", "description": "Allow Participant to manage the BIC11 registered in TIPS as AAU (Authorised Account User) of the RT1 ASTA (Ancillary System Technical Account).", "parameters": [ { "name": "senderBic", "description": "The BIC of EBA CL sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageAAURT1ASTARequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "eventCode": "INS", "bicCode": "IPSDID21", "aauRt1Asta": "IPSDID21XXX", "aauRt1AstaInitValidity": "2019-06-21", "aauRt1AstaEndValidity": "2024-08-11" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageAAURT1ASTAResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "referenceId": "ID028472018304" } } } } }, "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" } } } }, "/listAAURT1ASTA/{senderBic}": { "post": { "tags": [ "Participant management" ], "operationId": "listAAURT1ASTA", "summary": "A Participant cal inqury the list of the RT1 TIPS ASTA AAU data for a specific Participant BIC8 and its APSPs configured in TIPS. ", "description": "A Participant cal inqury the list of the RT1 TIPS ASTA AAU data for a specific Participant BIC8 and its APSPs configured in TIPS.\nThe listAAURT1ASTA request allows Participant to retrieve and download the list of all “AAU RT1 ASTA in TIPS BIC” configured for itself.", "parameters": [ { "name": "senderBic", "description": "The BIC of EBA CL sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAAURT1ASTARequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "bicCode": "IPSDID21", "aauRt1Asta": "IPSDID21XXX" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAAURT1ASTAResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "aauList": { "bicCode": "IPSDID21", "aauRt1Asta": "IPSDID21XXX", "aauRt1AstaInitValidity": "2019-06-21", "aauRt1AstaEndValidity": "2024-08-11" } } } } } }, "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" } } } }, "/listPayments/{senderBic}": { "post": { "tags": [ "Transaction inquiry" ], "operationId": "ListPayments", "summary": "A Participant can inquiry the list of pacs.008 in which he is or the instructing or the instructed agent", "description": "The Participant has the option to search for the instant payment pacs.008 using two date search criteria: (1) Acceptance Date and Time; (2) Reception Date and Time.\n(1) To search transactions by Acceptance Date and Time, the option \"isReceptionDate\" shall be set to \"0\". The Participant may specify the \"acceptanceReceptionDate\" date and the \"timeFrom\" time as the starting point of the search, using the same UTC format as the AT‑T056 included in the instant payment pacs.008.\n(2) To search transactions by Reception Date and Time, the option \"isReceptionDate\" must be set to \"1\". The Participant may specify the \"acceptanceReceptionDate\" date together with the \"timeFrom\" – \"timeTo\" interval, ensuring that the selected timeframe does not exceed one hour.\nIn both cases, the Participant may provide time values down to the millisecond to refine the search time interval.", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPaymentsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "paymentDetails": { "isReceptionDate": "0", "acceptanceReceptionDate": "2019-06-21", "timeFrom": "16:00:00", "timeTo": "00:00:01", "transactionId": "TXID20231003JMMVPACS8040", "debtorBic": "IPSDID21XXX", "creditorBic": "CIPTBITMXXX", "instructingBic": "IPSDID21", "instructedBic": "CIPTBITM", "ipStatus": "PBB", "lac": "1", "endToEndID": "444596268999", "csm": "RT1-TIPS", "amountRange": { "amountRangeFrom": 9.99, "amountRangeTo": 2000.11 }, "productId": "INST" } }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPaymentsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "numPayments": 1, "listPayment": [ { "paymentDetails": { "isReceptionDate": "0", "acceptanceReceptionDateTime": "2019-05-02T22:22:00.123-01:10", "transactionId": "TXID20231003JMMVPACS8040", "debtorBic": "IPSDID21XXX", "creditorBic": "CIPTBITMXXX", "instructingBic": "IPSDID21", "instructedBic": "CIPTBITM", "credSettMethod": "LQPS", "debSettMethod": "LQPS", "amount": 9.99, "ipStatus": "PBB", "reasonCode": "AB06", "lac": "1", "endToEndID": "444596268999", "productId": "INST" } } ], "endOfList": "0", "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } }, "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" } } } }, "/paymentDetails/{senderBic}": { "post": { "tags": [ "Transaction inquiry" ], "operationId": "PaymentDetails", "summary": "A Participant can inquiry the detail of a single payment", "description": "The PaymentDetails request allows the Participant to retrieve the details of a specific Payment Transaction that it sent to or received from the SCT Inst.\nThe response returns the requested details.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "acceptanceDateTime": "2019-05-02T22:22:00.123-01:10", "transactionId": "TXID20231003JMMVPACS8040", "debtorBic": "IPSDID21XXX", "csm": "RT1-TIPS" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "paymentDetails": { "acceptanceDateTime": "2019-05-02T22:22:00.123-01:10", "transactionId": "TXID20231003JMMVPACS8040", "debtorBic": "IPSDID21XXX", "trxDirection": "IN", "instructedAmt": 9.99, "originalCurrency": "USD", "uetr": "6fcc7290-7e8d-4518-a8c7-3c5c640b7f7b" }, "interbankSettlementDate": "2019-06-21", "creditorBic": "IPSDID21XXX", "instructingBic": "IPSDID21", "instructedBic": "CIPTBITM", "amount": 9.99, "acceptanceTime": "16:00:00", "productId": "INST", "aos": "A01", "receptionTime": "00:00:01", "sendingTime": "23:59:59", "confirmationTime": "16:00:00", "sendingConfirmationTime": "00:00:01", "ipStatus": "PBB", "reasonCode": "AB06" } } } } }, "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" } } } }, "/listTransactions/{senderBic}": { "post": { "tags": [ "Transaction inquiry" ], "operationId": "listTransactions", "summary": "A Participant can inquiry the list of pacs.004, pacs.002, pacs.028, camt.056, camt.027, camt.029, in which he is or the instructing or the instructed agent", "description": "The ListTransactions request allows the Participant to retrieve a list of R-messages (pacs.004, pacs.002, pacs.028, camt.056, camt.027 and camt.029) send to or received from the SCT Inst. The Participant has the option to use filtering criteria to reduce the number of transactions in the response.\nThe Participant has the option to search for the R-messages using two date search criterion: (1) Settlement Date and Time; (2) Reception Date and Time.\n(1) To search for R-messages by Settlement Date and Time criteria, the option \"isReceptionDate\" shall be set to \"0\". The Participant must specify the \"settlementReceptionDate\" date and the \"timeFrom\" time as the start point of the search.\n(2) To search for R-messages by Reception Date and Time criteria, the option \"isReceptionDate\" shall be set to \"1\". The Participant must specify the \" settlementReceptionDate\" date and the time interval \"timeFrom\" – \"timeTo\", ensuring that the timeframe does not exceed one hour.\nIn both cases, the Participant has the option to specify the time down to the millisecond level to fine‑tune the timeframe of the search.\nIn the case that the result has more than 1000 matching transactions, the response will contain an offset. By resubmitting the same request with a different offset value the Participant can retrieve all matching transactions.\nThe response will return a list of all R-messages, matching the criteria of the request that is sorted by TransactionId, ProcessingDate, ReceptionTime, InstructingBic, InstructedBic and TransactionStatus. The resulting list shall contain a maximum of 1000 R-messages.\nThe transactions rejected due to acceptance-date-time (AT-T056) already expired when received by RT1 System are not displayed (In case the pacs.008 cannot be delivered to the BB, because it is not reacheable (AB07) or when the pacs.008 arrive in the CS already overdue (and it is consequently not delivered to the BB and rejected to the OB for timeout - AB06), the transaction will not be visible in the PWS and API by the Beneficiary Bank but will be notified in the RSF file. In case the transaction is delivered to the BB and then goes in timeout (TM01 for BB and AB06 for OB), it is then visible via PWS and API to both OB and BB.)\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "transactionDetails": { "transactionId": "TXID20231003JMMVPACS8040", "transactionType": "PRR", "isReceptionDate": "0", "settlementReceptionDate": "2019-06-21", "debtorBic": "IPSDID21XXX", "creditorBic": "CIPTBITMXXX" }, "originalTransactionId": "CCT000000776156310", "lac": "1", "reasonCode": "AB06", "processingDate": "2019-06-21", "instructingBic": "IPSDID21", "instructedBic": "CIPTBITM", "amountRange": { "amountRangeFrom": 9.99, "amountRangeTo": 2000.11 }, "timeFrom": "16:00:00", "timeTo": "00:00:01", "originalAmount": 9.99, "originalSettlementDate": "2024-08-11", "aos": "A01", "transactionStatus": "STD", "originalEndToEndID": "SC042411081653", "csm": "RT1-TIPS", "productId": "INST" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "numTransactions": 1, "listTransactions": [ { "csm": "RT1-TIPS", "transactionDetails": { "transactionId": "TXID20231003JMMVPACS8040", "transactionType": "PRR", "settlementDate": "2019-06-21", "debtorBic": "IPSDID21XXX", "creditorBic": "CIPTBITMXXX" }, "instructingBic": "IPSDID21", "instructedBic": "CIPTBITM", "credSettMethod": "LQPS", "debSettMethod": "LQPS", "amount": 9.99, "lac": "1", "processingDate": "2019-06-21", "receptionTime": "2019-05-02T22:22:00.123-01:10", "transactionStatus": "STD", "reasonCode": "AB06", "reasonCodeToOB": "AB06", "reasonCodeToBB": "AB06", "originalEndToEndID": "SC042411081653", "productId": "INST" }, { "csm": "TIPS", "transactionDetails": { "transactionId": "TXID20231003JMMVPACS8040", "transactionType": "PRR", "settlementDate": "2019-06-21", "debtorBic": "IPSDID21XXX", "creditorBic": "CIPTBITMXXX" }, "instructingBic": "CIPTBITM", "instructedBic": "COURFR2T", "credSettMethod": "RT1A", "debSettMethod": "RT1A", "amount": 2000.11, "lac": "2", "processingDate": "2024-08-11", "receptionTime": "2019-05-02T22:22:00.123-01:10", "transactionStatus": "NTF", "reasonCode": "AB07", "reasonCodeToOB": "AB07", "reasonCodeToBB": "AB07", "originalEndToEndID": "SC042411081655", "productId": "EOLO" } ], "endOfList": "0", "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } }, "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" } } } }, "/transactionDetails/{senderBic}": { "post": { "tags": [ "Transaction inquiry" ], "operationId": "transactionDetails", "summary": "A Participant can inquiry the details of a single pacs.004, pacs.002, pacs.028, camt.056, camt.029 message", "description": "The TransactionDetails request allows the Participant the retrieve the details of a specific R-message, Payment Status Report or Investigation sent to or received by the SCT Inst.\nThe response contains the R-message, Payment Status Report or Investigation details.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "transactionId": "TXID20231003JMMVPACS8040", "transactionType": "PRR", "settlementDate": "2019-06-21", "debtorBic": "IPSDID21XXX", "creditorBic": "CIPTBITMXXX", "csm": "RT1-TIPS" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "transactionDetails": { "transactionId": "TXID20231003JMMVPACS8040", "transactionType": "PRR", "settlementDate": "2019-06-21", "debtorBic": "IPSDID21XXX", "creditorBic": "CIPTBITMXXX", "csm": "RT1-TIPS", "trxDirection": "IN", "instructedAmt": 9.99, "originalCurrency": "USD", "uetr": "6fcc7290-7e8d-4518-a8c7-3c5c640b7f7b" }, "debtorSettlementMethod": "LQPS", "creditorSettlementMethod": "LQPS", "lac": "1", "debitPartyBic": "IPSDID21XXX", "creditPartyBic": "CIPTBITMXXX", "instructingBic": "IPSDID21", "instructedBic": "CIPTBITM", "amount": 9.99, "productId": "INST", "aos": "A01", "originalSettlementDate": "2019-06-21", "originalTransactionId": "CCT000000776156310", "originalAmount": 2000.11, "routingType": "DIR", "transactionStatus": "STD", "reasonCode": "AB06", "reasonCodeToOB": "AB06", "reasonCodeToBB": "AB06", "receptionTime": "2019-05-02T22:22:00.123-01:10", "sendingTimeToOB": "2019-05-02T22:22:00.123-01:10", "sendingTimeToBB": "2019-05-02T22:22:00.123-01:10", "confirmationTimeFromBB": "2019-05-02T22:22:00.123-01:10", "confirmationTimeToBB": "2019-05-02T22:22:00.123-01:10" } } } } }, "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" } } } }, "/listFiles/{senderBic}": { "post": { "tags": [ "Transaction inquiry" ], "operationId": "listFiles", "summary": "A Participant can inquiry the files received, homogeneous per file type (i.e. all the PSR for one day).", "description": "The List Files request allows the Participant to retrieve a list of files sent by the SCT Inst to the Participant. The Participant has the option to use filtering criteria to reduce the number of files in the response.\nThe response will return a list of all files that match the criteria of the request and is sorted by DateFrom, TimeFrom, FileType, FilreRef and FileStatus. The resulting list shall contain a maximum of 1000 files, or Code 204 if no record satisfying the set criteria is found.\nThe system shall use the AcceptanceDateTimeFrom timestamp as the start point of the search. The Participant has the option to specify the DateTimeFrom up to the level of seconds to fine-tune the timeframe of the search. Milliseconds and nanoseconds are not supported by the API.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFilesRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "fileType": "RSF", "dateFrom": "2019-06-21", "dateTo": "2024-08-11", "timeFrom": "16:00:00", "timeTo": "00:00:01", "fileReference": "DSCI210301000015", "fileStatus": "TSD" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFilesResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "numFiles": 1, "listFiles": [ { "fileDetails": { "fileType": "RSF", "fileDateTime": "2019-06-21T23:20:50.000001", "fileReference": "DSCI210301000015" }, "fileStatus": "TSD", "netFileName": "EBICS", "network": "EAS" }, { "fileDetails": { "fileType": "RSF", "fileDateTime": "2019-06-21T23:20:50.000001", "fileReference": "DSCI210301000015" }, "fileStatus": "TSG", "netFileName": "SIANET", "network": "EBX" } ], "endOfList": "0", "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } }, "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" } } } }, "/fileDetails/{senderBic}": { "post": { "tags": [ "Transaction inquiry" ], "operationId": "fileDetails", "summary": "A Participant can inquiry the details of a single file", "description": "The FileDetails request allows the Participant to retrieve the details of a file received from the SCT Inst.\nThe response returns the details of the file specified.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "fileType": "RSF", "fileDate": "2019-06-21", "fileReference": "DSCI210301000015" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "receiverBic": "IPSDID21", "sendingDateTime": "2024-11-08T14:29:00.012345", "fileReference": "DSCI210301000015", "fileType": "RSF", "businessDate": "2019-06-21", "netFileName": "EBICS", "network": "EAS", "lac": "1", "fileStatus": "TSD", "listDRRData": { "recordType": "HDRR", "ipDataDRR": { "amountHeldIP": 9.99, "numHeldIP": 1, "ipData": { "numSentIP": 1, "numRjtIP": 1, "numSettledIP": 1, "amountSentIP": 9.99, "amountRjtIP": 2000.11, "amountSettledIP": 389.05 } }, "prrDataDRR": { "numHeldPRR": 1, "amountHeldPRR": 9.99, "prrData": { "numSentPRR": 1, "numRjtPRR": 1, "numSettledPRR": 1, "amountSentPRR": 9.99, "amountRjtPRR": 2000.11, "amountSettledPRR": 389.05 } }, "nrrData": { "numSentNRR": 1, "numRjtNRR": 1 }, "recallData": { "numSentRecall": 1, "numRjtRecall": 1, "amountSentRecall": 9.99, "amountRjtRecall": 2000.11 }, "investigationData": { "numSentInvestigation": 1, "numReceivedInvestigation": 1 }, "updatedData": { "numSentReqStatusUpd": 1, "numReceivedReqStatusUpd": 1 } }, "listMSRData": { "recordType": "HDRR", "ipData": { "numSentIP": 1, "numRjtIP": 1, "numSettledIP": 1, "amountSentIP": 9.99, "amountRjtIP": 2000.11, "amountSettledIP": 389.05 }, "prrData": { "numSentPRR": 1, "numRjtPRR": 1, "numSettledPRR": 1, "amountSentPRR": 9.99, "amountRjtPRR": 2000.11, "amountSettledPRR": 389.05 }, "nrrData": { "numSentNRR": 1, "numRjtNRR": 1 }, "recallData": { "numSentRecall": 1, "numRjtRecall": 1, "amountSentRecall": 9.99, "amountRjtRecall": 2000.11 } } } } } } }, "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" } } } }, "/listCommandStatus/{senderBic}": { "post": { "tags": [ "Command inquiry" ], "operationId": "listCommandStatus", "summary": "A Participant can inquiry the list of all commands issued by its staff via GUI or via API that fall under Dual Control", "description": "The ListCommandsStatus request allows the Participant to retrieve a list of all commands issued by its staff via GUI or via API that fall under Dual Control. It is possible to filter the result to a particular command type or requestor.\nThe SCT Inst uses the RequestDateTime as the starting point of the response data which is sorted by SubmissionDate, RequestStatus and CommandType. The Response is limited by a maximum of 1000 commands.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCommandStatusRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "requestDateTimeFrom": "2019-06-21T23:20:50.000001", "requestDateTimeTo": "2024-11-08T14:29:00.012345", "executionDateTimeFrom": "9999-12-31T12:55:45.000001", "executionDateTimeTo": "2019-06-21T23:20:50.000001", "commandType": "INS", "userAuthReject": "CO0A222", "userIssuer": "ID20391" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCommandStatusResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandList": [ { "submissionDate": "2019-06-21T23:20:50.000001", "referenceId": "ID028472018304", "requestStatus": "ATH", "commandType": "INS", "requestor": "ID20391", "authorizer": "CO0A222", "authorizationDate": "2019-06-21" }, { "submissionDate": "2024-11-08T14:29:00.012345", "referenceId": "ID0452050454", "requestStatus": "WTG", "commandType": "UPD", "requestor": "ID84739", "authorizer": "ID74823", "authorizationDate": "2024-08-11" } ], "endOfList": "0", "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } }, "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" } } } }, "/commandStatusDetails/{senderBic}/{referenceId}": { "post": { "tags": [ "Command inquiry" ], "operationId": "commandStatusDetails", "summary": "A Participant can inquiry the details of a specific command submitted to the system", "description": "The Command Status Details request allows the Participant to view the details of a specific command that it submitted to the system.\nThe response contains the details of the command submitted by the Participant, or Code 204 if no record is found satisfying the selected criteria\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } }, { "name": "referenceId", "description": "The univocal ReferenceId that was generated by the system when the request for change was submitted", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ReferenceId1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommandStatusDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandItem": { "submissionDate": "2019-06-21T23:20:50.000001", "referenceId": "ID028472018304", "requestStatus": "ATH", "commandType": "INS", "requestor": "ID20391", "authorizer": "CO0A222", "authorizationDate": "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" } } } }, "/commandDelete/{senderBic}/{referenceId}": { "put": { "tags": [ "Command inquiry" ], "operationId": "commandDelete", "summary": "A Participant can delete a specific command that was submitted to the system and that has not been authorized yet by EBA CLEARING staff", "description": "The Command Delete request allows the Participant to delete a specific command that was submitted to the system and that has not been authorized yet by EBA CLEARING staff.\nThe response contains the confirmation or rejection of the request, Code 204 is returned if no record is found satisfying the selected criteria.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } }, { "name": "referenceId", "description": "The univocal ReferenceId that was generated by the system when the request for change was submitted\n\n **Validation Rule(s)** The command corresponding to the ReferenceId must not have been authorized yet (ErrorCode XA07)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ReferenceId2" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommandDeleteResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandItem": { "submissionDate": "2019-06-21T23:20:50.000001", "referenceId": "ID028472018304", "requestStatus": "ATH", "commandType": "INS", "requestor": "ID20391", "authorizer": "CO0A222", "authorizationDate": "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" } } } }, "/listAlerts/{senderBic}": { "post": { "tags": [ "Command inquiry" ], "operationId": "listAlerts", "summary": "A Participant can inquiry the alerts that were generated by the SCT Inst for that Participant", "description": "The ListAlerts Request allows the Participant to get all the alerts that were generated by the SCT Inst for the Participant. The Participant can use filtering criteria to restrict the number of alerts listed.\nIf the Participant is an LP, in the full set of the returned Alerts there are also the ones regarding the liquidity change of the positions of the LSPs on whose behalf such LP is configured to perform liquidity management functions.\nThe response contains the list of all Alerts that match the criteria and is sorted by AlertDate. The response contains a maximum of 1000 Alerts\n", "parameters": [ { "name": "senderBic", "description": "sender Bic\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)\nIt must be an enabled, suspended or R-only Participant (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAlertsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "alertDateFrom": "2019-06-21T23:20:50.000001", "alertDateTo": "2024-11-08T14:29:00.012345", "alertCode": "150", "alertDescription": "USER for Insert Issued" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAlertsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "numAlerts": 1, "alertList": [ { "alertDate": "2019-06-21T23:20:50.000001", "description": "\"SCT Inst message received from has been rejected due to a wrong value received within Reject / Refusal Reason Code field\" (Alert 4).", "eventType": "ERROR" }, { "alertDate": "2024-11-08T14:29:00.012345", "description": "\"SCT Inst message received from has been rejected due to a wrong value received within Reject / Refusal Reason Code field\" (Alert 4).", "eventType": "FATAL" } ], "endOfList": "0", "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } }, "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" } } } }, "/interestAmounts/{senderBic}": { "post": { "tags": [ "Interest calculation" ], "operationId": "interestAmounts", "summary": "The Participant can inquiry interest calculation performed by the system for each day of the required month", "description": "The GetInterestAmount request returns the Interest Amount calculated by the System for each day of the required month. Retrieved data shall be sorted by date.\nA Liquidity Provider is allowed to perform inquiries on interests calculated for any of its LSP.\nAn Owner of a Liquidity Branch Funds Balance is allowed to perform inquiries on interests calculated for its Branch Funds Balance(s).\nThe Monthly interest information (with Daily Accrual Details) will be available for the selected month only after the Interest Calculation Process has run, otherwise no data will be provided for the month requested, and the following error XA19 will be returned to the API User: “The Interest Calculation has not been calculated for the requested month”.\n", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** Must be equal to the BIC of the Participants certificate (ErrorCode XA02)\nThe “End Validity Date” of the Sender BIC Participant must be greater than the first processing date of the previous month compared to Month/Year (ErrorCode PY01)\nIn case of Branch Funds Balance, the SenderBic must be the Owner (ErrorCode XA18)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterestAmountsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "criteria": { "bic": "IPSDID21", "month": 1, "year": 2024 } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterestAmountsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "bic": "IPSDID21", "interestList": [ { "date": "2019-06-21", "interestRate": 9.99, "snapshotTime": "16:00:00", "eodPosition": 2000.11, "dailyInterestAmount": 389.05 }, { "date": "2024-08-11", "interestRate": 2000.11, "snapshotTime": "00:00:01", "eodPosition": 389.05, "dailyInterestAmount": 9.99 } ] } } } } }, "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" } } } }, "/listThrottlingParameters/{senderBic}": { "post": { "tags": [ "List Throttling Parameters" ], "operationId": "listThrottlingParameters", "summary": "A Participant can inquiry the system about its parameters, for both outgoing and incoming traffic during daytime and nighttime", "description": "The List Throttling Parameters allow the Participant to get its parameters for both outgoing and incoming traffic during daytime and nighttime.\nThe response contains the throttling parameters defined for the Participant.", "parameters": [ { "name": "senderBic", "description": "The BIC of the Participant sending the API Request\n\n **Validation Rule(s)** Must be equal to the BIC of the Participants certificate (ErrorCode XA02)\nSending Participant must not have status “Disabled” or “Changed” (ErrorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic2" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListThrottlingParametersRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListThrottlingParametersResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "timeDetails": { "startTimeHighVolume": "16:00", "startTimeLowVolume": "00:00" }, "responseList": { "bic": "IPSDID21", "incThrottDayId": "ID01", "incThrottDay": 1, "incThrottNightId": "ID02", "incThrottNight": 2, "outThrottDayId": "ID03", "outThrottDay": 3, "outThrottNightId": "ID01", "outThrottNight": 1 } } } } } }, "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/ErrorResponse1" }, { "$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" } } } }, "/listCurrencies/{senderBic}": { "post": { "tags": [ "Command inquiry" ], "operationId": "listCurrencies", "summary": "A Participant can require the list of the Currencies", "description": "The List Currencies request allows Participant to retrieve a list of the currencies defined in the system", "parameters": [ { "name": "senderBic", "description": "The BIC of EBA CL sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC identified through its certificate (ErrorCode XA02)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBic1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCurrenciesRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCurrenciesResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "listCurrencies": [ { "currencyCode": "EUR", "currencyName": "Euro", "maxAmountAllowed": 3456, "currencyTimestamp": "2019-06-21T23:20:50.000001" }, { "currencyCode": "GBP", "currencyName": "Great British pound", "maxAmountAllowed": 1256, "currencyTimestamp": "2024-11-08T14:29:00.012345" } ] } } } } }, "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": { "AauList": { "type": "object", "properties": { "bicCode": { "description": "The BIC8 of the Participant that is configuring its aauRt1Asta.", "$ref": "#/components/schemas/Bic8" }, "aauRt1Asta": { "description": "BIC11 configured in TIPS as AAU RT1 ASTA for bicCode Participant", "$ref": "#/components/schemas/Bic11Only" }, "aauRt1AstaInitValidity": { "description": "The Init Validity date of the aauRt1Asta", "$ref": "#/components/schemas/Date" }, "aauRt1AstaEndValidity": { "description": "The End Validity date of the aauRt1Asta", "$ref": "#/components/schemas/Date" } }, "required": [ "bicCode", "aauRt1Asta", "aauRt1AstaInitValidity", "aauRt1AstaEndValidity" ] }, "AccCredDebIndic": { "type": "string", "maxLength": 4, "examples": [ "DEB" ] }, "Account": { "type": "string", "maxLength": 34, "examples": [ "IT60X0542811101000000123456" ] }, "ActionType": { "type": "string", "enum": [ "INS", "UPD", "RMV" ], "minLength": 3, "maxLength": 3, "examples": [ "INS" ] }, "ActiveOutNet": { "type": "integer", "enum": [ 1, 2 ], "examples": [ 1 ] }, "AddInfo": { "type": "string", "maxLength": 140, "examples": [ "Addinitional Information" ] }, "AdmissionProfile": { "type": "string", "maxLength": 3, "examples": [ "CAD" ] }, "AdmissionProfile1": { "type": "string", "enum": [ "CAD", "CRD" ], "maxLength": 3, "examples": [ "CAD" ] }, "AdmissionProfileList": { "type": "string", "maxLength": 80, "examples": [ "CAD-INSTCRD-EOLOCAD-IXPB" ] }, "AlertCode": { "type": "string", "maxLength": 3, "examples": [ "150" ] }, "AlertDescription": { "type": "string", "maxLength": 1000, "examples": [ "USER for Insert Issued" ] }, "AlertList": { "type": "object", "properties": { "description": { "description": "The description of the alert. (Mandatory if the section is present)", "$ref": "#/components/schemas/Description" }, "alertDate": { "description": "The date and time of creation of the alert by system (Mandatory if the section is present)", "$ref": "#/components/schemas/DateTime" }, "eventType": { "description": "The code of the alert. (Mandatory if the section is present) The possible values are:\n- NORMAL\n- ERROR\n- FATAL\n- WARNING\n- SECURITY", "$ref": "#/components/schemas/EventType" } }, "required": [ "alertDate", "description", "eventType" ] }, "Amount": { "description": "Standard Amount", "type": "number", "format": "double", "maximum": 999999999999.99, "examples": [ 9.99 ] }, "Amount1": { "description": "Standard Amount", "type": "number", "format": "double", "maximum": 1000000000000000, "examples": [ 9.99 ] }, "Amount2": { "description": "Standard Amount", "type": "number", "maximum": 999999999999.99, "examples": [ 9.99 ] }, "AmountRange": { "type": "object", "properties": { "amountRangeFrom": { "description": "The minimum value of the range of the amount\n\n **Validation Rule(s)** If present it must be lesser than AmountRangeTo (ErrorCode XA05)\nOnly decimal notation is allowed (XA05)", "$ref": "#/components/schemas/Amount" }, "amountRangeTo": { "description": "The maximum value of the range of the amount\n\n **Validation Rule(s)** If present it must be greater than AmountRangeFrom (ErrorCode XA05)\nOnly decimal notation is allowed (XA05)", "$ref": "#/components/schemas/Amount" } } }, "AmountRange1": { "type": "object", "properties": { "amountRangeFrom": { "description": "The minimum value of the range of the amount of the transaction\n\n **Validation Rule(s)** If present it must be lesser than AmountRangeTo (ErrorCode XA05)", "$ref": "#/components/schemas/Amount" }, "amountRangeTo": { "description": "The maximum value of the range of the amount of the transactions\n\n **Validation Rule(s)** If present it must be greater than AmountRangeFrom (ErrorCode XA05)", "$ref": "#/components/schemas/Amount" } } }, "Aos": { "type": "string", "enum": [ "A01", "A02", "A03", "A04", "A05" ], "examples": [ "A01" ] }, "AOSList": { "type": "string", "pattern": "[0-9A-Z]", "maxLength": 30, "examples": [ "A01" ] }, "ApDetail": { "type": "object", "properties": { "paramHistory": { "$ref": "#/components/schemas/ParamHistory" }, "details": { "description": "The following section is present only if the BIC in the APDetails has the DPBIC equal to the SenderBIC", "type": "array", "items": { "$ref": "#/components/schemas/Details" } } } }, "ApDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "apDetail": { "description": "The below fields are present only if Response code = 200. This section is repeated as many times as the rows of the Parameters Modification History related to the BIC are", "type": "array", "items": { "$ref": "#/components/schemas/ApDetail" } } }, "required": [ "dateTime" ] }, "ApList": { "type": "object", "properties": { "name": { "description": "It is the name of the AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Name" }, "bicAp": { "description": "The BIC of the listed AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Bic11" }, "dpBic": { "description": "The Participant BIC of the BICAP (Mandatory if the section is present)", "$ref": "#/components/schemas/Bic8" }, "submittedAOSinst": { "description": "The AOS associated to INST defaultProduct subscribed by the Participant.", "$ref": "#/components/schemas/AOSList" }, "submittedAOSeolo": { "description": "The AOS associated to EOLO defaultProduct subscribed by the Participant.", "$ref": "#/components/schemas/AOSList" }, "status": { "description": "The current status of the AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Status5" }, "initParticipantValidity": { "description": "The initial date of validity of the configured AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Date" }, "endParticipantValidity": { "description": "The end date of validity of the configured AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Date" }, "tipsUserBic": { "description": "BIC used for reachability in TIPS through a DCA account", "$ref": "#/components/schemas/Bic11Only" }, "newBic": { "description": "The new BIC of the Addressable PSP following a “Change BIC” operation.", "$ref": "#/components/schemas/Bic11Only" }, "newRole": { "description": "The new Role indicator :\n• “N” – no “Change Role” operation has been requested;\n• “Y” – the Participant has changed their Role.", "$ref": "#/components/schemas/NewRole1" }, "productList": { "description": "List of products", "type": "array", "items": { "$ref": "#/components/schemas/ProductList3" } } }, "required": [ "bicAp", "dpBic", "name", "status", "initParticipantValidity", "endParticipantValidity", "tipsUserBic", "productList" ] }, "ApOperationDetails": { "type": "object", "properties": { "name": { "description": "The nameof the AP", "$ref": "#/components/schemas/Name" }, "bicCode": { "description": "The Bic Code of the AP", "$ref": "#/components/schemas/Bic11" }, "participantBic": { "description": "The Bic of the Participant", "$ref": "#/components/schemas/Bic8" }, "participantName": { "description": "The name of the Participant", "$ref": "#/components/schemas/Name" }, "admissionProfile": { "description": "The admission profile (Mandatory if the section is present). Possible values are:\n“CAD” - for a Participant or Addressable PSP that acts as both Creditor and Debtor Bank\n“CRD” - for a Participant or Addressable PSP that only acts as a Creditor only Bank", "$ref": "#/components/schemas/AdmissionProfile1" }, "bbPositiveCnf": { "description": "It indicates if the Participant asked for confirmation of the credited payment amount", "$ref": "#/components/schemas/BbPositiveCnf1" }, "bbTimeoutMgm": { "description": "It indicates if the SCT Inst has to reject the transaction that are not confirmed or rejected within the timeout expiration time by the Participant, when acting as Beneficiary Bank", "$ref": "#/components/schemas/BbTimeoutMgm1" }, "ProductIds": { "description": "The identifier of the product.", "$ref": "#/components/schemas/ProductIds" }, "aosListInst": { "description": "The AOS associated to INST defaultProduct subscribed by the Participant.", "$ref": "#/components/schemas/AOSList" }, "aosListEolo": { "description": "The AOS associated to EOLO defaultProduct subscribed by the Participant.", "$ref": "#/components/schemas/AOSList" }, "tipsUserBic": { "description": "BIC used for reachability in TIPS through a DCA account", "$ref": "#/components/schemas/TipsUserBic" }, "endValidityDate": { "description": "The end validity date assigned by the system in case of “R-Only” operations for AP", "$ref": "#/components/schemas/Date" }, "currentPBICCode": { "description": "The Participant under which the APSP is configured at the time of the operation.\nThe field will be available only in case of ACP operation.", "$ref": "#/components/schemas/CurrentPBICCode" }, "requesterPBICCode": { "description": "The Participant under which the APSP will be configured with the “APSP Change P” operation.\nThe field will be available only in case of ACP operation.", "$ref": "#/components/schemas/RequesterPBICCode" } }, "required": [ "bicCode", "name", "participantBic", "participantName", "admissionProfile", "bbPositiveCnf", "bbTimeoutMgm", "ProductIds", "aosListInst", "aosListEolo", "tipsUserBic" ] }, "ApspsUnavailability": { "type": "string", "enum": [ "0", "1" ], "maxLength": 1, "examples": [ "0" ] }, "Authorizer": { "type": "string", "maxLength": 8, "examples": [ "CO0A222" ] }, "AutomaticLiquidityAdjus": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "BbPositiveCnf": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "BbPositiveCnf1": { "type": "string", "enum": [ "0", "1" ], "maxLength": 1, "examples": [ "0" ] }, "BbTimeoutMgm": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "BbTimeoutMgm1": { "type": "string", "enum": [ "0", "1" ], "maxLength": 1, "examples": [ "0" ] }, "BbTimeoutMngm": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "BeneficiaryAccount": { "type": "string", "maxLength": 34, "examples": [ "IT60X0542811101000000123456" ] }, "BeneficiaryBankPosPaymConf": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "BeneficiaryBankTimeoutManag": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "BeneficiaryManagementRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria8" } }, "required": [ "dateTime", "criteria" ] }, "BeneficiaryManagementResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "referenceId": { "description": "The univocal reference per SenderBic and date assigned by the system to the request.", "$ref": "#/components/schemas/ReferenceId" } }, "required": [ "dateTime", "referenceId" ] }, "BeneficiaryName": { "type": "string", "maxLength": 50, "examples": [ "Paolo Rossi, R. Verdi" ] }, "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": [ "IPSDID21XXX" ] }, "Bic11Only": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3})", "minLength": 11, "maxLength": 11, "examples": [ "IPSDID21XXX" ] }, "Bic8": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}", "minLength": 8, "maxLength": 8, "examples": [ "IPSDID21" ] }, "BicAp": { "description": "Ap Bic", "type": "string", "examples": [ "IPSDID21XXX" ] }, "BicExceptionDayValues": { "type": "object", "properties": { "lac": { "description": "The LAC of the BusinessDate contained in the request (Mandatory if this section is present)", "$ref": "#/components/schemas/LacNumber" }, "base": { "description": "The base value amount set in the system for the LSPBic, the BusinessDate and LAC (Mandatory if this section is present)", "$ref": "#/components/schemas/LacAmount" }, "lower": { "description": "The minimum value amount set in the system for the LSPBic, the BusinessDate and LAC (Mandatory if this section is present)", "$ref": "#/components/schemas/LacAmount" }, "upper": { "description": "The maximum value amount set in the system for the LSPBic, the BusinessDate and LAC (Mandatory if this section is present)", "$ref": "#/components/schemas/LacAmount" }, "resetToBasePosition": { "description": "Whether the “Reset to Base Position” flag for the relevant LAC is checked/unchecked. The field is present only when set to 1=YES", "$ref": "#/components/schemas/ResetToBasePosition" }, "sendAccountQueryToTips": { "description": "Whether the “Send Account Query to TIPS” flag for the relevant LAC is checked/unchecked.\nThe field is present only when set to: 1=YES", "$ref": "#/components/schemas/SendAccountQueryToTips" } }, "required": [ "lac", "base", "lower", "upper" ] }, "BoolValue": { "type": "string", "enum": [ "0", "1" ] }, "BranchFundsBalanceId": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{5,5}[0-9]{2,2}", "minLength": 13, "maxLength": 13, "examples": [ "IPSDID2100001" ] }, "BranchFundsBalancePosition": { "type": "object", "properties": { "branchFundsBalanceId": { "description": "If present, the branchFundsBalanceId of the Liquidity Branch Funds Balance the SenderBic is a member of", "$ref": "#/components/schemas/BranchFundsBalanceId" }, "amount": { "description": "If present, the liquidity of the Branch Funds Balance to which the SenderBic of the request belongs", "$ref": "#/components/schemas/Amount" } }, "required": [ "branchFundsBalanceId", "amount" ] }, "BusinessError": { "type": "string", "maxLength": 35, "examples": [ "SC01" ] }, "ChangeStatusAPRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria13" } }, "required": [ "dateTime", "criteria" ] }, "ChangeStatusAPResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "referenceId": { "description": "The univocal reference per SenderBic and date assigned by the system to the request.", "$ref": "#/components/schemas/ReferenceId" } } }, "CmbLimitAmt": { "type": "number", "format": "double", "maximum": 1000000000000000, "examples": [ 10 ] }, "CmbStatus": { "type": "string", "maxLength": 4, "examples": [ "NTF" ] }, "CommandDeleteResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "commandItem": { "$ref": "#/components/schemas/CommandItem1" } }, "required": [ "dateTime" ] }, "CommandItem": { "type": "object", "properties": { "submissionDate": { "description": "The date of the submission of the request", "$ref": "#/components/schemas/DateTime" }, "referenceId": { "description": "The ReferenceId of the request", "$ref": "#/components/schemas/ReferenceId1" }, "requestStatus": { "description": "The status of the submitted request", "$ref": "#/components/schemas/RequestStatus2" }, "commandType": { "description": "The type of the command", "$ref": "#/components/schemas/CommandType1" }, "requestor": { "description": "The requestor of the original submitted request", "$ref": "#/components/schemas/Requestor" }, "authorizer": { "description": "The authorizer of the event", "$ref": "#/components/schemas/Authorizer" }, "authorizationDate": { "description": "The date of authorization or rejection of the command", "$ref": "#/components/schemas/Date" } }, "required": [ "submissionDate", "referenceId", "requestStatus", "commandType" ] }, "CommandItem1": { "type": "object", "properties": { "submissionDate": { "description": "The date of the submission of the request", "$ref": "#/components/schemas/DateTime" }, "referenceId": { "description": "The ReferenceId of the request", "$ref": "#/components/schemas/ReferenceId2" }, "requestStatus": { "description": "The status of the submitted request, it can contain only\n- “ATH” = Authorised if the deletion was accepted and the command was deleted\n- “RJT” Rejected by the system if the deletion failed and the command was not deleted", "$ref": "#/components/schemas/RequestStatus2" }, "commandType": { "description": "The type of the command", "$ref": "#/components/schemas/CommandType1" }, "requestor": { "description": "The requestor of the original submitted request", "$ref": "#/components/schemas/Requestor" }, "authorizer": { "description": "The authorizer of the event.\nIf the deletion is rejected because the command has been already authorized = the authorizer that already authorized the command.\nIf the deletion is accepted = the authorizer of the deletion request.\nIf the deletion is rejected for any other reason (but the command has not been already authorized), this field is empty.", "$ref": "#/components/schemas/Authorizer" }, "authorizationDate": { "description": "The date of authorization of the command", "$ref": "#/components/schemas/Date" } }, "required": [ "submissionDate", "referenceId", "requestStatus", "commandType" ] }, "CommandList": { "type": "object", "properties": { "submissionDate": { "description": "The date of the submission of the request (Mandatory if the section is present)", "$ref": "#/components/schemas/DateTime" }, "referenceId": { "description": "The ReferenceId of the request (Mandatory if the section is present)", "$ref": "#/components/schemas/ReferenceId" }, "requestStatus": { "description": "The status of the submitted request (Mandatory if the section is present)", "$ref": "#/components/schemas/RequestStatus2" }, "commandType": { "description": "The type of the command (Mandatory if the section is present)", "$ref": "#/components/schemas/CommandType" }, "requestor": { "description": "The requestor of the original submitted request", "$ref": "#/components/schemas/Requestor1" }, "authorizer": { "description": "The authorizer of the change request", "$ref": "#/components/schemas/Authorizer" }, "authorizationDate": { "description": "The date of the authorization or rejection of the request", "$ref": "#/components/schemas/Date" } }, "required": [ "submissionDate", "referenceId", "requestStatus", "commandType" ] }, "CommandStatusDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "commandItem": { "$ref": "#/components/schemas/CommandItem" } }, "required": [ "dateTime" ] }, "CommandType": { "type": "string", "enum": [ "INS", "RMV", "UPD", "ROF", "RAL", "GBA", "BMI", "BMA", "BMR", "RRE", "CDN", "PSQ", "GOL", "LAG", "LCA", "RLI", "PFL", "LTR", "ALL" ], "maxLength": 3, "examples": [ "INS" ] }, "CommandType1": { "type": "string", "maxLength": 3, "examples": [ "INS" ] }, "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/Criteria15" } }, "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": [ "0", "1" ], "examples": [ "0" ] }, "Compression1": { "type": "string", "enum": [ "0", "1" ], "maxLength": 1, "examples": [ "0" ] }, "Confirmer": { "type": "string", "maxLength": 8, "examples": [ "ID403821" ] }, "CreditDebitIndicator": { "type": "string", "enum": [ "CRDT", "DBIT" ], "examples": [ "CRDT" ] }, "CreditorSettlementMethod": { "type": "string", "enum": [ "LQPS", "RT1A", "TDCS" ], "maxLength": 4, "examples": [ "LQPS" ] }, "CredSettMethod": { "type": "string", "enum": [ "LQPS", "RT1A", "TDCA" ], "examples": [ "LQPS" ] }, "CredSettMethod1": { "type": "string", "enum": [ "LQPS", "RT1A", "TDCA" ], "maxLength": 4, "examples": [ "LQPS" ] }, "Criteria": { "type": "object", "properties": { "lspBic": { "description": "The BIC of an LSP of the SenderBic. It can be present in addition to the MemberBic.\n\n **Validation Rule(s)** If the LSPBic is not associated with an LSP whose liquidity management is configured to be performed by a Liquidity Provider on its behalf and/or the SenderBic is not corresponding to such LP, the request is rejected (ErrorCode XA14)", "$ref": "#/components/schemas/Bic8" }, "memberBic": { "description": "The BIC of the Member for which it is requested the set of default values. If not present the default values of the SenderBic are returned.\n\n **Validation Rule(s)** Mandatory if the branchFundsBalanceId is present (ErrorCode XA04)\nThe MemberBic must belong to the specified branchFundsBalanceId (ErrorCode XA06)", "$ref": "#/components/schemas/Bic8" }, "branchFundsBalanceId": { "description": "The id of the branchFundsBalance to which the MemberBic belongs.\n\n **Validation Rule(s)** Mandatory if the MemberBic is present (ErrorCode XA04 )", "$ref": "#/components/schemas/BranchFundsBalanceId" } } }, "Criteria1": { "type": "object", "properties": { "lspBic": { "description": "The BIC of an LSP of the SenderBic. It can be present in addition to the MemberBIC.\n\n **Validation Rule(s)** The LSPBic liquidity must be managed by its LP, and its LP must be equal to the SenderBic (ErrorCode XA14)", "$ref": "#/components/schemas/Bic8" }, "businessDate": { "description": "The day of the year to which the values are requested\n\n **Validation Rule(s)** The date must be the present date or a future date no further than one year from the current date (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "memberBic": { "description": "The BIC of the Member for which it is requested the set of default values\n\n **Validation Rule(s)** Mandatory if the branchFundsBalanceId is present (ErrorCode XA04)\nThe MemberBic must belong to the specified branchFundsBalanceId (ErrorCode XA06)", "$ref": "#/components/schemas/Bic8" }, "branchFundsBalanceId": { "description": "The id of the branchFundsBalance to which the Participant identified by the MemberBic belongs.\n\n **Validation Rule(s)** Mandatory if MemberBic is present (ErrorCode XA04)", "$ref": "#/components/schemas/BranchFundsBalanceId" } }, "required": [ "businessDate" ] }, "Criteria10": { "type": "object", "properties": { "name": { "description": "It is the name of the DP", "$ref": "#/components/schemas/Name" }, "automaticLiquidityAdjustment": { "description": "It indicates whether it is required or not to have automatic liquidity adjustments at the end of each LAC.\n\n **Validation Rule(s)** Allowed values:\n- 0:Automatic Adjustment not activated\n- 1: Automatic Adjustment activated\n(schema validation).", "$ref": "#/components/schemas/LiquidityAutomaticAdjustment" }, "intraLACAuthAdjst": { "description": "It indicates whether it is required or not to have intraLAC automatic liquidity adjustments\n\n **Validation Rule(s)** Allowed values:\n0: Intra-LAC Automatic\n Adjustment not activated\n1: Intra-LAC Automatic\n Adjustment activated\nParameter can be set to “1” only if parameter “automaticLiquidity Adjustment” is set to “1”, otherwise XA17", "$ref": "#/components/schemas/LiquidityAutomaticAdjustment" }, "liquidityManagement": { "description": "The liquidity management of the SenderBic\n\n **Validation Rule(s)** • It can contain “0” or “1” (schema validation)\n• If the SenderBic is an LP it must be “0” (“By Participant itself”) (ErrorCode XA13)\nIf it contains “1” (“By LP on behalf”) the LP of the SenderBic must be configured as an “enabled” Participant at the EffectiveDate contained in the request (ErrorCode XA16)", "$ref": "#/components/schemas/LiquidityManagement" }, "tipsAdherence": { "description": "It indicates if the Participant is allowed to settle transactions in TIPS through its TIPS DAC account.\n\n **Validation Rule(s)** It can assume the values:\n- “1” = YES\n- “0” = NO\n(schema validation)", "$ref": "#/components/schemas/TipsAdherence" }, "technicalBic": { "description": "It indicates if the BIC is a technical one (1) or not (0)\n\n **Validation Rule(s)** It can contain 0 or 1 (schema validation)", "$ref": "#/components/schemas/TechnicalBic1" }, "tipsUserBic": { "description": "BIC used for reachability in TIPS through a DCA account", "$ref": "#/components/schemas/Bic11Only" }, "bbTimeoutMgm": { "description": "Whether the SCT Inst has to reject the transaction that are not confirmed or re-jected within the timeout expiration time by the Participant, when acting as Beneficiary PSP", "$ref": "#/components/schemas/BbTimeoutMgm" }, "tipsDcaAccountId": { "description": "TIPS Account number", "$ref": "#/components/schemas/TipsDcaAccountId" }, "tipsAccountOwnerBic": { "description": "The BIC(11) by which the Direct participant will be known to the ESM for settlement purpose", "$ref": "#/components/schemas/Bic11Only" }, "bbPositiveCnf": { "description": "It indicates if the Participant requires to receive the opftional positive confirmation\n\n **Validation Rule(s)** It can contain 0 (not required) or 1 (required) - (schema validation)", "$ref": "#/components/schemas/BbPositiveCnf" }, "psrReq": { "description": "It indicates if the Participant asked for receive PSR\n\n **Validation Rule(s)** It can contain 0 (not required) or 1 (required) - (schema validation)", "$ref": "#/components/schemas/PsrReq" }, "rsfReq": { "description": "It indicates if the Participant asked for receive RSF\n\n **Validation Rule(s)** It can contain 0 (not required) or 1 (required) - (schema validation)", "$ref": "#/components/schemas/RsfReq" }, "drrReq": { "description": "It indicates if the Participant asked for receive DRR\n\n **Validation Rule(s)** It can contain 0 (not required) or 1 (required) - (schema validation)", "$ref": "#/components/schemas/DrrReq" }, "msrReq": { "description": "It indicates if the Participant asked for receive MSR\n\n **Validation Rule(s)** It can contain 0 (not required) or 1 (required) - (schema validation)", "$ref": "#/components/schemas/MsrReq" }, "maxFileSize": { "description": "The maximum size of a file that is sent by the CS to the DP\n\n **Validation Rule(s)** The value must be in the range included between the default values set in the system for the Minimum file size and the Maximum file size.\n(ErrorCode XA15)", "$ref": "#/components/schemas/MaxFileSize" }, "compression": { "description": "It indicates if the Participant asked for the compression of the files received\n\n **Validation Rule(s)** It can contain 0 (not required) or 1 (required). Schema validation.\nIf the field is set to “1” and the Network set is not SWIFT: error code XA07.", "$ref": "#/components/schemas/Compression" }, "tipsNetworkOption": { "description": "It indicates the network identification for the Participant\n\n **Validation Rule(s)** It can contain:\n- “EAS” for SIANet ,\n- “SWI” for Swift Real Time\n(ErrorCode XA03)", "$ref": "#/components/schemas/TipsNetworkOption1" }, "transactionalPrimaryNetId": { "description": "The primary network identification\nCan be the same provider of Secondary Network\n\n **Validation Rule(s)** It can contain:\n- “EAS” for SIANet ,\n- “EBX” for EBICS,\n- “SWI” for Swift Real Time\n(any other available Network will be added) (ErrorCode XA03)", "$ref": "#/components/schemas/TransactionalPrimaryNetId" }, "transactionalSecondaryNetId": { "description": "The secondary network identification\nCan be the same provider of Primary Network\n\n **Validation Rule(s)** It can contain:\n- “EAS” for SIANet ,\n- “EBX” for EBICS.\n- “SWI” for Swift Real Time\nIf present, it must be different from TransactionalPrimaryNetId\n(any other available Network will be added) (ErrorCode XA03)\nIf the secondary network was not already present in the Participant configuration, the system checks the presence of the tags SecondaryRecNetId and SecondarySendNetId for each Product subscribed by the Participant\n(ErrorCode XA04)", "$ref": "#/components/schemas/TransactionalSecondaryNetId" }, "filePrimaryNetId": { "description": "The primary network identification\nCan be the same provider of Secondary Network\n\n **Validation Rule(s)** It can contain:\n- “EAS” for SIANet\n- “EBX” for EBICS\n- “SWF” Swiftnet RT Single Request Type\n-“SWA Swiftnet RT Multiple Request Type\n-“SWS” Swiftnet S&F Single Request Type\n-“SWM” Swiftnet S&F Multiple Request Type (ErrorCode XA03)", "$ref": "#/components/schemas/FilePrimaryNetId" }, "fileSecondaryNetId": { "description": "The secondary network identification\nCan be the same provider of Primary Network\n\n **Validation Rule(s)** It can contain:\n- “EAS” for SIANet\n- “EBX” for EBICS\n- “SWF” Swiftnet RT Single Request Type\n-“SWA Swiftnet RT Multiple Request Type\n-“SWS” Swiftnet S&F Single Request Type\n-“SWM” Swiftnet S&F Multiple Request Type (ErrorCode XA03)", "$ref": "#/components/schemas/FileSecondaryNetId" }, "submittedAOSinst": { "description": "The AOS associated to INST defaultProduct subscribed by the Participant: the content of this field will replace the AOS saved in the system master data\n\n **Validation Rule(s)** It can contain only a set of strings accepted by the system.\nThe system will check that all AOS selected are allowed to be associated with Products subscribed\n(ErrorCode XA03)", "$ref": "#/components/schemas/AOSList" }, "submittedAOSeolo": { "description": "The AOS associated to EOLO defaultProduct subscribed by the Participant: the content of this field will replace the AOS saved in the system master data\n\n **Validation Rule(s)** It can contain only a set of strings accepted by the system.\nThe system will check that all AOS selected are allowed to be associated with Products subscribed\n(ErrorCode XA03)", "$ref": "#/components/schemas/AOSList" }, "primaryFileIntRecNetId": { "description": "The primary receiving network address for the File Interface from SCT Inst\nCan be the same provider of Secondary Network", "$ref": "#/components/schemas/PrimaryFileIntRecNetId" }, "secondaryFileIntRecNetId": { "description": "The secondary receiving network address for the File Interface from SCT Inst\nCan be the same provider of Primary Network", "$ref": "#/components/schemas/SecondaryFileIntRecNetId" }, "effectiveDate": { "description": "It indicates the future starting date for the planned changes\n\n **Validation Rule(s)** For Critical parameter:\n• if onMonday W1 the first effective date will be Tuesday W3\n• if between Tuesday and Sunday W1 the first effective date will be the Tuesday W4\nFor Not Critical parameter:\n• the effective date must be grater than the current business date, , with respect to the End Validity Date configured for the Participant.\n(ErrorCode DT01)\nAnother configuration with the same effective date is already existing (errorCode XA22)", "$ref": "#/components/schemas/Date" }, "productList": { "description": " **Validation Rule(s)** The following section can be present or not. If the Participant fills it, it must be repeated as many times as the products to be changed: inserted, updated or removed.\nThis section must be formatted with squared brackets.\nAt least one of the optional field below has to be present", "type": "array", "items": { "$ref": "#/components/schemas/ProductList2" } } }, "required": [ "effectiveDate" ] }, "Criteria11": { "type": "object", "properties": { "bicAp": { "description": "The BIC of the searched AP", "$ref": "#/components/schemas/Bic11Only" }, "dpBic": { "description": "The Participant BIC of the BICAP", "$ref": "#/components/schemas/Bic8" }, "aos": { "description": "One of the AOS subscribed by the AP\n\n **Validation Rule(s)** It can contain only a string like “A” followed by a number from 01 to 10 , according to the number of AOS defined in the system (ErrorCode XA03)", "$ref": "#/components/schemas/Aos" }, "status": { "description": "The current status of the AP\n\n **Validation Rule(s)** Must be one of the available status in the system (ErrorCode XA03). The possible values are:\n- “ALL” All statuses\n- “ENB” Enabled\n- “SUS” Suspended\n- “DIS” Disabled\n- “CNG” Changed\n- “INS” Inserted\n- “RNL” R-Only", "$ref": "#/components/schemas/Status5" }, "productId": { "description": "Field used to filter APSP for configured defaultProduct\n\n **Validation Rule(s)** Product must be a defaultProduct defined in the system (ErrorCode XA03)\nThe SenderBIC must be configured for the chosen product.\n(ErrorCode XA13)", "$ref": "#/components/schemas/ProductId1" } } }, "Criteria12": { "type": "object", "properties": { "name": { "description": "It is the name of the AP", "$ref": "#/components/schemas/Name" }, "bbPositiveCnf": { "description": "Whether the AP, when acting as Beneficiary PSP, is configured to receive a final con-firmation from SCT Inst stating the final status of the IP transaction\n\n **Validation Rule(s)** It can contain 0 (not required) or 1 (required) - (schema validation)", "$ref": "#/components/schemas/BeneficiaryBankPosPaymConf" }, "bbTimeoutMgm": { "description": "Whether the SCT Inst has to reject the transaction that are not confirmed or re-jected within the timeout expiration time by the Participant, when acting as Beneficiary PSP\n\n **Validation Rule(s)** It can contain 0 (not required) or 1 (required) - (schema validation)", "$ref": "#/components/schemas/BeneficiaryBankTimeoutManag" }, "bicAp": { "description": "The BIC of the inquired AP", "$ref": "#/components/schemas/Bic11Only" }, "submittedAOSinst": { "description": "The AOS associated to INST defaultProduct subscribed by the AP: the content of this field will replace the AOS saved in the system master data\n\n **Validation Rule(s)** It can contain only a set of strings accepted by the system.\nThe system will check that all AOS selected are allowed to be associated with Products subscribed\n(ErrorCode XA03)", "$ref": "#/components/schemas/AOSList" }, "submittedAOSeolo": { "description": "The AOS associated to EOLO defaultProduct subscribed by the AP: the content of this field will replace the AOS saved in the system master data\n\n **Validation Rule(s)** It can contain only a set of strings accepted by the system.\nThe system will check that all AOS selected are allowed to be associated with Products subscribed\n(ErrorCode XA03)", "$ref": "#/components/schemas/AOSList" }, "tipsUserBic": { "description": "BIC used for reachability in TIPS through a DCA account", "$ref": "#/components/schemas/Bic11Only" }, "effectiveDate": { "description": "It indicates the future starting date for the planned changes\n\n **Validation Rule(s)** A date >= P Initial Validity Date between tomorrow and the EndValidityDate of the Participant (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "productList": { "description": "List of products", "type": "array", "items": { "$ref": "#/components/schemas/ProductList5" } } }, "required": [ "bicAp", "effectiveDate" ] }, "Criteria13": { "type": "object", "properties": { "bicAp": { "description": "The BIC of the AP", "$ref": "#/components/schemas/Bic11Only" }, "newStatus": { "description": "The new status of the AP that can be Disabled or R-only\n\n **Validation Rule(s)** It can contain only:\n- “DIS” if the AP has “RNL” status and is going to become Disabled\n- “RNL” if the AP has “ENB” (enabled) status and is going to become R-only.\n(Error Code PY01)", "$ref": "#/components/schemas/NewStatus" }, "effectiveDate": { "description": "It indicates the future starting date for the planned changes\n\n **Validation Rule(s)** For Critical parameter:\n• if on Monday W1 the first effective date will be Tuesday W3\n• if between Tuesday and Sunday W1 the first effective date will be Tuesday of the W4\n(ErrorCode DT01)\n• it must be greater than Current Date + 2 calendar days\n(ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "effectiveEndValidityDate": { "description": "Calendar date starting from this date the APSP will be in DISABLED status.\nThe removal can be performed on a non-target day\n\n **Validation Rule(s)** Valid in case of R-Only status\nIt must be:\n• >= effectiveDate\n• <= effectiveDate + “Max R-Only Period”\n• mandatory\n(ErrorCode DT01)", "$ref": "#/components/schemas/Date" } }, "required": [ "bicAp", "newStatus", "effectiveDate" ] }, "Criteria14": { "type": "object", "properties": { "name": { "description": "It is the name of the AP", "$ref": "#/components/schemas/Name" }, "bicAp": { "description": "The BIC of the new AP\n\n **Validation Rule(s)** If already present in the system it must have ‘disabled’ status with respect to the InitValidityDate(ErrorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "submittedAOSinst": { "description": "The AOS associated to INST defaultProduct subscribed by the AP.\n\n **Validation Rule(s)** It can contain only a set of strings accepted by the system.\nThe system will check that all AOS selected are allowed to be associated with Products subscribed\n(ErrorCode XA03)", "$ref": "#/components/schemas/AOSList" }, "submittedAOSeolo": { "description": "The AOS associated to EOLO defaultProduct subscribed by the AP.\n\n **Validation Rule(s)** It can contain only a set of strings accepted by the system.\nThe system will check that all AOS selected are allowed to be associated with Products subscribed\n(ErrorCode XA03)", "$ref": "#/components/schemas/AOSList" }, "bbPositiveCnf": { "description": "It indicates if the AP asked for confirmation of the credited payment amount (Mandatory if the section is present)\n\n **Validation Rule(s)** It can contain 0 (not required) or 1 (required) - (schema validation)", "$ref": "#/components/schemas/BbPositiveCnf" }, "bbTimeoutMgm": { "description": "Whether the SCT Inst has to reject the transaction that are not confirmed or re-jected within the timeout expiration time by the Participant, when acting as Beneficiary PSP\n\n **Validation Rule(s)** It can contain 0 (not required) or 1 (required) - (schema validation)", "$ref": "#/components/schemas/BbTimeoutMngm" }, "tipsUserBic": { "description": "BIC used for reachability in TIPS through a DCA account\n\n **Validation Rule(s)** Two different Participant or APSP cannot have same TIPS User BIC (ErrorCode XA13)", "$ref": "#/components/schemas/Bic11Only" }, "initParticipantValidity": { "description": "The init date of validity of the AP\n\n **Validation Rule(s)** It must be a future date (ErrorCode DT01) and:\no :if on Monday W1 the first effective date will be Tuesday W3\no if between Tuesday and Sunday W1 the first effective date will be Tuesday W4\no must be >= P Initial Validity Date", "$ref": "#/components/schemas/Date" }, "endParticipantValidity": { "description": "The end date of validity of the AP\n\n **Validation Rule(s)** It must be equal to the fixed value ‘9999-12-31’ (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "productList": { "description": "List of products", "type": "array", "items": { "$ref": "#/components/schemas/ProductList6" } } }, "required": [ "bicAp", "name", "tipsUserBic", "initParticipantValidity", "endParticipantValidity", "productList" ] }, "Criteria15": { "type": "object", "properties": { "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)** Field used for duplicate checking (error code AM05)", "$ref": "#/components/schemas/EventCode" }, "unavailableBic": { "description": "BIC of the Participant or APSP 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 APSP of the SenderBic. (ErrorCode XA06).\nField used for duplicate checking (error code AM05)", "$ref": "#/components/schemas/Bic11" }, "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/MessageId2" }, "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" }, "productsUnavailable": { "description": "List of Product(s) impacted by the unavailability\nIf all products are unavailable, the list must include all configured products for the unavailableBic\n\n **Validation Rule(s)** XT33: at least one of the products configured in the system for the unavailableBic must be indicated.", "$ref": "#/components/schemas/ProductsUnavailable" }, "apspsUnavailability": { "description": "This flag allow Participant to communicate the unavailability for itself and for all its APSPs\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 APSP(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/ApspsUnavailability" }, "idOfUnavailableParty": { "description": "ID of Unavailable Party as a free text", "$ref": "#/components/schemas/IdOfUnavailableParty" } }, "required": [ "eventCode", "unavailableBic", "messageId", "startDateTime", "endDateTime", "productsUnavailable" ] }, "Criteria16": { "type": "object", "properties": { "unavailableBic": { "description": "BIC of the Participant or APSP 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, suspended or r-only in the CS repository on the current calendar date (ErrorCode PY01).\n- An APSP BIC that is enabled, suspended or r-only in the CS repository on the current calendar date (ErrorCode PY01).\nThe list shall be ordered in alphabetic order.", "$ref": "#/components/schemas/Bic11" }, "fromTIPS": { "description": "To be chosen if user wants to search between admi.004 from TIPS\n\n **Validation Rule(s)** In choice with unavailableBIC, it can’t be that both parameter are included into the API:\nWhen “fromTIPS” is set to “1” research will be performed only between CS admi.004 received from TIPS and “BIC code” is not considered.\nWhen “fromTIPS” is set to “0” the “unavailableBic” can be leave empty or set to a specific “BIC code” and research will be performed both CS admi.004 (triggered by an admi.004 received from TIPS) and admi.004 received from RT1 Participants.", "$ref": "#/components/schemas/ApspsUnavailability" } } }, "Criteria17": { "type": "object", "properties": { "operationType": { "description": "Type of the operation\n\n **Validation Rule(s)** Values allowed:\n“INS” Inserted\n“REM” Removed\n“UPD” Updated\n“MIN” Massive Insert\n“RNL” R-only\n\"MOD\" Amend\n\"REV\" Revoke\n“ACP” APSP Change P\n(schema validation)", "$ref": "#/components/schemas/OperationType1" }, "referenceId": { "description": "Unique reference ID of the operation", "$ref": "#/components/schemas/ReferenceId" }, "critical": { "description": "This flag indicates if the operation is critical or not-critical", "$ref": "#/components/schemas/Critical" }, "status": { "description": "The current status of the operations.\n\n **Validation Rule(s)** Values allowed:\nWTG: waiting;\nSUB: submitted;\nATH: authorized;\nRJT rejected\nEXE: executed.\n(schema validation)", "$ref": "#/components/schemas/Status7" }, "requestor": { "description": "The user who submitted the operation", "$ref": "#/components/schemas/Requestor" }, "dateOfRequestFrom": { "description": "The minimum value of the range of the date\n\n **Validation Rule(s)** If present it must be lesser than dateOfRequestTo (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "dateOfRequestTo": { "description": "The maximum value of the range of the date\n\n **Validation Rule(s)** If present it must be greater than dateOfRequestTo (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "confirmer": { "description": "The user Id of the user who confirmed the operation.\n\n **Validation Rule(s)** Applicable only in case of “Critical” operation, otherwise XA07", "$ref": "#/components/schemas/Confirmer" }, "dateOfConfirmFrom": { "description": "The date of the confirmation by Participant User. (The minimum value of the range of the date)\n\n **Validation Rule(s)** Applicable only in case of “Critical” operation\nIf present it must be lesser than dateOfConfirmTo (ErrorCode DT01)", "$ref": "#/components/schemas/DateOfConfirmFrom" }, "dateOfConfirmTo": { "description": "The date of the confirmation by Participant User. (The maximum value of the range of the date)\n\n **Validation Rule(s)** Applicable only in case of “Critical” operation\nIf present it must be greater than dateOfConfirmFrom (ErrorCode DT01)", "$ref": "#/components/schemas/DateOfConfirmTo" }, "authorizer": { "description": "The user who authorized/rejected the operation", "$ref": "#/components/schemas/Authorizer" }, "dateOfExecutionFrom": { "description": "The minimum value of the range of the date\n\n **Validation Rule(s)** If present it must be lesser than dateOfRequestTo (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "dateOfExecutionTo": { "description": "The maximum value of the range of the date\n\n **Validation Rule(s)** If present it must be greater than dateOfRequestTo (ErrorCode DT01)", "$ref": "#/components/schemas/Date" } } }, "Criteria18": { "type": "object", "properties": { "eventCode": { "description": "Type of operation requested:\n• \"INS\" for the insertion of a new aauRt1Asta related to the bicCode\n• \"UPD\" for updating of aauRt1Asta related to the bicCode\n\n **Validation Rule(s)** Possible values allowed are:\n• “INS” = insert\n• “UPD” = update\nThe value must be one of the possible values allowed (ErrorCode XA03)", "$ref": "#/components/schemas/EventCode1" }, "bicCode": { "description": "The BIC8 of the Participant that is configuring its aauRt1Asta.\n\n **Validation Rule(s)** Must be the same of the senderBic (ErrorCode XA02)", "$ref": "#/components/schemas/Bic8" }, "aauRt1Asta": { "description": "BIC11 configured by EBACL in TIPS as AAU RT1 ASTA.\n\n **Validation Rule(s)** Shall be a correct BIC11 format and It must be unique within the AAUs already entered in the system whose end validity date has not yet expired ErrorCode XA13 (Value not allowed) in case of matching BIC/AAU RT1 ASTA", "$ref": "#/components/schemas/Bic11Only" }, "aauRt1AstaInitValidity": { "description": "The Init Validity date of the aauRt1Asta with ISO date format:\n• YYYY-MM-DD.\nthe first available Initial Validity must be set as follows:\n• If the “insert” is issued on Monday Week-1, the first available date will be Tuesday Week3\n• If the “insert” is issued between Tuesday and Sunday Week1, the first available date will be Tuesday Week4\n\n **Validation Rule(s)** It must be a future date and less than aauRt1AstaEndValidity (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "aauRt1AstaEndValidity": { "description": "The End Validity date of the aauRt1Asta with ISO data format:\n• YYYY-MM-DD.\n\n **Validation Rule(s)** It must be a future date and greater than aauRt1AstaInitValidity (ErrorCode DT01)", "$ref": "#/components/schemas/Date" } }, "required": [ "eventCode", "bicCode", "aauRt1Asta", "aauRt1AstaInitValidity", "aauRt1AstaEndValidity" ] }, "Criteria19": { "type": "object", "properties": { "bicCode": { "description": "The BIC8 of the Participant that is configuring its aauRt1Asta.\n\n **Validation Rule(s)** Must be the same of the senderBic (ErrorCode XA02)", "$ref": "#/components/schemas/Bic8" }, "aauRt1Asta": { "description": "BIC11 configured by EBACL in TIPS as AAU RT1 ASTA.\n\n **Validation Rule(s)** Shall be a correct BIC11 format and It must be unique within the AAUs already entered in the system whose end validity date has not yet expired ErrorCode XA13 (Value not allowed) in case of matching BIC/AAU RT1 ASTA", "$ref": "#/components/schemas/Bic11Only" } }, "required": [ "bicCode", "aauRt1Asta" ] }, "Criteria2": { "type": "object", "properties": { "type": { "description": "It indicates the type of instruction that is requested\n\n **Validation Rule(s)** It must be one of the configured values in the system. The possible values are:\n• Checkpoint Funding Request (CPFR)\n• Adjustment Funding Request (APFR)\n• LAC Funding notification (CPFN)\n• Checkpoint Liquidity Release Request (CLRR)\n• Adjustment Liquidity Release (ALRR)\n• Emergency Liquidity Request Release (ELRR)\n• Emergency Funding (EPFN)\n (ErrorCode XA03)", "$ref": "#/components/schemas/Type" }, "liquidityOperation": { "description": "The liquidity operation type\n\n **Validation Rule(s)** The possible values are:\n- REL (Release),\n- PFU (Funding)", "$ref": "#/components/schemas/LiquidityOperation" }, "lspbranchFundsBalanceMemBic": { "description": "The BIC for which the API request is sent. If present, the system will return the stored instructions related to this BIC\n\n **Validation Rule(s)** One of the following must be true:\n- The BIC is an LSP of the SenderBic and the SenderBic manages the liquidity of the BIC\n- The BIC must belong to a branchFundsBalance and the SenderBic is the Owner of that branchFundsBalance\n\nIf none of the above conditions applies, the ErrorCode XA07 is returned.", "$ref": "#/components/schemas/Bic8" }, "reference": { "description": "The reference associated to the instruction\n\n **Validation Rule(s)** The univocal reference associated by the system to the instruction.\nRequest of Release: it corresponds to the Instruction ID of the relevant camt.050 message.\nRequest for Funding: it corresponds to:\n- Instruction ID of the relevant camt.050 mes-sage in case of CPFR and APFR;\n- Instruction ID of the relevant camt.054 mes-sage, in case of Funding notification received from TIPS during the LAC (CPFN).", "$ref": "#/components/schemas/Reference" }, "status": { "description": "The current status of the instruction\n\n **Validation Rule(s)** This is the Instruction Status. Possible values are:\n- Waiting – when the Settlement Instruction is generated by the System;\n- Settled – when the debit /credit notification has been received\n- Rejected – when the Liquidity Transfer Order is rejected by TIPS.", "$ref": "#/components/schemas/Status" }, "dateFrom": { "description": "The oldest date of the instructions sent or received in the system\n\n **Validation Rule(s)** It must be previous or equal to the current date (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "dateTo": { "description": "The maximum date for which the instructions are requested\n\n **Validation Rule(s)** It must be greater than or equal to the DateFrom (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "amountRangeFrom": { "description": "The minimum value of the range of the amount\n\n **Validation Rule(s)** If present it must be lesser than AmountRangeTo (ErrorCode XA05)\nOnly decimal notation is allowed (XA05)", "$ref": "#/components/schemas/Amount" }, "amountRangeTo": { "description": "The maximum value of the range of the amount\n\n **Validation Rule(s)** If present it must be greater than AmountRangeFrom (ErrorCode XA05)\nOnly decimal notation is allowed (XA05)", "$ref": "#/components/schemas/Amount" }, "debAccoOwnBic": { "description": "The Debtor Account Owner of the instruction", "$ref": "#/components/schemas/Bic11Only" }, "credAccoOwnBic": { "description": "The Creditor Account Owner of the instruction", "$ref": "#/components/schemas/Bic11Only" } }, "required": [ "liquidityOperation", "type", "dateFrom", "dateTo" ] }, "Criteria20": { "type": "object", "properties": { "paymentDetails": { "$ref": "#/components/schemas/PaymentDetails" } }, "required": [ "paymentDetails" ] }, "Criteria21": { "type": "object", "properties": { "acceptanceDateTime": { "description": "The AcceptanceDateTime of the IP\n\n **Validation Rule(s)** It must be lesser or equal to the current calendar date and timestamp (ErrorCode DT01)", "$ref": "#/components/schemas/ZonedDateTime" }, "transactionId": { "description": "The identifier of the transaction", "$ref": "#/components/schemas/TransactionId" }, "debtorBic": { "description": "The Debtor Agent BIC of the IP", "$ref": "#/components/schemas/Bic11" }, "csm": { "description": "The Clearing and Settlement Mechanism by which transactions were processed.\n\n **Validation Rule(s)** It must be one of the configured vaue:\nRT1: Transaction Settled in RT1;\nRT1-TIPS: Transaction settled in TIPS though RT1 Techenical Account;\nTIPS: Transaction settlend in TIPS on DCA account\n(ErrorCode XA03)", "$ref": "#/components/schemas/Csm1" } }, "required": [ "acceptanceDateTime", "transactionId", "debtorBic", "csm" ] }, "Criteria22": { "type": "object", "properties": { "transactionDetails": { "$ref": "#/components/schemas/TransactionDetails" }, "originalTransactionId": { "description": "The identification of the original transaction", "$ref": "#/components/schemas/OriginalTransactionId1" }, "lac": { "description": "The LAC in which the transaction was received and settled\n\n **Validation Rule(s)** It must be one of the configured Checkpoint in the system (ErrorCode XA03)", "$ref": "#/components/schemas/LacNumber" }, "reasonCode": { "description": "The Reason Code. This field will be a combo including all the values available in the system.", "$ref": "#/components/schemas/ReasonCode" }, "processingDate": { "description": "The processing date of the transactions\n\n **Validation Rule(s)** It must not be greater than the current date (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "instructingBic": { "description": "The instructing agent of the transactions\n\n **Validation Rule(s)** Mandatory if the InstructedBic is empty (ErrorCode XA04).\nEither the InstructingBic or the InstructedBic must be equal to the SenderBic (ErrorCode XA07).\nThe transactions whose Instructing Agent is equal to the SenderBic are returned", "$ref": "#/components/schemas/Bic8" }, "instructedBic": { "description": "The instructed agent of the transactions\n\n **Validation Rule(s)** Mandatory if the InstructingBic is empty (ErrorCode XA04)\nEither the InstructingBic or the InstructedBic must be equal to the SenderBic (ErrorCode XA07).\nThe transactions whose Instructed Agent is equal to the SenderBic are returned", "$ref": "#/components/schemas/Bic8" }, "amountRange": { "$ref": "#/components/schemas/AmountRange1" }, "timeFrom": { "description": "The oldest timestamp of the sending or receiving of the transactions by the system.\nIf isReceptionDate is 0: for “PST” and “INV” transaction types is the time of the AT-T056 field. For other cases is the time of the settlement date\nIf isReceptionDate is 1 the timeFrom is referrered to Reception Date Time\n\n **Validation Rule(s)** If isReceptionDate is 1 timeFrom is mandatory and the time interval timeFrom – timeTo must be shorter than one hour. (ErrorCode DT01)", "$ref": "#/components/schemas/Time" }, "timeTo": { "description": "The greatest timestamp of the sending or receiving of the transactions by the system.\nIf isReceptionDate is 0: for “PST” and “INV” transaction type is the time of the AT-T056 field. For other cases is the time of the settlement date.\nIf isReceptionDate is 1 the timeFrom is referrered to Reception Date Time\n\n **Validation Rule(s)** If isReceptionDate is 1 timeTo is mandatory and the time interval timeFrom – timeTo must be shorter than one hour. (ErrorCode DT01)", "$ref": "#/components/schemas/Time" }, "originalAmount": { "description": "The exact amount of the original transaction\n\n **Validation Rule(s)** Only decimal notation is allowed (XA05)", "$ref": "#/components/schemas/Amount" }, "originalSettlementDate": { "description": "The settlement date of the original transactions\n\n **Validation Rule(s)** It must not be greater than the current date (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "aos": { "description": "The AOS with which the transaction was validated", "$ref": "#/components/schemas/Aos" }, "transactionStatus": { "description": "The status of the transactions\n\n **Validation Rule(s)** It can assume only one of the configured values on the system.\nAllowed values:\n- “PBB” Processed by the Beneficiary Bank\n- “RBB” Rejected by the Beneficiary Bank\n- “RBE” Rejected by EBA\n- “PBE” Processed by EBA\n- “RBC” Rejected by SCT Inst\n- “PEN” Pending\n- “STD” Settled\n- “RJS” Rejectd\n- “NTF” notified\n- “VAL” validated\n- \"WTG\" Waiting (only retrieve in-flight non-time critical transactions)\n (ErrorCode XA03).", "$ref": "#/components/schemas/TransactionStatus" }, "originalEndToEndID": { "description": "The original End to End Id.\n\n **Validation Rule(s)** It must correspond to an Original End to End Id present in the Database (error XA03 – unknown value in the system)", "$ref": "#/components/schemas/OriginalEndToEndID" }, "csm": { "description": "The Clearing and Settlement Mechanism by which transactions were processed.\n\n **Validation Rule(s)** It must be one of the configured vaue:\nRT1: Transaction Settled in RT1;\nRT1-TIPS: Transaction settled in TIPS though RT1 Techenical Account;\nTIPS: Transaction settlend in TIPS on DCA account\n(ErrorCode XA03)", "$ref": "#/components/schemas/Csm1" }, "productId": { "description": "Field used to filter transaction for configured defaultProduct\n\n **Validation Rule(s)** Product must be a defaultProduct defined in the system (ErrorCode XA03)\nThe SenderBIC must be configured for the chosen product.\n(ErrorCode XA13)", "$ref": "#/components/schemas/Product" } }, "required": [ "transactionDetails", "csm", "productId" ] }, "Criteria23": { "type": "object", "properties": { "transactionId": { "description": "The transaction identification", "$ref": "#/components/schemas/TransactionId" }, "transactionType": { "description": "The type of the transaction\n\n **Validation Rule(s)** The type must be one of configured values in the system. The possible values are:(\n“PRR” Positive Response to Recall\n“RCL” Recall\n“NRR” Negative Response to Recall\n“INV” Investigation\n“PST” Payment Status Report\n“CNR” Claim non-receipt (camt.027)\nErrorCode XA03)", "$ref": "#/components/schemas/TransactionType1" }, "settlementDate": { "description": "The settlement date of the transaction for “PRR” or the processing date of the transaction for “RCL” and “NRR”, the date of the AT-T056 field for “PST” and “INV” transaction type", "$ref": "#/components/schemas/Date" }, "debtorBic": { "description": "The Debtor BIC of the transaction for “RCL” or of the original transaction for “PST”, \"CNR\" and “INV” transaction type\n\n **Validation Rule(s)** Mandatory if the TransactionType is “RCL”, “PST”, \"CNR\" or “INV” (ErrorCode XA04)", "$ref": "#/components/schemas/Bic11" }, "creditorBic": { "description": "RT1 BIC whose position will be updated, can be a LP or one of his LSPs\n\n **Validation Rule(s)** Mandatory if the TransactionType is “PRR” or “NRR” (ErrorCode XA04)", "$ref": "#/components/schemas/Bic11" }, "csm": { "description": "The Clearing and Settlement Mechanism by which transactions were processed.\n\n **Validation Rule(s)** It must be one of the configured vaue:\nRT1: Transaction Settled in RT1;\nRT1-TIPS: Transaction settled in TIPS though RT1 Techenical Account;\nTIPS: Transaction settlend in TIPS on DCA account\n(ErrorCode XA03)", "$ref": "#/components/schemas/Csm1" } }, "required": [ "transactionId", "transactionType", "settlementDate", "csm" ] }, "Criteria24": { "type": "object", "properties": { "fileType": { "description": "The file type\n\n **Validation Rule(s)** It must be one of the configured values in the system. The possible values:\nPSR”\n“DRR”\n“RSF”\n“MSR”\n“BCA”\n“BCS”\n\"RTF-TIPS\"\n\"RTF-INST\"\n\"RTF-OLO\"\n\"RTF-IXB\"\n (ErrorCode XA03)", "$ref": "#/components/schemas/FileType" }, "dateFrom": { "description": "The maximum date for which the files are requested\n\n **Validation Rule(s)** It must be previous or equal to the current date (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "dateTo": { "description": "The maximum date for which the files are requested\n\n **Validation Rule(s)** It must be greater than or equal to the DateFrom (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "timeFrom": { "description": "The oldest timestamp of the sending or receiving of the files by the system", "$ref": "#/components/schemas/Time" }, "timeTo": { "description": "The maximum time for which the files are requested\n\n **Validation Rule(s)** It must be greater than or equal to the TimeFrom (ErrorCode DT01)", "$ref": "#/components/schemas/Time" }, "fileReference": { "description": "The file reference of the file", "$ref": "#/components/schemas/FileReference" }, "fileStatus": { "description": "The status of the file\n\n **Validation Rule(s)** It can assume only one of the configured values on the system. The possible values are:\nTSD: transmitted;\nTSG: Transmitting;\nERR: Error;\nRNS: Retransmitted\n(schema validation)", "$ref": "#/components/schemas/FileStatus" } }, "required": [ "fileType", "dateFrom", "timeFrom" ] }, "Criteria25": { "type": "object", "properties": { "fileType": { "description": "The file type of the file\n\n **Validation Rule(s)** The file corresponding to the file reference must exist in the system, ref.10.7 (ErrorCode XA03)", "$ref": "#/components/schemas/FileType" }, "fileDate": { "description": "The date of the sending or receiving of the file by the system", "$ref": "#/components/schemas/Date" }, "fileReference": { "description": "The file reference of the file", "$ref": "#/components/schemas/FileReference" } }, "required": [ "fileType", "fileDate", "fileReference" ] }, "Criteria26": { "type": "object", "properties": { "requestDateTimeFrom": { "description": "The date and time of the request - from\n\n **Validation Rule(s)** It must be lesser than or equal to the current date and time (ErrorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "requestDateTimeTo": { "description": "The date and time of the request - to\n\n **Validation Rule(s)** It must be lesser than or equal to the current date and time (ErrorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "executionDateTimeFrom": { "description": "The date-time range in which the command has been executed or rejected - from\n\n **Validation Rule(s)** It must be lesser than or equal to the current date and time (ErrorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "executionDateTimeTo": { "description": "The date-time range in which the command has been executed or rejected - to\n\n **Validation Rule(s)** It must be lesser than or equal to the current date and time (ErrorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "commandType": { "description": "The type of the command\n\n **Validation Rule(s)** It must be a configured value in the system. The possible values are:\n\"UPD” request for update master data ;\n“INS” request for an insert in the master data;\n“RMV” request for a remove form the master data;\n“ROF” retransmission of Output Files;\n“RAL” resend all;\n\"GBA\" get account balance;\n\"BMI\" beneficiary management insert;\n\"BMA\" beneficiary management amend;\n\"BMR\" beneficiary management remove;\n\"RRE\" resend receipt;\n\"CDN\" credit/debit notification;\n\"PSQ\" generate payment status query;\n\"GOL\" generate outbound LTO\n\"LAG\" - Liquidity Agenda\n\"LCA\" - Liquidity Calendar\n\"RLI\" - Release Liquidity\n\"PFL\" - Pre-Funding Liquidity\n\"LTR\" - Liquidity Transfer\n“ALL” all command types.\n(ErrorCode XA03)", "$ref": "#/components/schemas/CommandType" }, "userAuthReject": { "description": "The Username of the Supervisor or of the Liquidity Manager that has authorized or rejected the command\n\n **Validation Rule(s)** It must be a known value in the system (ErrorCode XA03)", "$ref": "#/components/schemas/Authorizer" }, "userIssuer": { "description": "The requestor of the original submitted request\n\n **Validation Rule(s)** It must be a known value in the system (ErrorCode XA03)", "$ref": "#/components/schemas/Requestor1" } }, "required": [ "commandType" ] }, "Criteria27": { "type": "object", "properties": { "alertDateFrom": { "description": "The oldest date and time from which the alerts are searched and listed in the API Response\n\n **Validation Rule(s)** XA15 error details: “date from” must be lower that “date to”\nXA20: it must be equal to the allowed format\nDT01", "$ref": "#/components/schemas/DateTime" }, "alertDateTo": { "description": "The maximum date and time within which the alerts are searched and listed in the API Response\n\n **Validation Rule(s)** XA15 error details: “date from” must be lower that “date to”\nXA20: it must be equal to the allowed format\nDT01", "$ref": "#/components/schemas/DateTime" }, "alertCode": { "description": "It contains the code of the Alerts that must be returned\n\n **Validation Rule(s)** XA20: it must be equal to the allowed value", "$ref": "#/components/schemas/AlertCode" }, "alertDescription": { "description": "It contains the description of the Alerts that must be returned. It can also just be part of string description, using \"%\" for \"like\"\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format", "$ref": "#/components/schemas/AlertDescription" } }, "required": [ "alertDateFrom" ] }, "Criteria28": { "type": "object", "properties": { "bic": { "description": "The BIC of the Participant for which data shall be retrieved\n\n **Validation Rule(s)** The BIC must be:\n- The SenderBIC; or\n- An LSP of the SenderBIC\n (Error Code XA07)\nThe BIC must not be configured as a Member of a Branch Funds Balance (ErrorCode XA18)", "$ref": "#/components/schemas/Bic8" }, "month": { "description": "The month for which the User requires Interest’s details\n\n **Validation Rule(s)** It must be one of the configured values in the system - The possible values are:\n- “01” for January;\n- “02” for February;\n- “03” for March;\n- “04” for April;\n- “05” for May;\n- “06” for June;\n- “07” for July;\n- “08” for August;\n- “09” for September;\n- “10” for October;\n- “11” for November;\n- “12” for December.\n(ErrorCode XA03).\nFor the selected month the “Interest Calculation” must have run. The “Interest Calculation” status shall be equal to “calculated” or “completed” (Error Code XA19)", "$ref": "#/components/schemas/Month" }, "year": { "description": "The year for which the User requires Interest’s details\n\n **Validation Rule(s)** It shall correspond to a year between the current and the last year (Error Code DT01)", "$ref": "#/components/schemas/Year" } }, "required": [ "bic", "month", "year" ] }, "Criteria3": { "type": "object", "properties": { "messageType": { "description": "Identification of the message sent by Participant\n\n **Validation Rule(s)** Possible values are:\n• Outbound LTO (camt.050)\n• Funding/Defunding LTO (camt.050)\n• Credit/Debit Notification (camt.054)\n• Receipt (camt.025)\n• Get Account (camt.003)\n• Return Account (camt.004)\n• Payment Status Query (camt.005)\n• Payment Status Query Response (camt.006)\n(schema error)\n\nFor camt.003/004 shall be excluded all the RT1-destined messages:\n• excluded camt.003 where AcctQryDef > AcctCrit > NewCrit > SchCrit > AcctId/EQ/Othr/Id is equal to \"RT1-FUNDBALANCE\"\n• excluded camt.004 where RptOrErr > AcctRpt > AcctId > Othr > Id is equal to \"RT1-FUNDBALANCE\"", "$ref": "#/components/schemas/MessageType" }, "intraserviceLtoType": { "description": "This criteria is available only in case Message Type has been set equal to “Funding /Defunding LTO”.\n\n **Validation Rule(s)** Allowed values:\n• FUN: Funding\n• DEF: Defunding\n(schema error).", "$ref": "#/components/schemas/IntraserviceLtoType" }, "messageId": { "description": "Identification of the message sent by Participant", "$ref": "#/components/schemas/MessageId" }, "senderReceiverBic": { "description": "Sender BIC of the message\n\n **Validation Rule(s)** One of the following must be true:\n- The BIC is an LSP of the SenderBic and the SenderBic manages the liquidity of the BIC\n- The BIC must belong to a Branch Funds Balance and the SenderBic is the Owner of that Branch Funds Balance\n\nIf none of the above conditions applies, the ErrorCode XA07 is returned.", "$ref": "#/components/schemas/Bic8" }, "requestedThrough": { "description": "Indicates the interface through which the message (or the original message, in case of camt.025, camt.004 or camt.006) has been requested or sent.\n\n **Validation Rule(s)** Not required if message type is equal to camt.054, ErrorCode XA07 is returned.\nAllowed values:\n• U2A: GUI-API interface;\n• A2A: Message interface;\n(schema validation)\n\n\"Resend Receipt\" and \"Resend Notification\" are allowed only when the messages was previously trasmitted to the Participant via interface Message Interface", "$ref": "#/components/schemas/RequestedThrough" }, "processingDtFrom": { "description": "Field where to enter the lower bound of the processing date", "$ref": "#/components/schemas/Date" }, "processingTmFrom": { "description": "Field where to enter the lower bound of the time", "$ref": "#/components/schemas/Time" }, "processingDtTo": { "description": "Field where to enter the upper bound of the processing date\n\n **Validation Rule(s)** Allowed range up to 7 days from “processingDtFrom” (errorCode DT01)", "$ref": "#/components/schemas/Date" }, "processingTmTo": { "description": "Field where to enter the upper bound of the time", "$ref": "#/components/schemas/Time" }, "messageStatus": { "description": "The message status.\n\n **Validation Rule(s)** new validation rule for field messageStatus has to be:\nAllowed values:\n• TSD: Transmitted (all messages)\n• NTF: Notified (all messages)\n• STD: Settled (camt.050)\n• RJS: Rejected (camt.050 – camt.003 – camt.004 – camt.005 – camt.006 - camt.025 - camt.054)\n• ERR: Error (camt.025 – camt.054).\n(schema validation)", "$ref": "#/components/schemas/Status1" }, "debAccOwnBic": { "description": "The BIC11 of the owner of the debited TIPS Account\n\n **Validation Rule(s)** This field is allowed if message type is Outbound LTO (camt.050), Funding/Defunding LTO (camt.050) or Credit/Debit Notification (camt.054)\n(errorCode: XA13)", "$ref": "#/components/schemas/Bic11Only" }, "creAccOwnBic": { "description": "The BIC11 of the owner of the debit-ed TIPS Account\n\n **Validation Rule(s)** This field is allowed if message type is Outbound LTO (camt.050), Funding/Defunding LTO (camt.050) or Credit/Debit Notification (camt.054).\n(errorCode: XA13)", "$ref": "#/components/schemas/Bic11Only" }, "settlDate": { "description": "The settlement Date of the credit transfer or the booking date of the Debit/Credit notification.\n\n **Validation Rule(s)** This field is allowed if message type is Outbound LTO (camt.050), Funding/Defunding LTO (camt.050) or Credit/Debit Notification (camt.054)\n(errorCode: XA13)", "$ref": "#/components/schemas/Date" }, "origMessId": { "description": "The Identifiier of the original message\n\n **Validation Rule(s)** The field field is allowed if message type is Receipt (camt.025) , Return Account (camt.004)\n(errorCode: XA13)", "$ref": "#/components/schemas/MessageId" }, "ltoTipsStatus": { "description": "Select the message status of the outbound liquidity transfer order as processed by TIPS:\n• RREJ (rejected by T2)\n• RCON (confirmed by T2)\n• RJCS (any other value)\n\n **Validation Rule(s)** The field field is allowed if message type is Receipt (camt.025)\n(errorCode: XA13)", "$ref": "#/components/schemas/LtoTipsStatus" }, "accOrCmbId": { "description": "Field where to enter the identification of the account or CMB\n\n **Validation Rule(s)** This field is allowed if message type is Get Account (camt.003)\n(errorCode: XA13)", "$ref": "#/components/schemas/Account" }, "accUser": { "description": "Field where to enter the BIC of the user of the Account or CMB\n\n **Validation Rule(s)** This field is allowed if message type is Get Account (camt.003)\n(errorCode: XA13)", "$ref": "#/components/schemas/Account" }, "tipsTimestampDtFrom": { "description": "Field where to enter the lower bound of the timestamp assigned by TIPS when retrieval of records has been performed\n\n **Validation Rule(s)** This field is allowed if message type is Return Account (camt.004)\n(errorCode: XA13)", "$ref": "#/components/schemas/Date" }, "tipsTimestampTmFrom": { "description": "Field where to enter the upper bound of the date assigned by TIPS when retrieval of records has been performed\n\n **Validation Rule(s)** This field is allowed if message type is Return Account (camt.004)\n(errorCode: XA13)", "$ref": "#/components/schemas/Time" }, "tipsTimestampDtTo": { "description": "Field where to enter the upper bound of the date assigned by TIPS when retrieval of records has been performed\n\n **Validation Rule(s)** This field is allowed if message type is Return Account (camt.004)\n(errorCode: XA13)", "$ref": "#/components/schemas/Date" }, "tipsTimestampTmTo": { "description": "Field where to enter the upper bound of the time assigned by TIPS when retrieval of records has been performed\n\n **Validation Rule(s)** This field is allowed if message type is Return Account (camt.004)\n(errorCode: XA13)", "$ref": "#/components/schemas/Time" }, "businessError": { "description": "Error raised\n\n **Validation Rule(s)** This field is allowed if message type is Return Account (camt.004)\n(errorCode: XA13)", "$ref": "#/components/schemas/ErrorCode" }, "origTransactionId": { "description": "Field where to enter the identification of the originating payment message\n\n **Validation Rule(s)** This field is allowed if message type is Payment Status Query (camt.005) or Payment Status Query Response (camt.006)\n(errorCode: XA13)", "$ref": "#/components/schemas/OriginalTransactionId" }, "messageTypeCamt005": { "description": "Indicates the type of the original message\n\n **Validation Rule(s)** This field is allowed if message type is Payment Status Query Response (camt.005) (errorCode: XA13)\nIndicates the type of the original message.\nAvailable only for messages generated by RT1 CS in the Message ID field.\nAllowed values:\n• Pacs.008;\n• Pacs.004.\n(schema error)", "$ref": "#/components/schemas/MessageTypeCamt005" }, "paymentStatus": { "description": "Select the status of the payments inquired.\n\n **Validation Rule(s)** This field is allowed if message type is Payment Status Query Response (camt.006) (errorCode: XA13)\nSelect the status of the payments inquired.\nAllowed values:\n• Pending (PSTL)\n• Settled (STLD)\n• Cancelled (CAND)\n• Expired (FNLD)\n• Rejected (RJTD)\n• Failed (FAIL)\n(schema error)", "$ref": "#/components/schemas/PaymentStatus" } }, "required": [ "messageType", "processingDtFrom" ] }, "Criteria4": { "type": "object", "properties": { "messageType": { "description": "Identification of the message sent by Participant\n\n **Validation Rule(s)** Possible values are:\n• Outbound LTO (camt.050)\n• Funding/Defunding LTO (camt.050)\n• Receipt (camt.025)\n• Get Account (camt.003)\n• Return Account (camt.004)\n• Payment Status Query (camt.005)\n• Payment Status Query Response (camt.006)\n(schema validation)", "$ref": "#/components/schemas/MessageType1" }, "messageId": { "description": "Identification of the message sent by Participant", "$ref": "#/components/schemas/MessageId" }, "senderReceiverBic": { "description": "Sender BIC of the message\n\n **Validation Rule(s)** must be an its lsp or an its member bic, otherwise XA07", "$ref": "#/components/schemas/Bic8" }, "processingDtTm": { "description": "Field where to enter the lower bound of the processing date", "$ref": "#/components/schemas/DateTime" } }, "required": [ "messageType", "messageId", "senderReceiverBic", "processingDtTm" ] }, "Criteria5": { "type": "object", "properties": { "participantBic": { "description": "The Participant Bic\n\n **Validation Rule(s)** Must be equal to the BIC of the senderBic (ErrorCodeXA02)", "$ref": "#/components/schemas/Bic8" }, "beneficiaryBicCode": { "description": "It is the RTGS BIC for defunding to TARGET.\n\n **Validation Rule(s)** The BIC must be present in Beneficiary repository (ErrorCode PY01).", "$ref": "#/components/schemas/Bic11Only" }, "beneficiaryName": { "description": "The Beneficiary Name", "$ref": "#/components/schemas/Name" }, "beneficiaryAcc": { "description": "The Beneficiary Account\n\n **Validation Rule(s)** The Account must be present in Beneficiary repository (ErrorCode XA03).", "$ref": "#/components/schemas/Account" }, "amount": { "description": "The amount to be transferred.\n\n **Validation Rule(s)** Only decimal notation is allowed (XA05)", "$ref": "#/components/schemas/Amount" } }, "required": [ "participantBic", "beneficiaryBicCode", "beneficiaryName", "beneficiaryAcc", "amount" ] }, "Criteria6": { "type": "object", "properties": { "participantBic": { "description": "The Participant Bic\n\n **Validation Rule(s)** Must be equal to the BIC of the senderBic (ErrorCodeXA02).", "$ref": "#/components/schemas/Bic11" }, "date": { "description": "The AcceptanceDate of the SCT Inst Transaction or the Interbank settlement date of the Positive Payment Response\n\n **Validation Rule(s)** It must be lesser or equal to the current calendar date and timestamp (ErrorCode DT01)", "$ref": "#/components/schemas/ZonedDateTime" }, "transactionId": { "description": "The transaction identifier", "$ref": "#/components/schemas/Transactionid" }, "transactionType": { "description": "The type of transaction\n\n **Validation Rule(s)** Allowed values:\n IPT: Instant Payment transaction\n PPR: Positive Payment Response\n(schema validation)", "$ref": "#/components/schemas/TransactionType" }, "csm": { "description": "The clearing and settlement mechanism by which transaction was processed.\n\n **Validation Rule(s)** Allowed values:\n RT1-TIPS: for hybrid transactions\n TIIPS: for transactions settled in TIPS.\n(schema validation)", "$ref": "#/components/schemas/Csm" } }, "required": [ "participantBic", "date", "transactionId", "transactionType", "csm" ] }, "Criteria7": { "type": "object", "properties": { "participantBic": { "description": "The Participant Bic\n\n **Validation Rule(s)** Must be equal to the BIC of the senderBic (ErrorCodeXA02)", "$ref": "#/components/schemas/Bic8" } }, "required": [ "participantBic" ] }, "Criteria8": { "type": "object", "properties": { "participantBic": { "description": "The Participant Bic\n\n **Validation Rule(s)** Must be equal to the BIC of the senderBic (ErrorCodeXA02)", "$ref": "#/components/schemas/Bic8" }, "beneficiaryBic": { "description": "It is the RTGS BIC for defunding to TARGET.", "$ref": "#/components/schemas/Bic11" }, "operationType": { "description": "The Operation Type\n\n **Validation Rule(s)** Value allowed:\n INS: Insert;\n MOD: modify;\n REM: remove.\n(schema validation)", "$ref": "#/components/schemas/OperationType" }, "beneficiaryName": { "description": "The Beneficiary Name\n\n **Validation Rule(s)** Must be present if the Operation Type is \"INS\".\n(ErrorCode XA13)", "$ref": "#/components/schemas/Name" }, "beneficiaryAcc": { "description": "The Beneficiary Account\n\n **Validation Rule(s)** Must be present if the Operation Type is \"INS\".\n(ErrorCode XA13)", "$ref": "#/components/schemas/Account" } }, "required": [ "participantBic", "beneficiaryBic", "operationType" ] }, "Criteria9": { "type": "object", "properties": { "bic": { "description": "The BIC of the searched DP", "$ref": "#/components/schemas/Bic8" }, "technicalBic": { "description": "It indicates if the BIC is a technical one (1) or not (0)", "$ref": "#/components/schemas/TechnicalBic1" }, "lsp": { "description": "It indicates if the BIC is served for Liquidity Funding/Defunding (value Yes) or not (value No)", "$ref": "#/components/schemas/Lsp" }, "tipsAccountOwnerBic": { "description": "TIPS DCA Account Owner for Instra-Service Liquidity Transfer (li-quidity funding/defunding)", "$ref": "#/components/schemas/Bic11Only" }, "aos": { "description": "One of the AOS subscribed by the DP\n\n **Validation Rule(s)** AOS must be a string defined in the system (ErrorCode XA03)", "$ref": "#/components/schemas/Aos" }, "status": { "description": "The current status of the DP\n\n **Validation Rule(s)** Allowed values:\n “ALL” All statuses\n “ENB” Enabled\n “SUS” Suspended\n “DIS” Disabled\n “CNG” Changed\n “INS” Inserted\n “RNL” R-Only\nThe value must be one of the available status in the system (ErrorCode XA03)", "$ref": "#/components/schemas/Status3" }, "tipsAdherence": { "description": "It indicates if the Participant joined to TIPS (1) or not (0) (Mandatory if the section is present)\n\n **Validation Rule(s)** Allowed values:\n- 0 = Participant not joined to TIPS\n- 1 = Participant joined to TIPS", "$ref": "#/components/schemas/TipsAdherence" }, "productId": { "description": "Field used to filter Participant for configured product\n\n **Validation Rule(s)** Product must be a string defined in the system (ErrorCode XA03)\nThe SenderBIC must be configured for the chosen product.\n(ErrorCode XA13)", "$ref": "#/components/schemas/ProductId1" } } }, "Critical": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "Csm": { "type": "string", "enum": [ "RT1-TIPS", "TIPS" ], "examples": [ "RT1-TIPS" ] }, "Csm1": { "type": "string", "enum": [ "RT1", "RT1-TIPS", "TIPS" ], "examples": [ "RT1-TIPS" ] }, "CurrenciesList": { "type": "object", "properties": { "currencyCode": { "description": "Code of currency.\nMandatory if the section is present, otherwise XA04 Mandatory field depending on the presence of other fields", "$ref": "#/components/schemas/CurrencyCode" }, "currencyDescr": { "description": "Full description of currency", "$ref": "#/components/schemas/CurrencyDescr" } }, "required": [ "currencyCode" ] }, "CurrencyCode": { "type": "string", "maxLength": 3, "examples": [ "EUR" ] }, "CurrencyDescr": { "type": "string", "examples": [ "Euro" ] }, "CurrencyName": { "type": "string", "maxLength": 32, "examples": [ "Euro" ] }, "CurrencyTimestamp": { "type": "string", "examples": [ "2019-06-21T23:20:50.000001" ] }, "CurrentNetPositionResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "senderPosition": { "$ref": "#/components/schemas/SenderPosition" }, "lspsPosition": { "description": "The following sub-section is repeated for each LSPBic whose liquidity management the SenderBic is responsible for.", "type": "array", "items": { "$ref": "#/components/schemas/LspsPosition" } }, "branchFundsBalancePosition": { "$ref": "#/components/schemas/BranchFundsBalancePosition" }, "ownedBranchFundsBalanceList": { "description": "The following sub-section is only present if the SenderBic owns one or more Branch Funds Balance and it is repeated for each Branch Funds Balance.", "type": "array", "items": { "$ref": "#/components/schemas/OwnedBranchFundsBalanceList" } } }, "required": [ "dateTime" ] }, "CurrentPBICCode": { "type": "string", "minLength": 8, "maxLength": 11, "examples": [ "IPSDPF21XXX" ] }, "Date": { "description": "Standard ISO Date.", "type": "string", "pattern": "[0-9]{4,4}\\-[0-9]{2,2}\\-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "DateOfConfirm": { "type": "string", "examples": [ "6/21/2019" ] }, "DateOfConfirmFrom": { "type": "string", "examples": [ "6/21/2019" ] }, "DateOfConfirmTo": { "type": "string", "examples": [ "6/21/2019" ] }, "DateTime": { "description": "Standard ISO Date-Time.", "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" ] }, "DateTime1": { "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" ] }, "Day": { "type": "integer", "enum": [ 1, 2, 3, 4, 5, 6, 7 ], "examples": [ 1 ] }, "DebSettMethod": { "type": "string", "enum": [ "LQPS", "RT1A", "TDCA" ], "examples": [ "LQPS" ] }, "DebSettMethod1": { "type": "string", "enum": [ "LQPS", "RT1A", "TDCA" ], "maxLength": 4, "examples": [ "LQPS" ] }, "DebtorSettlementMethod": { "type": "string", "enum": [ "LQPS", "RT1A", "TDCS" ], "maxLength": 4, "examples": [ "LQPS" ] }, "DefaultDayValues": { "type": "object", "properties": { "day": { "description": "The day of the week\n\n **Validation Rule(s)** The value must be between 1 and 5 (schema validation)\n1 – Monday,\n2- Tuesday,\n3 – Wednesday,\n4 – Thursday,\n5 – Friday,\n6- Saturday,\n7- Sunday", "$ref": "#/components/schemas/Day" }, "defaultLACValues": { "description": " **Validation Rule(s)** This section can be present just one time or repeated as many times as the maximum number of LACs in the system.\nThis section must be formatted with squared brackets.", "type": "array", "items": { "$ref": "#/components/schemas/DefaultLACValues" } } }, "required": [ "day", "defaultLACValues" ] }, "DefaultLACValues": { "type": "object", "properties": { "lac": { "description": "The number of the LAC for which the values are inquired\n\n **Validation Rule(s)** Mandatory if the section is present.\nIt must be one of the configured Checkpoint in the system (ErrorCode XA03)\nIf the pair Day-LAC is the next one, the request must be received by the system before the “Liquidity Agenda Grace Time”\n(ErrorCode XA08)", "$ref": "#/components/schemas/LacNumber" }, "base": { "description": "The base value amount\n\n **Validation Rule(s)** Mandatory if the section is present.\nIt must be equal or greater than 0 and between Lower and Upper (ErrorCode XA05)", "$ref": "#/components/schemas/LacAmount" }, "lower": { "description": "The minimum value amount\n\n **Validation Rule(s)** Mandatory if the section is present.\nIt must be between 0 and Base (ErrorCode XA05)", "$ref": "#/components/schemas/LacAmount" }, "upper": { "description": "The maximum value amount\n\n **Validation Rule(s)** Mandatory if the section is present.", "$ref": "#/components/schemas/LacAmount" }, "resetToBasePosition": { "description": "Whether the participant requests to check/uncheck the “Reset to Base Position” flag for the relevant LAC\n\n **Validation Rule(s)** Mandatory if the section is present.\nMust be set with the following possible values:\n1=YES\n0=NO, Default if not set in the API", "$ref": "#/components/schemas/ResetToBasePosition" }, "sendAccountQueryToTips": { "description": "Whether the participant requests to check/uncheck the “Send Account Query toTIPS” flag for the relevant LAC\n\n **Validation Rule(s)** Mandatory if the section is present.\nMust be set with the following possible values:\n1=YES\n0=NO, Default if not set in the API", "$ref": "#/components/schemas/SendAccountQueryToTips" } }, "required": [ "lac", "base", "lower", "upper" ] }, "DefaultLACValues1": { "type": "object", "properties": { "lac": { "description": "The LAC in the system (Mandatory if this section is present)", "$ref": "#/components/schemas/LacNumber" }, "base": { "description": "The base value amount set in the system for the LSPBic, the Day and LAC (Mandatory if this section is present)", "$ref": "#/components/schemas/LacAmount" }, "lower": { "description": "The minimum value amount set in the system for the LSPBic, the Day and LAC (Mandatory if this section is present)", "$ref": "#/components/schemas/LacAmount" }, "upper": { "description": "The maximum value amount set in the system for the LSPBic, the Day and LAC (Mandatory if this section is present)", "$ref": "#/components/schemas/LacAmount" }, "resetToBasePosition": { "description": "Whether the “Reset to Base Position” flag for the relevant LAC is checked/unchecked.\n The field is present only when set to: 1=YES", "$ref": "#/components/schemas/ResetToBasePosition" }, "sendAccountQueryToTips": { "description": "Whether the “Send Account Query to TIPS” flag for the relevant LAC is checked/unchecked.\nThe field is present only when set to: 1=YES", "$ref": "#/components/schemas/SendAccountQueryToTips" } }, "required": [ "lac", "base", "lower", "upper" ] }, "DefaultPositionRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "lspBic": { "description": "The BIC of the LSP whose liquidity is managed by the SenderBic. If present, the system will change the default parameters of this BIC.\n\n **Validation Rule(s)** The LSPBic liquidity must be managed by its LP, and its LP must be equal to the SenderBic (ErrorCode XA14)", "$ref": "#/components/schemas/Bic8" }, "defaultDayValues": { "$ref": "#/components/schemas/DefaultDayValues" } }, "required": [ "dateTime", "defaultDayValues" ] }, "DefaultPositionResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "effectiveDate": { "description": "It contains the first date for which the system will apply the requested changes", "$ref": "#/components/schemas/Date" } }, "required": [ "dateTime", "effectiveDate" ] }, "DefaultValues": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "DefundingRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "releaseInfo": { "$ref": "#/components/schemas/ReleaseInfo" } }, "required": [ "dateTime", "releaseInfo" ] }, "DefundingResponse": { "type": "object", "properties": { "dateTime": { "description": "Standard ISO Date-Time.", "$ref": "#/components/schemas/DateTime" }, "remainingAmount": { "description": "This field is present only if Response code = 200\nThe amount that is left in the Position of the involved BIC (either the SenderBic, or the MemberBic or the LSPBic).", "$ref": "#/components/schemas/Amount1" } }, "required": [ "dateTime" ] }, "Description": { "type": "string", "maxLength": 1000, "examples": [ "\"SCT Inst message received from has been rejected due to a wrong value received within Reject / Refusal Reason Code field\" (Alert 4)." ] }, "Details": { "type": "object", "properties": { "newBic": { "description": "The New BIC of the AP", "$ref": "#/components/schemas/Bic11" }, "tipsUserBic": { "description": "BIC used for reachability in TIPS through a DCA account", "$ref": "#/components/schemas/Bic11Only" }, "bbPositiveCnf": { "description": "It indicates if the AP asked for confirmation of the credited payment amount (Mandatory if the section is present)", "$ref": "#/components/schemas/BbPositiveCnf" }, "bbTimeoutMgm": { "description": "It indicates if the SCT Inst has to reject the transaction that are not confirmed or rejected within the timeout expiration time by the Participant, when acting as Beneficiary Bank (Mandatory if the section is present)", "$ref": "#/components/schemas/BbTimeoutMgm" }, "roleChange": { "description": "It indicates if the Participant has changed its role (1) or not (0) (Mandatory if the section is present)", "$ref": "#/components/schemas/RoleChange" }, "productList": { "description": "List of products", "type": "array", "items": { "$ref": "#/components/schemas/ProductList4" } } }, "required": [ "tipsUserBic", "bbPositiveCnf", "bbTimeoutMgm", "roleChange", "productList" ] }, "DrrReq": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "DrrReq1": { "type": "string", "enum": [ "0", "1" ], "maxLength": 1, "examples": [ "0" ] }, "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" ] }, "EndOfList": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "EndToEndID": { "type": "string", "maxLength": 35, "examples": [ "444596268999" ] }, "EndToEndId": { "type": "string", "maxLength": 35, "examples": [ "444596268999" ] }, "ErrorCode": { "type": "string", "maxLength": 4, "examples": [ "XA01" ] }, "ErrorCodeDescription": { "type": "string", "maxLength": 255, "examples": [ "Generic Error" ] }, "ErrorResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "errorCode": { "description": "The relevant error code", "$ref": "#/components/schemas/ErrorCode" }, "errorCodeDescription": { "description": "The 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" ] }, "ErrorResponse1": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime1" }, "errorCode": { "description": "The relevant error code", "$ref": "#/components/schemas/ErrorCode" }, "errorCodeDescription": { "description": "The 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/RequestId1" } }, "required": [ "dateTime", "errorCode", "errorCodeDescription" ] }, "EventCode": { "type": "string", "enum": [ "INS", "DEL" ], "examples": [ "INS" ] }, "EventCode1": { "type": "string", "enum": [ "INS", "UPD" ], "examples": [ "INS" ] }, "EventDescription": { "type": "string", "pattern": "[A-Za-z0-9\\s\\\"\\#\\$\\%\\&\\'\\(\\)\\*\\+\\,\\-\\.\\/\\:\\;\\<\\=\\>\\?\\@\\\\\\_\\`\\{\\}\\~\\]]", "maxLength": 1000, "examples": [ "PARTICIPANT BIC8CODE IS NOT PRESENT" ] }, "EventDescription1": { "type": "string", "maxLength": 1000, "examples": [ "Free text to describe the event that causes the unavailability" ] }, "EventType": { "type": "string", "enum": [ "ERROR", "FATAL", "NORMAL", "SECURITY", "WARNING" ], "examples": [ "ERROR" ] }, "ExceptionLacValues": { "type": "object", "properties": { "lac": { "description": "The number of the LAC for which the values are set\n\n **Validation Rule(s)** Mandatory if the section is present\nIt must be one of the configured Checkpoint in the system (ErrorCode XA03)\nIf the pair BusinessDate-LAC is the next one, the request must be received by the system before the “Liquidity Agenda Grace Time” (ErrorCode XA08)", "$ref": "#/components/schemas/LacNumber" }, "base": { "description": "The base value amount\n\n **Validation Rule(s)** Mandatory if the section is present\nIt must be between Lower and Upper (ErrorCode XA05)", "$ref": "#/components/schemas/LacAmount" }, "lower": { "description": "The minimum value amount\n\n **Validation Rule(s)** Mandatory if the section is present\nIt must be between 0 and Base (ErrorCode XA05)", "$ref": "#/components/schemas/LacAmount" }, "upper": { "description": "The maximum value amount\n\n **Validation Rule(s)** Mandatory if the section is present", "$ref": "#/components/schemas/LacAmount" }, "resetToBasePosition": { "description": "Whether the participant requests to check/uncheck the “Reset to Base Position” flag for the relevant LAC\n\n **Validation Rule(s)** Mandatory if the section is present.\nMust be set with the following possible values:\n1=YES\n0=NO, Default if not set in the API", "$ref": "#/components/schemas/BoolValue" }, "sendAccountQueryToTips": { "description": "Whether the participant requests to check/uncheck the “Send Account Query toTIPS” flag for the relevant LAC\n\n **Validation Rule(s)** Mandatory if the section is present.\nMust be set with the following possible values:\n1=YES\n0=NO, Default if not set in the API", "$ref": "#/components/schemas/BoolValue" } }, "required": [ "lac", "base", "lower", "upper" ] }, "ExceptionPositionCalendarRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "lspBic": { "description": "The BIC of the LSP whose liquidity is managed by the SenderBic. If present, the system will change the exception default parameters of this BIC and not the ones of the SenderBic.\n\n **Validation Rule(s)** The LSPBic liquidity must be managed by its LP, and its LP must be equal to the SenderBic (ErrorCode XA14)", "$ref": "#/components/schemas/Bic8" }, "businessDate": { "description": "The business date of the year to which the values are requested\n\n **Validation Rule(s)** The date can be the current date or a future calendar date no further than one year from the current one (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "exceptionLacValues": { "description": " **Validation Rule(s)** This section can be present just one time or repeated as many times as the maximum number of LACs in the system.\nThis section must be formatted with squared brackets.", "type": "array", "items": { "$ref": "#/components/schemas/ExceptionLacValues" } } }, "required": [ "dateTime", "businessDate", "exceptionLacValues" ] }, "ExceptionPositionCalendarResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" } }, "required": [ "dateTime" ] }, "FileActiveOutputNet": { "type": "integer", "examples": [ 1 ] }, "FileDetails": { "type": "object", "properties": { "fileType": { "description": "The file type (Mandatory if the section is present)", "$ref": "#/components/schemas/FileType" }, "fileDateTime": { "description": "The date and time of the reception or sending of the file by the system (Mandatory if the section is present)", "$ref": "#/components/schemas/DateTime" }, "fileReference": { "description": "The file reference of the file (Mandatory if the section is present)", "$ref": "#/components/schemas/FileReference" } }, "required": [ "fileType", "fileDateTime", "fileReference" ] }, "FileDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria25" } }, "required": [ "dateTime", "criteria" ] }, "FileDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "Standard ISO Date-Time.", "$ref": "#/components/schemas/DateTime" }, "receiverBic": { "description": "The BIC of the Participant that received the file from the system", "$ref": "#/components/schemas/Bic8" }, "sendingDateTime": { "description": "The date and time of sending of the file to the Participant", "$ref": "#/components/schemas/DateTime" }, "fileReference": { "description": "The FileReference contained in the request", "$ref": "#/components/schemas/FileReference" }, "fileType": { "description": "The file type contained in the request", "$ref": "#/components/schemas/FileType" }, "businessDate": { "description": "The business date for the sent file from the system to the DP", "$ref": "#/components/schemas/Date" }, "netFileName": { "description": "The network file name of the file", "$ref": "#/components/schemas/NetFileName" }, "network": { "description": "The network used for the reception/sending of the file, it can contain only:\n- “EAS” for SIANet\n- “EBX” for EBICS\n- “SWF” for SWIFTNet RT single request type\n- “SWA” for SWIFTNet RT multiple request type\n- \"SWS\" for SWIFTNet S&F single request type\n- \"SWM\" for SWIFTNet S&F multiple request type", "$ref": "#/components/schemas/Network2" }, "lac": { "description": "The LAC in which the file was created for sending to the Participant (not available for “DRR” and “MSR”, “BCA” and “BCS” FileType)", "$ref": "#/components/schemas/LacNumber" }, "fileStatus": { "description": "The status of the file", "$ref": "#/components/schemas/FileStatus1" }, "listDRRData": { "description": "The following section is present only if the FileType is “DRR”", "$ref": "#/components/schemas/ListDRRData" }, "listMSRData": { "description": "The following section is present only if the FileType is “MSR”", "$ref": "#/components/schemas/ListMSRData" } }, "required": [ "dateTime", "fileReference", "fileType" ] }, "FilePrimaryNetId": { "type": "string", "enum": [ "EAS", "EBX", "SWF", "SWA", "SWS", "SWM" ], "examples": [ "EAS" ] }, "FilePrimaryNetId1": { "type": "string", "enum": [ "EAS", "EBX", "SWF", "SWA", "SWS", "SWM" ], "maxLength": 3, "examples": [ "EAS" ] }, "FileReference": { "type": "string", "maxLength": 16, "examples": [ "DSCI210301000015" ] }, "FileSecondaryNetId": { "type": "string", "enum": [ "EAS", "EBX", "SWF", "SWA", "SWS", "SWM" ], "examples": [ "EAS" ] }, "FileSecondaryNetId1": { "type": "string", "enum": [ "EAS", "EBX", "SWF", "SWA", "SWS", "SWM" ], "maxLength": 3, "examples": [ "EAS" ] }, "FileStatus": { "type": "string", "enum": [ "TSD", "TSG", "ERR", "RNS" ], "maxLength": 3, "examples": [ "TSD" ] }, "FileStatus1": { "type": "string", "maxLength": 3, "examples": [ "TSD" ] }, "FileType": { "type": "string", "enum": [ "PSR", "DRR", "RSF", "MSR", "BCA", "BCS", "RTF-TIPS", "RTF-INST", "RTF-OLO", "RTF-IXB" ], "maxLength": 8, "examples": [ "RSF" ] }, "FnalPayStatusCode": { "type": "string", "enum": [ "STLD", "CAND", "FNLD", "FAIL", "PSTL" ], "examples": [ "STLD" ] }, "FundingInfo": { "type": "object", "properties": { "amount": { "description": "The amount to be funded\n\n **Validation Rule(s)** The Amount cannot be greater than 999999999999.99 (ErrorCode XA05)\nThe Amount cannot be equal to zero (ErrorCode XA05)\nOnly decimal notation is allowed (XA05).", "$ref": "#/components/schemas/Amount1" }, "lspBic": { "description": "The BIC of the LSP whose liquidity is managed by the SenderBic. If present, the system will send for the LSPBic a funding request to T2I equal to the Amount.\n\n **Validation Rule(s)** • The LSPBic liquidity must be managed by its LP, and its LP must be equal to the SenderBic (ErrorCode XA14)\n• It must be a not-suspended Participant (ErrorCode PY01)\nIt must not be present contemporarily with the pair MemberBic and branchFundsBalanceId (ErrorCode XA17)", "$ref": "#/components/schemas/Bic8" }, "memberBic": { "description": "The BIC of the Member for which it is requested the funding\n\n **Validation Rule(s)** Mandatory if the branchFundsBalanceId is present (ErrorCode XA02 )\nThe MemberBic must belong to the specified branchFundsBalanceId and must not be suspended(ErrorCode XA06)\nIt must not be present contemporarily with LSPBic (ErrorCode XA17)", "$ref": "#/components/schemas/Bic8" }, "branchFundsBalanceId": { "description": "The id of the branchFundsBalance to which the MemberBic belongs.\n\n **Validation Rule(s)** Mandatory if MemberBic is present (ErrorCode XA04 )\nIt must not be present contemporarily with LSPBic (ErrorCode XA17)", "$ref": "#/components/schemas/BranchFundsBalanceId" } }, "required": [ "amount" ] }, "FundingRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "fundingInfo": { "$ref": "#/components/schemas/FundingInfo" } }, "required": [ "dateTime", "fundingInfo" ] }, "FundingResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" } }, "required": [ "dateTime" ] }, "GenerateOutboundLtoRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria5" } }, "required": [ "dateTime", "criteria" ] }, "GenerateOutboundLtoResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "referenceId": { "description": "The univocal reference per SenderBic and date assigned by the system to the request.", "$ref": "#/components/schemas/ReferenceId" }, "messageId": { "description": "The message identifier of the camt.050 message generated by RT1 System", "$ref": "#/components/schemas/MessageId1" } }, "required": [ "dateTime", "referenceId", "messageId" ] }, "GeneratePaymentStatusQueryRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria6" } }, "required": [ "dateTime", "criteria" ] }, "GeneratePaymentStatusQueryResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "referenceId": { "description": "The univocal reference per SenderBic and date assigned by the system to the request.", "$ref": "#/components/schemas/ReferenceId" }, "messageId": { "description": "The message identifier of the camt.005 message generated by RT1 System and forwarded to TIPS.", "$ref": "#/components/schemas/MessageId" } }, "required": [ "dateTime", "referenceId", "messageId" ] }, "GetAccountBalanceRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria7" } }, "required": [ "dateTime", "criteria" ] }, "GetAccountBalanceResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "referenceId": { "description": "The univocal reference per SenderBic and date assigned by the system to the request.", "$ref": "#/components/schemas/ReferenceId" }, "messageId": { "description": "The MessageID of the camt.003 message sent to TIPS.", "$ref": "#/components/schemas/MessageId" } }, "required": [ "dateTime", "referenceId", "messageId" ] }, "GetDefaultPositionRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria" } }, "required": [ "dateTime" ] }, "GetDefaultPositionResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "values": { "$ref": "#/components/schemas/Values" } }, "required": [ "dateTime" ] }, "GetExceptionPositionCalendarRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria1" } }, "required": [ "dateTime", "criteria" ] }, "GetExceptionPositionCalendarResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "response": { "$ref": "#/components/schemas/Response" } }, "required": [ "dateTime" ] }, "GetParticipantsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria9" } }, "required": [ "dateTime" ] }, "GetParticipantsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "responseList": { "description": "The following section is present only if Response code = 200. It is repeated as many times as the rows satisfying the request are.", "type": "array", "items": { "$ref": "#/components/schemas/ResponseList" } } }, "required": [ "dateTime" ] }, "IdOfUnavailableParty": { "type": "string", "pattern": "[A-Za-z0-9\\s\\\"\\#\\$\\%\\&\\'\\(\\)\\*\\+\\,\\-\\.\\/\\:\\;\\<\\=\\>\\?\\@\\\\\\_\\`\\{\\}\\~\\]]", "minLength": 0, "maxLength": 33, "examples": [ "ID of Unavailable Party as a free" ] }, "InquiryUnavailabilityRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria16" } }, "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" ] }, "InsertAPRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria14" } }, "required": [ "dateTime", "criteria" ] }, "InsertAPResponse": { "type": "object", "properties": { "dateTime": { "description": "Standard ISO Date-Time.", "$ref": "#/components/schemas/DateTime" }, "referenceId": { "$ref": "#/components/schemas/ReferenceId" } } }, "InstructionDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "instructions": { "$ref": "#/components/schemas/Instructions1" } }, "required": [ "dateTime" ] }, "InstructionIdentification": { "type": "string", "examples": [ "Original Liquidity Transfer reference in Credit/debit Notification (camt.054)" ] }, "Instructions": { "type": "object", "properties": { "type": { "description": "It indicates the type of instruction(Mandatory if this section is present). The possible values are:\n- CPFR - Checkpoint Funding Request\n- APFR - Adjustment Funding Request\n- CPFN - LAC Funding notification\n- CLRR - Checkpoint Release Request\n- ALRR - Adjustment Release Request\n- ELRR - Emergency Liquidity Request Release\n- EPFN - Emergency Funding", "$ref": "#/components/schemas/Type" }, "reference": { "description": "The reference associated to the instruction (Mandatory if this section is present)", "$ref": "#/components/schemas/Reference" }, "status": { "description": "The status of the instruction", "$ref": "#/components/schemas/Status" }, "date": { "description": "The date of the instruction", "$ref": "#/components/schemas/Date" }, "lac": { "description": "The number of the LAC", "$ref": "#/components/schemas/LacNumber" }, "amount": { "description": "The amount contained in the instruction", "$ref": "#/components/schemas/Amount" }, "debAccoOwnBic": { "description": "The Debtor Acconut Owner BIC of the instruction", "$ref": "#/components/schemas/Bic11Only" }, "credAccoOwnBic": { "description": "The Creditor Account Owner BIC of the instruction", "$ref": "#/components/schemas/Bic11Only" }, "participantToBeDebitedBic": { "description": "The BIC of the Participant whose liquidity is debited of the amount of the instruction", "$ref": "#/components/schemas/Bic8" }, "participantToBeCreditedBic": { "description": "The BIC of the Participant whose liquidity is credited of the amount of the instruction", "$ref": "#/components/schemas/Bic8" }, "time": { "description": "Time of the specific instruction", "$ref": "#/components/schemas/TimeDDTHH" } }, "required": [ "type", "reference", "status", "date", "lac", "amount", "debAccoOwnBic", "credAccoOwnBic", "time" ] }, "Instructions1": { "type": "object", "properties": { "lspbranchFundsBalanceMembBic": { "description": "This field correspond to:\n- the user’s Participant’s BIC\n- the LSPs linked to the user’s LP and that delegated their liquidity management to the user’s LP; or\n- the member of the Branch Funds Balance owned by the user’s LP.", "$ref": "#/components/schemas/Bic8" }, "instructionType": { "description": "It indicates the type of instruction (Mandatory if this section is present).\nThe possible values are:\n- CPFR - Checkpoint Funding Request\n- APFR - Adjustment Funding Request\n- CPFN - LAC Funding notification\n- CLRR - Checkpoint Release Request\n- ALRR - Adjustment Release Request\n- RVLT - Reversal", "$ref": "#/components/schemas/InstructionType" }, "liquidityMessId": { "description": "The Message ID of the original camt.050 or camt.054 in case of “LAC Funding notification”", "$ref": "#/components/schemas/MessageId" }, "liquidityInstractionId": { "description": "The univocal reference associated by the system to the instruction.\nRequest of Release: it corresponds to the Instruction ID of the relevant camt.050 message.\nRequest for Funding: it corresponds to:\n- Instruction ID of the relevant camt.050 message in case of CPFR and APFR;\n- Instruction ID of the relevant camt.054 message, in case of Funding notification received from TIPS during the LAC (CPFN).", "$ref": "#/components/schemas/MessageId" }, "status": { "description": "The status of the instruction (Mandatory if this section is present)\nPossible values are:\n- Waiting – when the Settlement Instruction is generated by the Sys-tem;\n- Settled – when the debit /credit notification has been received\n- Rejected – when the Liquidity Transfer Order is rejected by TIPS.", "$ref": "#/components/schemas/Status" }, "date": { "description": "The date of the instruction (Mandatory if this section is present)", "$ref": "#/components/schemas/Date" }, "lac": { "description": "The LAC in which the liquidity operation has been issued. (Mandatory if the section is present)", "$ref": "#/components/schemas/LacNumber" }, "amount": { "description": "The amount contained in the instruction. (Mandatory if this section is present).", "$ref": "#/components/schemas/Amount" }, "debtorAccountOwnerBic": { "description": "The BIC of the account owner to be debited. (Mandatory if this section is present).", "$ref": "#/components/schemas/Bic11Only" }, "creditorAccountOwnerBic": { "description": "Creditor Account Owner BIC to be credited. (Mandatory if this section is present).", "$ref": "#/components/schemas/Bic11Only" }, "participantToBeDebitedBic": { "description": "The BIC of the Participant whose liquidity is debited of the amount of the instruction.", "$ref": "#/components/schemas/Bic8" }, "participantToBeCreditedBic": { "description": "The BIC of the Participant whose liquidity is credited of the amount of the instruction.", "$ref": "#/components/schemas/Bic8" }, "accountToBeDebited": { "description": "Account to be Debited.", "$ref": "#/components/schemas/Account" }, "accountToBeCredited": { "description": "Account to be Credited.", "$ref": "#/components/schemas/Account" }, "bookingDataTime": { "description": "Timestamp of when the settlement occurred in TIPS.", "$ref": "#/components/schemas/DateTime" }, "rt1PositionUpdateDataTime": { "description": "Timestamp of when the RT1 Participant’s position has been updated.", "$ref": "#/components/schemas/DateTime" } }, "required": [ "lspbranchFundsBalanceMembBic", "instructionType", "liquidityMessId", "liquidityInstractionId", "status", "date", "lac", "amount", "debtorAccountOwnerBic", "creditorAccountOwnerBic" ] }, "InstructionType": { "type": "string", "enum": [ "CPFR", "APFR", "CPFN", "CLRR", "ALRR", "RVLT" ], "maxLength": 4, "examples": [ "CPFR" ] }, "InterestAmountsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria28" } }, "required": [ "dateTime", "criteria" ] }, "InterestAmountsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "bic": { "description": "The BIC of the GetInterestAmount", "$ref": "#/components/schemas/Bic8" }, "interestList": { "description": "The following section shall include a maximum of thirty-one occurrences and it is repeated as many times as the days of the required month for which interest has already been calculated by the System. In case no data are retrieved the following section is omitted.", "type": "array", "items": { "$ref": "#/components/schemas/InterestList" } } }, "required": [ "dateTime", "bic", "interestList" ] }, "InterestList": { "type": "object", "properties": { "date": { "description": "The retrieved date for the selected month.", "$ref": "#/components/schemas/Date" }, "interestRate": { "description": "The deposit facility rate used for calculate daily interests.", "$ref": "#/components/schemas/Amount" }, "snapshotTime": { "description": "The time to which the Participant’s Position has been retrieved.", "$ref": "#/components/schemas/Time" }, "eodPosition": { "description": "The Participant’s Position retrieved at the Snapshot Time.", "$ref": "#/components/schemas/Amount" }, "dailyInterestAmount": { "description": "The Interest Amount calculated by the System for the impacted “date”", "$ref": "#/components/schemas/Amount" } }, "required": [ "date", "interestRate", "snapshotTime", "eodPosition", "dailyInterestAmount" ] }, "IntraserviceLtoType": { "type": "string", "enum": [ "FUN", "DEF" ], "examples": [ "FUN" ] }, "InvestigationData": { "type": "object", "properties": { "numSentInvestigation": { "description": "The number of Investigation messages that were sent from the SenderBic", "$ref": "#/components/schemas/NumSentInvestigation" }, "numReceivedInvestigation": { "description": "The number of Investigation messages that were received from the SenderBic", "$ref": "#/components/schemas/NumReceivedInvestigation" } } }, "IpData": { "type": "object", "properties": { "numSentIP": { "description": "It is the sum of the following fields:\nNumRjtIP,\nNumHeldIP ,\nNumSettledIP.", "$ref": "#/components/schemas/NumSentIP" }, "numRjtIP": { "description": "The number of IP received from the SenderBic that were rejected by SCT Inst or BB", "$ref": "#/components/schemas/NumRjtIP" }, "numSettledIP": { "description": "The number of IPs that were received from the SenderBic and positively processed.", "$ref": "#/components/schemas/NumSettledIP" }, "amountSentIP": { "description": "It is the sum of the following fields:\nAmountRjtIP\nAmountHeldIP\nAmountSettledIP.", "$ref": "#/components/schemas/Amount" }, "amountRjtIP": { "description": "The sum of the values of the IP transactions included in the NumRjtIP", "$ref": "#/components/schemas/Amount" }, "amountSettledIP": { "description": "The sum of the values of the IP transactions included in the NumSettledIP field", "$ref": "#/components/schemas/Amount" } } }, "IpData1": { "type": "object", "properties": { "numSentIP": { "description": "It is the sum of the following fields:\nNumRjtIP,\nNumSettledIP.", "$ref": "#/components/schemas/NumSentIP" }, "numRjtIP": { "description": "The number of IP that were received from the SenderBic and rejected by SCT Inst or BB", "$ref": "#/components/schemas/NumRjtIP" }, "numSettledIP": { "description": "The number of IP that were received from the SenderBic and positively processed.", "$ref": "#/components/schemas/NumSettledIP" }, "amountSentIP": { "description": "It is the sum of the following fields:\nAmountRjtIP\nAmountSettledIP.", "$ref": "#/components/schemas/Amount" }, "amountRjtIP": { "description": "The sum of the values of the IP transactions included in the NumRjtIP", "$ref": "#/components/schemas/Amount" }, "amountSettledIP": { "description": "The sum of the values of the IP transactions included in the NumSettledIP", "$ref": "#/components/schemas/Amount" } } }, "IpDataDRR": { "type": "object", "properties": { "amountHeldIP": { "description": "The sum of the values of the IP transactions included in the NumHeldIP field", "$ref": "#/components/schemas/Amount" }, "numHeldIP": { "$ref": "#/components/schemas/NumHeldIP" }, "ipData": { "$ref": "#/components/schemas/IpData" } } }, "IpStatus": { "type": "string", "enum": [ "PBB", "RBB", "RBE", "PBE", "RBC", "PEN", "WTG" ], "examples": [ "PBB" ] }, "IpStatus1": { "type": "string", "maxLength": 3, "examples": [ "PBB" ] }, "IsReceptionDate": { "description": "Defines the search date criterion between acceptance date and reception date.", "type": "string", "enum": [ "0", "1" ], "minLength": 1, "maxLength": 1, "examples": [ "0" ] }, "Lac": { "type": "string", "examples": [ "01" ] }, "LacAmount": { "type": "number", "maximum": 1000000000000000, "examples": [ 30004958.23 ] }, "LacNumber": { "type": "string", "pattern": "[0-9]", "minLength": 1, "maxLength": 2, "examples": [ "1" ] }, "LacParameters": { "type": "object", "properties": { "lac": { "description": "The relevant liquidity adjustment checkpoint to which the timings above applies.", "$ref": "#/components/schemas/Lac" }, "lacSendingCutOffTime": { "description": "Identifies the end time of a LAC, the SCT Inst CS will:\n▪ perform liquidity adjustment;\n▪ generate PSR files.", "$ref": "#/components/schemas/LacSendingCutOffTime" }, "lacAdjustmentTime": { "description": "Identifies the time on which:\n▪ the RSF output files are generated and sent to Participants.", "$ref": "#/components/schemas/LacSettlementTime" } }, "required": [ "lac", "lacSendingCutOffTime", "lacAdjustmentTime" ] }, "LacSendingCutOffTime": { "type": "string", "examples": [ "10:00" ] }, "LacSettlementTime": { "type": "string", "examples": [ "16:00:00" ] }, "LiquidityAutomaticAdjustment": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "LiquidityManagement": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "LiquidityManagement1": { "type": "string", "enum": [ "0", "1" ], "maxLength": 1, "examples": [ "0" ] }, "LiquidityOperation": { "type": "string", "enum": [ "REL", "PFU" ], "maxLength": 3, "examples": [ "REL" ] }, "LiquidityTransferInfo": { "type": "object", "properties": { "lenderBic": { "description": "The BIC of the Participant whose Position is decreased of the transferred amount\n\n **Validation Rule(s)** It must belong to the specified branchFundsBalanceId and must not be suspended (ErrorCode XA06)", "$ref": "#/components/schemas/Bic8" }, "receiverBic": { "description": "The BIC of the Participant whose Position is increased of the transferred amount\n\n **Validation Rule(s)** It must belong to the specified branchFundsBalanceId and must not be suspended (ErrorCode XA06)", "$ref": "#/components/schemas/Bic8" }, "branchFundsBalanceId": { "description": "The id of the branchFundsBalance to which the Sender and Receiver BICs belong", "$ref": "#/components/schemas/BranchFundsBalanceId" }, "amount": { "description": "The amount to be transferred\n\n **Validation Rule(s)** • The Position of the LenderBic in the system (when request is processed) must be greater than the Amount\n• The Amount cannot be greater than 999999999999.99\n(ErrorCode XA05)\nOnly decimal notation is allowed (XA05).", "$ref": "#/components/schemas/Amount" } }, "required": [ "lenderBic", "receiverBic", "branchFundsBalanceId", "amount" ] }, "LiquidityTransferRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "liquidityTransferInfo": { "$ref": "#/components/schemas/LiquidityTransferInfo" } }, "required": [ "dateTime", "liquidityTransferInfo" ] }, "LiquidityTransferResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" } }, "required": [ "dateTime" ] }, "LiquiTransfId": { "type": "string", "maxLength": 35, "examples": [ "INSTRID" ] }, "List": { "type": "object", "properties": { "senderBIC": { "description": "BIC of the sender of admi.004, first parameter into EvtParams in admi.004.", "$ref": "#/components/schemas/Bic11" }, "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" }, "status": { "description": "It can be:\n- 0 (unavailable)\n- 1 (available)", "$ref": "#/components/schemas/Status6" }, "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/EventDescription1" }, "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" }, "productsUnavailable": { "description": "List of Product(s) impacted by the unavailability\nIf all products are unavailable, the list must include all configured products for the unavailableBic", "$ref": "#/components/schemas/ProductsUnavailable" }, "apspsUnavailability": { "description": "This flag allow Participant to communicate the unavailability for itself and for all its APSPs\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 APSP(s)", "$ref": "#/components/schemas/ApspsUnavailability" } }, "required": [ "senderBIC", "status", "startDateTime", "endDateTime", "durationOfUnavailability", "generationDateTime" ] }, "ListAAURT1ASTARequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "description": "The following section is repeated as many times as the rows satisfying the request are", "$ref": "#/components/schemas/Criteria19" } }, "required": [ "dateTime", "criteria" ] }, "ListAAURT1ASTAResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "aauList": { "description": "The following section is repeated as many times as the rows satisfying the request are", "$ref": "#/components/schemas/AauList" } }, "required": [ "dateTime", "aauList" ] }, "ListAlertsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation\n\n **Validation Rule(s)** XA20: it must be equal to the allowed format\nDT01: it must be equal to the current or a future date", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria27" }, "offset": { "description": "The offset points to a set of records\n\n **Validation Rule(s)** It must correspond to the value provided in the previous listAlerts - Positive Response", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "criteria" ] }, "ListAlertsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "numAlerts": { "description": "The total number of the alerts in the following section. The returned alerts are the ones that satisfy the searching criteria of the Request, and that the system generated for the SenderBic only.", "$ref": "#/components/schemas/NumAlerts" }, "alertList": { "description": "The following section is repeated as many times as the rows satisfying the request are.", "type": "array", "items": { "$ref": "#/components/schemas/AlertList" } }, "endOfList": { "description": "Flag field used to inform if the last element (record) of the list has been reached:\n1=YES the record list is completed\n0=NO the record list is partial", "$ref": "#/components/schemas/EndOfList" }, "offset": { "description": "The offset points to a set of records. It is provided only if the endOfList is set to \"NO\". It must be used in the request to retrieve the next portion of records (when the endOfList is false).", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "numAlerts", "endOfList" ] }, "ListAPsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria11" } }, "required": [ "dateTime" ] }, "ListAPsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "apList": { "type": "array", "items": { "$ref": "#/components/schemas/ApList" } } } }, "ListBeneficiary": { "type": "object", "properties": { "beneficiaryBic": { "description": "The BIC configured for the Beneficiary", "$ref": "#/components/schemas/Bic11Only" }, "beneficiaryName": { "description": "The Beneficiary Name", "$ref": "#/components/schemas/BeneficiaryName" }, "beneficiaryAccount": { "description": "The Beneficiary Account", "$ref": "#/components/schemas/BeneficiaryAccount" } }, "required": [ "beneficiaryBic", "beneficiaryName", "beneficiaryAccount" ] }, "ListBeneficiaryRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria7" }, "offset": { "description": "The offset points to a set of records\n\n **Validation Rule(s)** It must correspond to the value provided in the previous listBeneficiary - Positive Response", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "criteria" ] }, "ListBeneficiaryResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "listBeneficiary": { "description": "The following section is repeated as many times as the rows satisfying the request are.", "type": "array", "items": { "$ref": "#/components/schemas/ListBeneficiary" } }, "endOfList": { "description": "Flag field used to inform if the last element (record) of the list has been reached:\n1=YES the record list is completed\n0=NO the record list is partial", "$ref": "#/components/schemas/EndOfList" }, "offset": { "description": "The offset points to a set of records. It must be used in the request to retrieve the next portion of records (when the endOfList is false)", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "endOfList" ] }, "ListCommandStatusRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria26" }, "offset": { "description": "The offset points to a set of records\n\n **Validation Rule(s)** It must correspond to the value provided in the previous listCommandStatus - Positive Response", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "criteria" ] }, "ListCommandStatusResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "commandList": { "type": "array", "items": { "$ref": "#/components/schemas/CommandList" } }, "endOfList": { "description": "Flag field used to inform if the last element (record) of the list has been reached:\n1=YES the record list is completed\n0=NO the record list is partial", "$ref": "#/components/schemas/EndOfList" }, "offset": { "description": "The offset points to a set of records. It must be used in the request to retrieve the next portion of records (when the endOfList is false)", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "endOfList" ] }, "ListCurrencies": { "type": "object", "properties": { "currencyCode": { "description": "The code of the currency", "$ref": "#/components/schemas/CurrencyCode" }, "currencyName": { "description": "The name of the currency", "$ref": "#/components/schemas/CurrencyName" }, "maxAmountAllowed": { "description": "Maximum amount allowed for the currency", "$ref": "#/components/schemas/MaxAmountAllowed" }, "currencyTimestamp": { "description": "Date and time when the currency was inserted", "$ref": "#/components/schemas/CurrencyTimestamp" } }, "required": [ "currencyCode", "currencyName", "currencyTimestamp" ] }, "ListCurrenciesRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" } }, "required": [ "dateTime" ] }, "ListCurrenciesResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "listCurrencies": { "description": "The following section is repeated as many times as the rows satisfying the request are", "type": "array", "items": { "$ref": "#/components/schemas/ListCurrencies" } } }, "required": [ "dateTime" ] }, "ListDRRData": { "type": "object", "properties": { "recordType": { "description": "The fixed record type value “HDRR” (only for “DRR” FileType) or “HMSR” (only for “MSR” FileType) (Mandatory if the section is present)", "$ref": "#/components/schemas/RecordType" }, "ipDataDRR": { "$ref": "#/components/schemas/IpDataDRR" }, "prrDataDRR": { "$ref": "#/components/schemas/PrrDataDRR" }, "nrrData": { "$ref": "#/components/schemas/NrrData" }, "recallData": { "$ref": "#/components/schemas/RecallData" }, "investigationData": { "$ref": "#/components/schemas/InvestigationData" }, "updatedData": { "$ref": "#/components/schemas/UpdatedData" } }, "required": [ "recordType" ] }, "ListFiles": { "type": "object", "properties": { "fileDetails": { "$ref": "#/components/schemas/FileDetails" }, "fileStatus": { "description": "The status of the file (Mandatory if the section is present)", "$ref": "#/components/schemas/FileStatus" }, "netFileName": { "description": "The network file name of the file (Mandatory if the section is present)", "$ref": "#/components/schemas/NetFileName" }, "network": { "description": "The network used for the reception/sending of the file, it can contain only:\n- “EAS” for SIANet\n- “EBX” for EBICS\n- “SWF” for SWIFTNet RT single request type\n- “SWA” for SWIFTNet RT multiple request type\n- “SWS” for SWIFTNet SF single request type\n- “SWM” for SWIFTNet SF multiple request type", "$ref": "#/components/schemas/Network1" } }, "required": [ "fileStatus", "netFileName" ] }, "ListFilesRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria24" }, "offset": { "description": "The offset points to a set of records\n\n **Validation Rule(s)** It must correspond to the value provided in the previous listFiles - Positive Response", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "criteria" ] }, "ListFilesResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "numFiles": { "description": "The total number of files listed in the following section", "$ref": "#/components/schemas/NumFiles" }, "listFiles": { "description": "The following section is repeated as many times as the rows satisfying the request are", "type": "array", "items": { "$ref": "#/components/schemas/ListFiles" } }, "endOfList": { "description": "Flag field used to inform if the last element (record) of the list has been reached:\n1=YES the record list is completed\n0=NO the record list is partial", "$ref": "#/components/schemas/EndOfList" }, "offset": { "description": "The offset points to a set of records. It must be used in the request to retrieve the next portion of records (when the endOfList is false)", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "numFiles", "endOfList" ] }, "ListInstructionsFundingDefundingTIPSRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria2" }, "offset": { "description": "The offset points to a set of records\n\n **Validation Rule(s)** It must correspond to the value provided in the previous listFiles - Positive Response", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "criteria" ] }, "ListInstructionsFundingDefundingTIPSResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "response": { "$ref": "#/components/schemas/Response1" }, "endOfList": { "description": "Flag field used to inform if the last element (record) of the list has been reached:\n1=YES the record list is completed\n0=NO the record list is partial", "$ref": "#/components/schemas/EndOfList" }, "offset": { "description": "The offset points to a set of records. It must be used in the request to retrieve the next portion of records (when the endOfList is false)", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "endOfList" ] }, "ListLACsConfigurationRequest": { "type": "object", "properties": { "dateTime": { "description": "Standard ISO Date-Time.\nThe date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "defaultValues": { "description": "The flag used to show:\n1=YES display the default parameters\n0=NO display the parameters after any authorized overrides\nIf the field is not set, current parameters are retrieved", "$ref": "#/components/schemas/DefaultValues" } }, "required": [ "dateTime" ] }, "ListLACsConfigurationResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "lacParameters": { "description": "It is repeated as many times as the rows satisfying the request are.", "type": "array", "items": { "$ref": "#/components/schemas/LacParameters" } }, "otherSystemCutOff": { "$ref": "#/components/schemas/OtherSystemCutOff" } }, "required": [ "dateTime", "lacParameters", "otherSystemCutOff" ] }, "ListMessageRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria3" }, "offset": { "description": "The offset points to a set of records", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "criteria" ] }, "ListMessageResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "listMessages": { "description": "The following section is present only if Response code = 200. It is repeated as many times as the rows satisfying the request are.", "type": "array", "items": { "$ref": "#/components/schemas/ListMessages" } }, "endOfList": { "description": "Flag field used to inform if the last element (record) of the list has been reached:\n1= YES the record list is completed\n0= NO the record list is partial", "$ref": "#/components/schemas/EndOfList" }, "offset": { "description": "The offset points to a set of records. It must be used in the request to retrieve the next portion of records (when the endOfList is false)", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "endOfList" ] }, "ListMessages": { "type": "object", "properties": { "messageType": { "description": "Identification of the message sent by Participant\nPossible values are:\n• Outbound LTO (camt.050)\n• Funding/Defunding LTO (camt.050)\n• Credit/Debit Notification (camt.054)\n• Receipt (camt.025)\n• Get Account (camt.003)\n• Return Account (camt.004)\n• Payment status Query (camt.005)\n• Payment Status Query Response (camt.006)\n• Claim non-receipt (camt.027)\n\nAll Camt.003/004 RT1-destined messages are excluded from the result", "$ref": "#/components/schemas/MessageType" }, "senderReceiverBic": { "description": "Sender BIC of the message", "$ref": "#/components/schemas/Bic8" }, "messageId": { "description": "Message Identifier", "$ref": "#/components/schemas/MessageId" }, "accountNumber": { "description": "Field not available for camt.005 and camt.006", "$ref": "#/components/schemas/Account" }, "processingDtTm": { "description": "The processing date and time of the message", "$ref": "#/components/schemas/DateTime" }, "messageStatus": { "description": "The message status.\nAvailable values:\n• TSD: Transmitted (all messages)\n• NTF: Notified (all messages)\n• STD: Settled (camt.050)\n• RJS: Rejected (camt.050 – camt.003 – camt.004 – camt.005 – camt.006)\n• ERR: Error (camt.025 – camt.054).", "$ref": "#/components/schemas/Status1" }, "debAccOwnBic": { "description": "The BIC11 of the owner of the debit-ed TIPS Account.\nThis field is present if message type is Camt.050 and camt.054 messages", "$ref": "#/components/schemas/Bic11Only" }, "creAccOwnBic": { "description": "The BIC11 of the owner of the debit-ed TIPS Account.\nThis field is present if message type is Camt.050 and camt.054 messages", "$ref": "#/components/schemas/Bic11Only" }, "ltoType": { "description": "This field is present if message type are Receipt (camt.025)", "$ref": "#/components/schemas/IntraserviceLtoType" }, "settlDate": { "description": "The settlement Date of the credit transfer.\nThis field is present if message type is Return Account (camt.004)", "$ref": "#/components/schemas/Date" }, "amount": { "description": "The Amount in the message.\nField available for camt.050, camt.054 and camt.004", "$ref": "#/components/schemas/Amount2" }, "origMessId": { "description": "The original message identifier.\nThis field is present if message type are Receipt (camt.025)", "$ref": "#/components/schemas/MessageId" }, "ltoTipsStatus": { "description": "The message status of the outbound liquidity transfer order as processed by TIPS:\n• RREJ (rejected by T2)\n• RCON (confirmation by T2)\n• RJCS (any other value)\nThis field is present if message type is Receipt (camt.025)", "$ref": "#/components/schemas/LtoTipsStatus" }, "accOrCmbId": { "description": "The identifier of the account or CMB.\nThis field is present if message type isGet Account (camt.003)", "$ref": "#/components/schemas/Account" }, "accOrCmbUser": { "description": "The BIC of the user of the Account or CMB.\nThis field is present if message type isGet Account (camt.003)", "$ref": "#/components/schemas/Account" }, "tipsTimestampRetrieval": { "description": "TIPS Timestamp retrieval,available if message type is Return Account (camt.004)", "$ref": "#/components/schemas/DateTime" }, "businessError": { "description": "Business Error, available if message type is Return Account (camt.004)", "$ref": "#/components/schemas/ErrorCode" }, "returnAcctTp": { "description": "TIPS Account ID, available if message type is Return Account (camt.004)", "$ref": "#/components/schemas/ReturnAcctTp" }, "originalTransactionId": { "description": "Original Transaction ID, available if message type is Payment Status Query (camt.005)", "$ref": "#/components/schemas/OriginalTransactionId" }, "originalMessageType": { "description": "Original Message Type, available if message type is Payment Status Query (camt.005)", "$ref": "#/components/schemas/OriginalMessageType" }, "messageTypeCamt005": { "description": "Indicates the type of the original message.\nThis field is enabled if the message type is Payment Status Query (camt.005)", "$ref": "#/components/schemas/MessageTypeCamt005" }, "paymentStatus": { "description": "The Paymenyt Status, available if message type is Payment Status Query Response (camt.006).\nPossible values:\n• Pending (PSTL)\n• Settled (STLD)\n• Cancelled (CAND)\n• Expired (FNLD)\n• Rejected (RJTD)\n• Failed (FAIL)", "$ref": "#/components/schemas/PaymentStatus" } }, "required": [ "messageType", "senderReceiverBic", "messageId", "processingDtTm", "messageStatus" ] }, "ListMSRData": { "type": "object", "properties": { "recordType": { "description": "The fixed record type value “HDRR” (only for “DRR” FileType) or “HMSR” (only for “MSR” FileType) (Mandatory if the section is present)", "$ref": "#/components/schemas/RecordType" }, "ipData": { "$ref": "#/components/schemas/IpData1" }, "prrData": { "$ref": "#/components/schemas/PrrData1" }, "nrrData": { "$ref": "#/components/schemas/NrrData" }, "recallData": { "$ref": "#/components/schemas/RecallData1" } }, "required": [ "recordType" ] }, "ListParticipantOperationRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria17" }, "offset": { "description": "The offset points to a set of records\n\n **Validation Rule(s)** It must correspond to the value provided in the previous listParticipantOperation - Positive Response", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime" ] }, "ListParticipantOperationResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API response creation", "$ref": "#/components/schemas/DateTime" }, "numRecordFound": { "description": "Number of items found", "$ref": "#/components/schemas/NumRecordFound" }, "responseList": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseList1" } }, "endOfList": { "description": "Flag field used to inform if the last element (record) of the list has been reached:\n1=YES the record list is completed\n0=NO the record list is partial", "$ref": "#/components/schemas/EndOfList" }, "offset": { "description": "The offset points to a set of records. It must be used in the request to retrieve the next portion of records (when the endOfList is false)", "$ref": "#/components/schemas/Offset" } }, "required": [ "endOfList" ] }, "ListPayment": { "type": "object", "properties": { "paymentDetails": { "$ref": "#/components/schemas/PaymentDetails1" } } }, "ListPaymentsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation d ISO Date-Time.", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria20" }, "offset": { "description": "The offset points to a set of records\n\n **Validation Rule(s)** It must correspond to the value provided in the previous listPayments - Positive Response", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "criteria" ] }, "ListPaymentsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "numPayments": { "description": "The number of the Payment transactions returned", "$ref": "#/components/schemas/NumPayments" }, "listPayment": { "description": "The following section is repeated as many times as the rows satisfying the request are.", "type": "array", "items": { "$ref": "#/components/schemas/ListPayment" } }, "endOfList": { "description": "Flag field used to inform if the last element (record) of the list has been reached:\n1=YES the record list is completed\n0=NO the record list is partial", "$ref": "#/components/schemas/EndOfList" }, "offset": { "description": "The offset points to a set of records. It must be used in the request to retrieve the next portion of records (when the endOfList is false)", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "endOfList" ] }, "ListThrottlingParametersRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime1" } }, "required": [ "dateTime" ] }, "ListThrottlingParametersResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime1" }, "timeDetails": { "$ref": "#/components/schemas/TimeDetails" }, "responseList": { "description": "The following section is present only if Response code = 200. It is repeated as many times as the rows satisfying the request are.", "$ref": "#/components/schemas/ResponseList2" } }, "required": [ "dateTime", "timeDetails" ] }, "ListTransactions": { "type": "object", "properties": { "csm": { "description": "The Clearing and Settlement Mechanism by which transactions were processed.\nPossible values:\nRT1: Transaction Settled in RT1;\nRT1-TIPS: Transaction settled in TIPS though RT1 Techenical Account;\nTIPS: Transaction settled in TIPS on DCA account", "$ref": "#/components/schemas/Csm1" }, "transactionDetails": { "$ref": "#/components/schemas/TransactionDetails1" }, "instructingBic": { "description": "The instructing agent of the transaction", "$ref": "#/components/schemas/Bic8" }, "instructedBic": { "description": "The BIC of the instructed agent of the transaction or the BIC of the Central System if the transaction was rejected by RT1 without completion of the Routing process", "$ref": "#/components/schemas/Bic8" }, "credSettMethod": { "description": "The Settlement Method of the creditor agent.\nPossible values are:\n• “LQPS” (LiQuidity PoSition) – Clearing intra-RT1 and, if required, set-tlement with liquidity position;\n• “RT1A” (RT1 technical Account) – Clearing cross-systems (e.g. RT1-TIPS) and settlement with RT1 AS Technical Account;\n• TDCA (TIPS DCA) – Clearing cross-systems (e.g. RT1-TIPS) and, if required, settlement with TIPS DCA.", "$ref": "#/components/schemas/CredSettMethod1" }, "debSettMethod": { "description": "The Settlement Method of the debtor agent.\nPossible values are:\n• “LQPS” (LiQuidity PoSition) – Clearing intra-RT1 and, if required, set-tlement with liquidity position;\n• “RT1A” (RT1 technical Account) – Clearing cross-systems (e.g. RT1-TIPS) and settlement with RT1 AS Technical Account;\n• TDCA (TIPS DCA) – Clearing cross-systems (e.g. RT1-TIPS) and, if required, settlement with TIPS DCA.", "$ref": "#/components/schemas/DebSettMethod1" }, "amount": { "description": "The amount of the transaction.", "$ref": "#/components/schemas/Amount" }, "lac": { "description": "The LAC of the reception and processing of the transaction (Mandatory if the section is present)", "$ref": "#/components/schemas/LacNumber" }, "processingDate": { "description": "The processing date of the transaction (Mandatory if the section is present)", "$ref": "#/components/schemas/Date" }, "receptionTime": { "description": "The timestamp when the transaction was received by SCT Inst Service from the Instructing Agent.", "$ref": "#/components/schemas/ZonedDateTime" }, "transactionStatus": { "description": "The status of the transaction (Mandatory if the section is present).\nAvailable values:\n- “PBB” Processed by the Beneficiary Bank\n- “RBB” Rejected by the Beneficiary Bank\n- “RBE” Rejected by EBA\n- “PBE” Processed by EBA\n- “RBC” Rejected by SCT Inst\n- “PEN” Pending\n- “STD” Settled\n- “RJS” Rejectd\n- “NTF” notified\n- “VAL” validated\n- \"WTG\" Waiting (only retrieve in-flight non-time critical transactions)", "$ref": "#/components/schemas/TransactionStatus" }, "reasonCode": { "description": "The reason code of the transaction.", "$ref": "#/components/schemas/ReasonCode" }, "reasonCodeToOB": { "description": "The reason code generated by the System and forwarded to the OB in pacs.002 message.", "$ref": "#/components/schemas/ReasonCodeToOB" }, "reasonCodeToBB": { "description": "The reason code generated by the System and forwarded to the BB in pacs.002 message", "$ref": "#/components/schemas/ReasonCodeToBB" }, "originalEndToEndID": { "description": "The original End to End Id (Mandatory if the section is present).", "$ref": "#/components/schemas/OriginalEndToEndID" }, "productId": { "description": "Product of the transaction (Mandatory if the section is present)", "$ref": "#/components/schemas/Product" } }, "required": [ "csm", "transactionStatus", "originalEndToEndID", "productId" ] }, "ListTransactionsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria22" }, "offset": { "description": "The offset points to a set of records\n\n **Validation Rule(s)** It must correspond to the value provided in the previous listFiles - Positive Response", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "criteria" ] }, "ListTransactionsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "numTransactions": { "description": "The total number of transactions listed in the following section", "$ref": "#/components/schemas/NumTransactions" }, "listTransactions": { "description": "The following section is repeated as many times as the rows satisfying the request are.", "type": "array", "items": { "$ref": "#/components/schemas/ListTransactions" } }, "endOfList": { "description": "Flag field used to inform if the last element (record) of the list has been reached:\n1=YES the record list is completed\n0=NO the record list is partial", "$ref": "#/components/schemas/EndOfList" }, "offset": { "description": "The offset points to a set of records. It must be used in the request to retrieve the next portion of records (when the endOfList is false)", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "numTransactions", "endOfList" ] }, "LSP": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "Lsp": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "LspBicDefaultDayValues": { "type": "object", "properties": { "day": { "description": "The Day of the week to which the LSPDefaultDayValues section is referred (Mandatory if this section is present)\nThe value must be between 1 and 7 (schema validation)\n1 – Monday,\n2- Tuesday,\n3 – Wednesday,\n4 – Thursday,\n5 – Friday,\n6- Saturday,\n7- Sunday", "$ref": "#/components/schemas/Day" }, "defaultLACValues": { "description": "The following section is repeated as many times as the LACs are", "type": "array", "items": { "$ref": "#/components/schemas/DefaultLACValues1" } } }, "required": [ "day", "defaultLACValues" ] }, "LspsPosition": { "type": "object", "properties": { "bic": { "description": "LSP BIC. Mandatory if the section is present\nThe BIC of an LSP whose Liquidity Position is managed by the SenderBic (Mandatory only if this section is present)", "$ref": "#/components/schemas/Bic8" }, "sign": { "description": "Mandatory if the section is present\nThe sign of the position of the LSPBic. It contains “C” for Credit Amount or “D” for Debit Amount (Mandatory only if this section is present)", "$ref": "#/components/schemas/Sign" }, "amount": { "description": "Mandatory if the section is present\nThe Amount corresponding to the real time Position of the LSPBic at the time of the query (Mandatory only if this section is present)", "$ref": "#/components/schemas/Amount" }, "timestamp": { "description": "Mandatory if the section is present\nTimeStamp of the instant in which the system reads the Position of the LSPBic", "$ref": "#/components/schemas/DateTime" } }, "required": [ "bic", "sign", "amount", "timestamp" ] }, "LtoTipsStatus": { "type": "string", "enum": [ "RREJ", "RCON", "RJCS" ], "examples": [ "RREJ" ] }, "LtoTipsStatus1": { "type": "string", "maxLength": 4, "examples": [ "RREJ" ] }, "ManageAAURT1ASTARequest": { "type": "object", "properties": { "dateTime": { "description": "Standard ISO Date-Time.", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria18" } }, "required": [ "dateTime", "criteria" ] }, "ManageAAURT1ASTAResponse": { "type": "object", "properties": { "dateTime": { "description": "Standard ISO Date-Time.", "$ref": "#/components/schemas/DateTime" }, "referenceId": { "description": "The reference ID of the generated command.\nThis field is present only in case the command has been correctly submitted.", "$ref": "#/components/schemas/ReferenceId" } } }, "MassiveInsertDetails": { "type": "object", "properties": { "name": { "description": "The name of the AP related to the operation.", "$ref": "#/components/schemas/Name" }, "bicCode": { "description": "The Participant BIC related to the MIN", "$ref": "#/components/schemas/Bic11" }, "dpBic": { "description": "The Participant BIC related to the AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Bic11" }, "admissionProfile": { "description": "The admission profile (Mandatory if the section is present). Possible values of the first part are:\n“CAD” - for a Participant or Addressable PSP that acts as both Creditor and Debtor Bank\n“CRD” - for a Participant or Addressable PSP that only acts as a Creditor only Bank\nFollowed by “-“ and the Product", "$ref": "#/components/schemas/AdmissionProfileList" }, "submittedAOSinst": { "description": "The AOS subscribed by the DP for INST Product: the content of this field will replace the AOS saved in the system master data. It can contain only a set of strings accepted by the system, (ErrorCode XA03)", "$ref": "#/components/schemas/AOSList" }, "submittedAOSeolo": { "description": "The AOS subscribed by the DP for EOLO Product: the content of this field will replace the AOS saved in the system master data. It can contain only a set of strings accepted by the system, (ErrorCode XA03)", "$ref": "#/components/schemas/AOSList" }, "initValidity": { "description": "The initial date of validity of the configured AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Date" }, "endValidity": { "description": "The end date of validity of the configured AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Date" }, "productId": { "description": "It indicates the product type", "$ref": "#/components/schemas/ProductIds" }, "bbPositiveCnf": { "description": "It indicates if the Participant asked for confirmation of the credited payment amount (Mandatory if the section is present)", "$ref": "#/components/schemas/BbPositiveCnf1" }, "tipsUserBic": { "description": "BIC used for reachability in TIPS through a DCA account", "$ref": "#/components/schemas/TipsUserBic" } }, "required": [ "bicCode", "name", "dpBic", "admissionProfile", "submittedAOSinst", "submittedAOSeolo", "initValidity", "endValidity", "productId", "bbPositiveCnf", "tipsUserBic" ] }, "MaxAmountAllowed": { "type": "number", "format": "double", "examples": [ 3456 ] }, "MaxFileSize": { "type": "integer", "examples": [ 245000000 ] }, "MaxFileSize1": { "type": "number", "maximum": 10, "examples": [ 1 ] }, "MemberDefaultDayValues": { "type": "object", "properties": { "day": { "description": "The Day of the week to which the values per LAC in the following section is referred (Mandatory if this section is present).\nThe value must be between 1 and 7 (schema validation)\n1 – Monday,\n2- Tuesday,\n3 – Wednesday,\n4 – Thursday,\n5 – Friday,\n6- Saturday,\n7- Sunday", "$ref": "#/components/schemas/Day" }, "defaultLACValues": { "description": "The following section is repeated as many times as the LACs are.", "type": "array", "items": { "$ref": "#/components/schemas/DefaultLACValues1" } } }, "required": [ "day", "defaultLACValues" ] }, "MemberExceptionDayValues": { "type": "object", "properties": { "lac": { "description": "The LAC number of the BusinessDate contained in the request (Mandatory if this section is present)", "$ref": "#/components/schemas/LacNumber" }, "base": { "description": "The base value amount set in the system for the MemberBic (Mandatory if this section is present)", "$ref": "#/components/schemas/LacAmount" }, "lower": { "description": "The minimum value amount set in the system for the MemberBic (Mandatory if this section is present)", "$ref": "#/components/schemas/LacAmount" }, "upper": { "description": "The maximum value amount set in the system for the MemberBic (Mandatory if this section is present)", "$ref": "#/components/schemas/LacAmount" }, "resetToBasePosition": { "description": "Whether the “Reset to Base Position” flag for the relevant LAC is checked/unchecked. The field is present only when set to 1=YES", "$ref": "#/components/schemas/ResetToBasePosition" }, "sendAccountQueryToTips": { "description": "Whether the “Send Account Query to TIPS” flag for the relevant LAC is checked/unchecked.\nThe field is present only when set to: 1=YES", "$ref": "#/components/schemas/SendAccountQueryToTips" } }, "required": [ "lac", "base", "lower", "upper" ] }, "MessageDetails": { "type": "object", "properties": { "messageType": { "description": "Identification of the message sent by Participant\nPossible values are:\n• Outbound LTO (camt.050)\n• Funding/Defunding LTO (camt.050)\n• Receipt (camt.025)\n• Get Account (camt.003)\n• Return Account (camt.004)\n• Payment Status Query (camt.005)\n• Payment Status Query Response (camt.006)", "$ref": "#/components/schemas/MessageType1" }, "camt050ReFromPartDtTm": { "description": "Date and Time indicating when the Participant transmitted the LTO via message interface to RT1", "$ref": "#/components/schemas/DateTime" }, "transmStatusTransDtTm": { "description": "Date and Time indicating when the LTO, Receipt,Credit/Debit Notiification, Get Qccount Message, Return Account, Payment Status Query and Payment Status Query Response has been transmitted/received to/from Participant or TIPS. Only available in case the original camt.050 or camt.003 was transmitted via message interface.", "$ref": "#/components/schemas/DateTime" }, "errStatusTransDtTm": { "description": "Date and Time indicating when RT1 received the NACK signal from TIPS/Participant.\nOnly available in case the original camt.050 or camt.003 was transmitted via message interface.", "$ref": "#/components/schemas/DateTime" }, "notStatusTransDtTm": { "description": "Indicates the date and time when the ACK signal has been received from the network/Participant. Only available in case the original camt.050 or camt.003 was transmitted via message interface.", "$ref": "#/components/schemas/DateTime" }, "rejStatusTransDtTm": { "description": "Date and Time indicating when the LTO has been rejected by RT1 or by TIPS and Date and Time indicating when RT1 CS negatively processes the Receipt, Credit/Debit Notification, Return Account, Payment Status Query or Payment Status Query Response.", "$ref": "#/components/schemas/DateTime" }, "senderBic": { "description": "Sender BIC of the message.\nThe field field is present if message type is LTO (camt.050) ,Credit/Debit Notification (camt.054) ,Get Account message( camt.003), Payment Status Query (camt.005) or Payment Status Query Response (camt.006)", "$ref": "#/components/schemas/Bic8" }, "messageId": { "description": "Identification of the message", "$ref": "#/components/schemas/MessageId" }, "processDataTime": { "description": "RT1 receiving DateTime.\nThe field field is not present if message type is Payment Status Query (camt.005)", "$ref": "#/components/schemas/DateTime" }, "messageStatus": { "description": "Message status code", "$ref": "#/components/schemas/Status2" }, "liquiTransfId": { "description": "Liquidity Transfer Identifier.\nThe field field is present if message type is LTO (camt.050)", "$ref": "#/components/schemas/LiquiTransfId" }, "endToEndId": { "description": "End To End Indentifier.\nThe field field is present if message type is LTO (camt.050) ,Credit/Debit Notification (camt.054)", "$ref": "#/components/schemas/EndToEndId" }, "credAccOwnBic": { "description": "BIC of Financial Institution owning the account to be credited.\nThe field field is present if message type is LTO (camt.050)", "$ref": "#/components/schemas/Bic11Only" }, "debAccoOwnBic": { "description": "BIC of Financial Institution owning the account to be debited\nThe field field is present if message type is LTO (camt.050)", "$ref": "#/components/schemas/Bic11Only" }, "accToBeCred": { "description": "Account to be credited.\nThe field field is present if message type is LTO (camt.050)", "$ref": "#/components/schemas/Account" }, "amountToBeTraser": { "description": "The field field is present if message type is LTO (camt.050)", "$ref": "#/components/schemas/Amount" }, "accToBeDeb": { "description": "The Instructing Agent of the transaction. If the transaction arrives from TIPS, the Instructing Agent will always be TIPS BIC.\nThe field field is present if message type is LTO (camt.050)", "$ref": "#/components/schemas/Account" }, "settlDate": { "description": "Settlement Date of the credit transfer.\nThe field field is present if message type is LTO (camt.050)", "$ref": "#/components/schemas/Date" }, "requestedThrough": { "description": "The interface through which the message has been requested or sent.\nAvailable values:\n• GUI-API interface(U2A)\n• Message interface(A2A)", "$ref": "#/components/schemas/RequestedThrough1" }, "camt025ReceDtTmFromTIPS": { "description": "Date and Time indicating when the Receipt has been received from TIPS", "$ref": "#/components/schemas/DateTime" }, "receiverBic": { "description": "Receiver BIC of the message.\nThis field is present if message type is Receipt (camt.025) or Return Account (camt.004)", "$ref": "#/components/schemas/Bic11" }, "tipsTimestamp": { "description": "Timestamp when the request has been processed.\nThe field field is present if message type are Receipt (camt.025) and Return Account (camt.004)", "$ref": "#/components/schemas/DateTime" }, "origMessId": { "description": "Identification of the original message\nThe field field is present if message type are Receipt (camt.025) ,Return Account (camt.004) or Payment Status Query Response (camt.006)", "$ref": "#/components/schemas/MessageId" }, "ltoTipsStatus": { "description": "Select the message status of the outbound liquidity transfer order as processed by TIPS.\nThe field field is present if message type is Receipt (camt.025)", "$ref": "#/components/schemas/LtoTipsStatus1" }, "addInfo": { "description": "Additional information when an error occurs.\nThe field field is present if message type is Receipt (camt.025)", "$ref": "#/components/schemas/AddInfo" }, "camt054ReceDtTmFromTIPS": { "description": "Date and Time indicating when the Debit/Credit Notification has been received from TIPS", "$ref": "#/components/schemas/DateTime" }, "notificationId": { "description": "Notification Identifier.\nThe field field is present if message type is Credit/debit Notification (camt.054)", "$ref": "#/components/schemas/NotificationId" }, "accountId": { "description": "Account Identifier.\nAccount for which the notification has been generated.\nThe field field is present if message type is Credit/debit Notification (camt.054)", "$ref": "#/components/schemas/Account" }, "notificationAmount": { "description": "Amount that has been transferred to the Account.\nThe field field is present if message type is Credit/debit Notification (camt.054)", "$ref": "#/components/schemas/Amount" }, "creditDebitIndicator": { "description": "Credit Debit Indicator\nSpecifies if the Amount has been credited or debited. For credit movements, this field will be “CRDT”. For debit movements this field will be “DBIT”.\nThe field field is present if message type is Credit/debit Notification (camt.054)", "$ref": "#/components/schemas/CreditDebitIndicator" }, "debtorBic": { "description": "The Debtor BIC of the Liquidity transfer order\nThe field field is present if message type is Credit/debit Notification (camt.054)", "$ref": "#/components/schemas/Bic11" }, "debtorAccountId": { "description": "Account debited.\nThe field field is present if message type is Credit/debit Notification (camt.054)", "$ref": "#/components/schemas/Account" }, "creditorBic": { "description": "RT1 BIC whose position will be updated, can be a LP or one of his LSPs.\nThe field field is present if message type is Credit/debit Notification (camt.054) or Payment Status Query response (camt.006)", "$ref": "#/components/schemas/Bic11" }, "creditorAccountId": { "description": "Account credited.\nThe field field is present if message type is Credit/debit Notification (camt.054) or or Payment Status Query response (camt.006)", "$ref": "#/components/schemas/Account" }, "instructionIdentifcation": { "description": "Original Liquidity Transfer reference\nThe field field is present if message type is Credit/debit Notification (camt.054)", "$ref": "#/components/schemas/InstructionIdentification" }, "camt003RecFromPartDtTm": { "description": "Date and Time indicating when the Participant transmitted the Get Account message to RT1.", "$ref": "#/components/schemas/DateTime" }, "camt004RecDtTmFromTips": { "description": "Date and Time indicating when the Return Account has been received from TIPS", "$ref": "#/components/schemas/DateTime" }, "accOrCmbId": { "description": "Identification of the Account or CMB to query.\nThe field field is present if message type is Get Account (camt.003)", "$ref": "#/components/schemas/Account" }, "accOrCmbUserBic": { "description": "Identification of the BIC of the user of the Account or CMB.\nThe field field is present if message type is Get Account (camt.003)", "$ref": "#/components/schemas/Account" }, "businessErr": { "description": "Specifies the error occurred when processing the originating query message.\nThe field field is present if message type is Return Account (camt.004)", "$ref": "#/components/schemas/BusinessError" }, "businessErrDes": { "description": "Provides with additional error description.\nThe field field is present if message type is Return Account (camt.004)", "$ref": "#/components/schemas/ErrorCodeDescription" }, "tipsAccoId": { "description": "Account identifier retrieved from reference data repository.\nThe field field is present if message type is Return Account (camt.004)", "$ref": "#/components/schemas/Account" }, "currBalance": { "description": "Current balance of the account.\nThe field field is present if message type is Return Account (camt.004)", "$ref": "#/components/schemas/Amount" }, "accCredDebIndic": { "description": "Specifies if balance is below or above zero,\nThe field field is present if message type is Return Account (camt.004)", "$ref": "#/components/schemas/AccCredDebIndic" }, "tipsPartBic": { "description": "BIC code of the account owner.\nThe field is present if message type is Return Account (camt.004)", "$ref": "#/components/schemas/Bic11Only" }, "restrictionTypeId": { "description": "Restriction Type identifier applied to the account.\nThe field field is present if message type is Return Account (camt.004)", "$ref": "#/components/schemas/RestrictionTypeId" }, "processingType": { "description": "Specifies the processing type for the restriction type applied to the account.\nThe field field is present if message type is Return Account (camt.004)", "$ref": "#/components/schemas/ProcessingType" }, "tipsCmbIdentifier": { "description": "Identification of the CMB,\nThe field field is present if message type is Return Account (camt.004)", "$ref": "#/components/schemas/TipsCmbIdentifier" }, "cmbLimitAmt": { "description": "Limit amount of the CMB for the counterparty.\nThe field field is present if message type is Return Account (camt.004)", "$ref": "#/components/schemas/CmbLimitAmt" }, "cmbHeadroom": { "description": "Dynamic headroom of the CMB limit.\nThe field field is present if message type is Return Account (camt.004)", "$ref": "#/components/schemas/CmbLimitAmt" }, "cmbStatus": { "description": "Specifies the status of the CMB.\nThe field field is present if message type is Return Account (camt.004)", "$ref": "#/components/schemas/CmbStatus" }, "returnAcctTp": { "description": "The field field is present if message type is Return Account (camt.004)", "$ref": "#/components/schemas/ReturnAcctTp" }, "camt005ReceFromPartDtTm": { "description": "Date and Time indicating when the Participant transmitted the Payment Status Query message to RT1.", "$ref": "#/components/schemas/DateTime" }, "origTransId": { "description": "Identification of the Instant Payment Transaction.\nIt corresponds to original pacs.008 Transaction Identification or pacs.004 Return Identification.\nThis field is present if the message type is Payment Status Query (camt.005) or Payment Status Query Response (camt.006)", "$ref": "#/components/schemas/OrigTransId" }, "participantBic": { "description": "Participant or AP BIC\nIt is the Debtor BIC if the transaction is a pacs.008; Original Creditor BIC if the transaction is a pacs.004\nThis field is present if the message type is Payment Status Query (camt.005)", "$ref": "#/components/schemas/Bic11" }, "camt006RecDtTmFromTips": { "description": "Date and Time indicating when the Payment Status Query Response has been received from TIPS", "$ref": "#/components/schemas/DateTime" }, "origTransType": { "description": "Type of the reported payment.\nIt corresponds to three chars in position 27-29 of the message ID.\nPossible values:\n• 008 for pacs.008\n• 004 for pacs.004", "$ref": "#/components/schemas/OrigTransType" }, "origTransAmount": { "description": "Amount of the original transaction", "$ref": "#/components/schemas/Amount" }, "origInstructingAg": { "description": "The instructing Agent of the original message (Pacs.008 or Pacs.004)", "$ref": "#/components/schemas/OrigInstructingAg" }, "fnalPayStatusCode": { "description": "The final status code of the original transaction.\nPossible values:\n• “STLD” for Settled;\n• “CAND” for Cancelled;\n• “FNLD” for Expired.\n• “FAIL” for Failed.\n• “PSTL” for Reserved\nThis field is present if the message type is Payment Status Query Response (camt.006)", "$ref": "#/components/schemas/FnalPayStatusCode" }, "fnalPayStatusTimestamp": { "description": "Timestamp related to the final status code.\nThe time at which the Instant Payment Transaction or the Positive Response for a Recall was settled.\nThis field is present if the message type is Payment Status Query Response (camt.006)", "$ref": "#/components/schemas/Time" }, "acceptanceTimestamp": { "description": "The Acceptance Timestamp.\nPresent in case the Payment Status Code in the response includes “ACCP”.\nThis field is present if the message type is Payment Status Query Response (camt.006)", "$ref": "#/components/schemas/Time" }, "receptionTimestamp": { "description": "The Reception from the Originator Timestamp.\nPresent in case the Payment Status Code in the response includes “ORCV”.\nThis field is present if the message type is Payment Status Query Response (camt.006)", "$ref": "#/components/schemas/Time" }, "forwardingTimestamp": { "description": "The Forwarding to the Beneficiary Timestamp.\nPresent in case the Payment Status Code in the response includes “BFWD”.\nThis field is present if the message type is Payment Status Query Response (camt.006)", "$ref": "#/components/schemas/Time" }, "confReceptTimestamp": { "description": "The Confirmation Reception from the Beneficiary Timestamp.\nPresent in case the Payment Status Code in the response includes “BRCV”.\nThis field is present if the message type is Payment Status Query Response (camt.006)", "$ref": "#/components/schemas/Time" }, "confToOrigTimestamp": { "description": "Confirmation to the Originator Timestamp.\nPresent in case the Payment Status Code in the response includes “OFWD”.\nThis field is present if the message type is Payment Status Query Response (camt.006)", "$ref": "#/components/schemas/Time" }, "reason": { "description": "Reason of the unsettled status.\nNot present in case the Transaction status is settled.\nThis field is present if the message type is Payment Status Query Response (camt.006)", "$ref": "#/components/schemas/Reason" }, "operationalError": { "description": "Specifies the error occurred when processing the originating query message,\nThis field is present if the message type is Payment Status Query Response (camt.006)", "$ref": "#/components/schemas/OperationalError" }, "RT1GrossBalance": { "description": "RT1 Gross Balance triggered by related camt.004 message when requested", "$ref": "#/components/schemas/Amount" } }, "required": [ "messageType", "transmStatusTransDtTm", "errStatusTransDtTm", "notStatusTransDtTm", "rejStatusTransDtTm", "messageId", "processDataTime", "messageStatus" ] }, "MessageDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria4" } }, "required": [ "dateTime", "criteria" ] }, "MessageDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "Standard ISO Date-Time.", "$ref": "#/components/schemas/DateTime" }, "messageDetails": { "$ref": "#/components/schemas/MessageDetails" } }, "required": [ "dateTime" ] }, "MessageId": { "type": "string", "maxLength": 35, "examples": [ "P08M59270578EA544566A8DB7D970D" ] }, "MessageId1": { "type": "string", "maxLength": 16, "examples": [ "P08M59270578EA54" ] }, "MessageId2": { "type": "string", "pattern": "[A-Za-z0-9+\\-:\\.]{1,35}", "maxLength": 35, "examples": [ "P08M59270578EA544566A8DB7D970D" ] }, "MessageType": { "type": "string", "enum": [ "camt.050OBLT", "camt.050FNLTDFLT", "camt.054", "camt.025", "camt.003", "camt.004", "camt.005", "camt.006" ], "maxLength": 16, "examples": [ "camt.054" ] }, "MessageType1": { "type": "string", "enum": [ "camt.050OBLT", "camt.050FNLTDFLT", "camt.050RVLT", "camt.054", "camt.025", "camt.003", "camt.004", "camt.005", "camt.006" ], "examples": [ "camt.054" ] }, "MessageTypeCamt005": { "type": "string", "enum": [ "Pacs.008", "Pacs.004" ], "examples": [ "Pacs.008" ] }, "Month": { "type": "integer", "examples": [ 1 ] }, "MsrReq": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "MsrReq1": { "type": "string", "enum": [ "0", "1" ], "maxLength": 1, "examples": [ "0" ] }, "Name": { "type": "string", "pattern": "[A-Za-z0-9\\s\\\"\\#\\$\\%\\&\\'\\(\\)\\*\\+\\,\\-\\.\\/\\:\\;\\<\\=\\>\\?\\@\\\\\\_\\`\\{\\}\\~\\]]", "maxLength": 50, "examples": [ "BFF Bank" ] }, "NetFileName": { "type": "string", "maxLength": 32, "examples": [ "EBICS" ] }, "Network": { "type": "string", "enum": [ "EAS", "EBX", "SWI" ], "examples": [ "EAS" ] }, "Network1": { "type": "string", "enum": [ "EAS", "EBX", "SWF", "SWA", "SWS", "SWM" ], "maxLength": 3, "examples": [ "EAS" ] }, "Network2": { "type": "string", "enum": [ "EAS", "EBX", "SWF", "SWA", "SWM", "SWS" ], "maxLength": 3, "examples": [ "EAS" ] }, "NewRole": { "type": "string", "maxLength": 2, "examples": [ "N" ] }, "NewRole1": { "type": "string", "enum": [ "Y", "N" ], "examples": [ "N" ] }, "NewStatus": { "type": "string", "maxLength": 3, "examples": [ "DIS" ] }, "NotificationId": { "type": "string", "examples": [ "210910113003" ] }, "NrrData": { "type": "object", "properties": { "numSentNRR": { "description": "The number of NRR instructions received from the SenderBic by the system", "$ref": "#/components/schemas/NumSentNRR" }, "numRjtNRR": { "description": "The number of NRR instructions received from the SenderBic that were rejected by the system", "$ref": "#/components/schemas/NumRjtNRR" } } }, "NumAlerts": { "type": "number", "examples": [ 1 ] }, "NumFiles": { "type": "integer", "examples": [ 1 ] }, "NumHeldIP": { "type": "integer", "examples": [ 1 ] }, "NumHeldPRR": { "type": "integer", "examples": [ 1 ] }, "NumInstructions": { "type": "integer", "examples": [ 1 ] }, "NumPayments": { "type": "integer", "examples": [ 1 ] }, "NumReceivedInvestigation": { "type": "integer", "examples": [ 1 ] }, "NumReceivedReqStatusUpd": { "type": "integer", "examples": [ 1 ] }, "NumRecordFound": { "type": "integer", "examples": [ 1 ] }, "NumRjtIP": { "type": "integer", "examples": [ 1 ] }, "NumRjtNRR": { "type": "integer", "examples": [ 1 ] }, "NumRjtPRR": { "type": "integer", "examples": [ 1 ] }, "NumRjtRecall": { "type": "integer", "examples": [ 1 ] }, "NumSentInvestigation": { "type": "integer", "examples": [ 1 ] }, "NumSentIP": { "type": "integer", "examples": [ 1 ] }, "NumSentNRR": { "type": "integer", "examples": [ 1 ] }, "NumSentPRR": { "type": "integer", "examples": [ 1 ] }, "NumSentRecall": { "type": "integer", "examples": [ 1 ] }, "NumSentReqStatusUpd": { "type": "integer", "examples": [ 1 ] }, "NumSettledIP": { "type": "integer", "examples": [ 1 ] }, "NumSettledPRR": { "type": "integer", "examples": [ 1 ] }, "NumTransactions": { "type": "integer", "examples": [ 1 ] }, "Offset": { "type": "string", "examples": [ "AAaa88ss2345fggGGDDaaaHH" ] }, "OpeningTime": { "type": "string", "examples": [ "16:00:00" ] }, "OperationalError": { "type": "string", "examples": [ "Error occurred when processing the originating query message type Payment Status Query Response (camt.006)" ] }, "OperationDetails": { "type": "object", "properties": { "operationType": { "description": "Type of the operation.\n- “INS” Inserted\n- “REM” Removed\n- “UPD” Updated\n- “MIN” Massive Insert\n- “RNL” R-only\n- \"MOD\" Amend\n- \"REV\" Revoke\n- “ACP” APSP Change P.", "$ref": "#/components/schemas/OperationType2" }, "referenceId": { "description": "Unique reference ID of the operation", "$ref": "#/components/schemas/ReferenceId1" }, "critical": { "description": "This flag indicates if the operation is critical or not-critical", "$ref": "#/components/schemas/Critical" }, "status": { "description": "The current status of the operation. Values are “TO BE AUTHORIZED”, “AUTHORIZED”, “SUBMITTED”, “EXECUTED”, “REJECTED” and “REJECTED BY SYSTEM”.", "$ref": "#/components/schemas/Status7" }, "requestor": { "description": "The user who submitted the operation", "$ref": "#/components/schemas/Requestor" }, "dateOfRequest": { "description": "The date of the request", "$ref": "#/components/schemas/Date" }, "confirmer": { "description": "The user Id of the user who confirmed the operation. Applicable only in case of “Critical” operation", "$ref": "#/components/schemas/Confirmer" }, "dateOfConfirm": { "description": "The date of the confirmation by Participant User. Applicable only in case of “Critical” operation", "$ref": "#/components/schemas/DateOfConfirm" }, "authorizer": { "description": "The user who authorized/rejected the operation", "$ref": "#/components/schemas/Authorizer" }, "dateOfExecution": { "description": "Date at which the operation went live", "$ref": "#/components/schemas/Date" }, "initParameterValidity": { "description": "The initial date of validity of the configured AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Date" }, "endParameterValidity": { "description": "The end date of validity of the configured AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Date" } }, "required": [ "operationType", "referenceId", "critical", "status", "requestor", "dateOfRequest", "authorizer", "dateOfExecution" ] }, "OperationItem": { "type": "object", "properties": { "submissionDate": { "description": "Submission date of the reject request", "$ref": "#/components/schemas/DateTime" }, "referenceId": { "description": "Unique reference ID of the operation", "$ref": "#/components/schemas/ReferenceId1" }, "requestStatus": { "description": "The status of the submitted command:\nIf the API request has been accepted then it is equal to “ATH”.\nIf the API request fails, then it is equal to “RJS” (meaning that the original change operation will not be rejected).", "$ref": "#/components/schemas/RequestStatus1" } }, "required": [ "submissionDate", "referenceId", "requestStatus" ] }, "OperationType": { "type": "string", "enum": [ "INS", "MOD", "REM" ], "maxLength": 3, "examples": [ "INS" ] }, "OperationType1": { "type": "string", "enum": [ "INS", "REM", "UPD", "ALL", "MIN", "RNL", "MOD", "REV", "ACP" ], "examples": [ "INS" ] }, "OperationType2": { "type": "string", "enum": [ "INS", "REM", "UPD", "RNL", "MIN", "MOD", "REV", "ACP", "ALL" ], "examples": [ "INS" ] }, "OriginalCurrency": { "type": "string", "maxLength": 3, "examples": [ "USD" ] }, "OriginalEndToEndID": { "type": "string", "maxLength": 35, "examples": [ "SC042411081653" ] }, "OriginalMessageType": { "type": "string", "examples": [ "camt.005" ] }, "OriginalTransactionId": { "type": "string", "examples": [ "CCT000000776156310" ] }, "OriginalTransactionId1": { "type": "string", "maxLength": 35, "examples": [ "CCT000000776156310" ] }, "OrigInstructingAg": { "type": "string", "examples": [ "IPSDPF21XXX" ] }, "OrigTransId": { "type": "string", "examples": [ "CCT000000776156310" ] }, "OrigTransType": { "type": "string", "enum": [ "008", "004" ], "maxLength": 3, "examples": [ "008" ] }, "OtherSystemCutOff": { "type": "object", "properties": { "openingTime": { "description": "Identifies opening of a new processing day, the SCT Inst CS will:\n▪ generate RSF, DRR files;\n▪ generate RTF files, if requested;\n▪ the first processing day of the month, generate MSR files.", "$ref": "#/components/schemas/OpeningTime" }, "taw1Start": { "description": "Identifies the start of the first TARGET Availability Window for the day", "$ref": "#/components/schemas/Taw1Start" }, "taw1End": { "description": "Identifies the end of the first TARGET Availability Window for the day", "$ref": "#/components/schemas/Taw1End" }, "taw2Start": { "description": "Identifies the start of the second TARGET Availability Window for the day", "$ref": "#/components/schemas/Taw2Start" }, "taw2End": { "description": "Identifies the end of the second TARGET Availability Window for the day.", "$ref": "#/components/schemas/Taw2End" } }, "required": [ "openingTime", "taw1Start", "taw1End", "taw2Start", "taw2End" ] }, "OwnedBranchFundsBalanceInfo": { "type": "object", "properties": { "branchFundsBalanceId": { "description": "Mandatory if the section is present", "$ref": "#/components/schemas/BranchFundsBalanceId" }, "amount": { "description": "Mandatory if the section is present", "$ref": "#/components/schemas/Amount" } }, "required": [ "branchFundsBalanceId", "amount" ] }, "OwnedBranchFundsBalanceList": { "type": "object", "properties": { "ownedBranchFundsBalanceInfo": { "$ref": "#/components/schemas/OwnedBranchFundsBalanceInfo" }, "ownedMemberList": { "type": "array", "items": { "$ref": "#/components/schemas/OwnedMemberList" } } } }, "OwnedMemberList": { "type": "object", "properties": { "bic": { "description": "Mandatory if the section is present\nThe BIC of a Member belonging to the OwnedBranchFundsBalanceId", "$ref": "#/components/schemas/Bic8" }, "sign": { "description": "Mandatory if the section is present\nThe sign of the position of the Member. It contains “C” for Credit Amount or “D” for Debit Amount.", "$ref": "#/components/schemas/Sign" }, "amount": { "description": "Mandatory if the section is present\nThe Amount corresponding to the real time Position of the Member at the time of the query", "$ref": "#/components/schemas/Amount" }, "timestamp": { "description": "Mandatory if the section is present\nTimeStamp of the instant in which the system read-the Position of the Member", "$ref": "#/components/schemas/DateTime" } }, "required": [ "bic", "sign", "amount", "timestamp" ] }, "ParametersHistory": { "type": "object", "properties": { "name": { "description": "It is the name of the BIC (Mandatory if the section is present)", "$ref": "#/components/schemas/Name" }, "automaticLiquidityAdjustment": { "description": "The liquidity adjustment parameter. It is present the Participant wants to have the Automatic Liquidity Adjustment.", "$ref": "#/components/schemas/LiquidityAutomaticAdjustment" }, "intraLACAuthAdjst": { "description": "The intraLAC liquidity adjustment parameter. If it is present, the Participant wants to have the intraLAC Automatic Liquidity Adjustment.", "$ref": "#/components/schemas/LiquidityAutomaticAdjustment" }, "initParameterValidity": { "description": "The initial date of validity of the configured parameters (Mandatory if the section is present)", "$ref": "#/components/schemas/Date" }, "endParameterValidity": { "description": "The end date of validity of the configured parameters (Mandatory if the section is present)", "$ref": "#/components/schemas/Date" }, "bic": { "description": "The BIC of the request (Mandatory if the section is present)", "$ref": "#/components/schemas/Bic8" }, "technicalBic": { "description": "It indicates if the BIC is a technical one (1) or not (0) (Mandatory if the section is present)", "$ref": "#/components/schemas/TechnicalBic1" }, "tipsOwnerBic": { "description": "The BIC (11) by which the Participant will be known to the ESM for settlement purpos-es.", "$ref": "#/components/schemas/Bic11Only" }, "liquidityManagement": { "description": "The liquidity management of the BIC, it is present only if the BIC is an LSP", "$ref": "#/components/schemas/LiquidityManagement" }, "dcaCashAcctNm": { "description": "The TIPS Account number", "$ref": "#/components/schemas/TipsDcaAccountId" }, "tipsUserBic": { "description": "The BIC used for reachability in TIPS through a DCA account", "$ref": "#/components/schemas/Bic11Only" }, "submittedAOSinst": { "description": "The AOS associated to INST defaultProduct subscribed by the Participant.", "$ref": "#/components/schemas/AOSList" }, "submittedAOSeolo": { "description": "The AOS associated to EOLO defaultProduct subscribed by the Participant.", "$ref": "#/components/schemas/AOSList" }, "newBic": { "description": "The New BIC related to the BIC", "$ref": "#/components/schemas/Bic8" }, "newRole": { "description": "The new role of the DP, it can contain only “IS” for a DP IS or “DS” for a DP DS", "$ref": "#/components/schemas/NewRole" }, "branchFundsBalanceId": { "description": "If present, the branchFundsBalanceId of the Liquidity Branch Funds Balance which the SenderBic is a member of.", "$ref": "#/components/schemas/BranchFundsBalanceId" }, "roleChange": { "description": "It indicates if the Participant has changed its role (1) or not (0) (Mandatory if the section is present)", "$ref": "#/components/schemas/RoleChange" }, "psrReq": { "description": "It indicates if the Participant asked for receive PSR (1) or not (0) (Mandatory if the section is present)", "$ref": "#/components/schemas/PsrReq" }, "rsfReq": { "description": "It indicates if the Participant asked for receive RSF (1) or not (0) (Mandatory if the section is present)", "$ref": "#/components/schemas/RsfReq" }, "drrReq": { "description": "It indicates if the Participant asked for receive DRR (1) or not (0) (Mandatory if the section is present)", "$ref": "#/components/schemas/DrrReq" }, "msrReq": { "description": "It indicates if the Participant asked for the receiving of MSR (1) or not (0) (Mandatory if the section is present)", "$ref": "#/components/schemas/MsrReq" }, "maxFileSize": { "description": "The maximum size of a file that is sent by the CS to the DP (Mandatory if the section is present)", "$ref": "#/components/schemas/MaxFileSize" }, "compression": { "description": "It indicates if the Participant asked for swift file compression (1) or not (0) (Mandatory if the section is present)", "$ref": "#/components/schemas/Compression" }, "bbTimeoutMgm": { "description": "It indicates if the SCT Inst has to reject the transaction that are not confirmed or rejected within the timeout expiration time by the Participant, when acting as Beneficiary Bank (Mandatory if the section is present)", "$ref": "#/components/schemas/BbTimeoutMgm" }, "bbPositiveCnf": { "description": "It indicates if the Participant asked for confirmation of the credited payment amount (Mandatory if the section is present)", "$ref": "#/components/schemas/BbPositiveCnf" }, "tipsAdherence": { "description": "It indicates if the Participant joined to TIPS (1) or not (0) (Mandatory if the section is present)", "$ref": "#/components/schemas/TipsAdherence" }, "tipsNetworkOption": { "description": "The Network used in the communication with TIPS. It can only assume the following values:\n- “EAS” for SIANet\n- “SWI” for SWIFTNet Instant\nTAG not present if no Network has been selected (only if TIPSAdherence is set to “0”).", "$ref": "#/components/schemas/TipsNetworkOption" }, "transactionalPrimaryNetId": { "description": "The primary transactional network identification (Mandatory if the section is present). Can be the same provider of Secondary Network", "$ref": "#/components/schemas/TransactionalPrimaryNetId1" }, "transactionalSecondaryNetId": { "description": "The secondary transactional network identification", "$ref": "#/components/schemas/TransactionalSecondaryNetId1" }, "transactionalActiveOutputNet": { "description": "Can be the same provider of Primary Network", "$ref": "#/components/schemas/TransactionalActiveOutputNet" }, "filePrimaryNetId": { "description": "It indicates if the system uses the primary or secondary network to exchange transactional data (Mandatory if the section is present)\nAvailable values:\n- EAS: for SIANET\n- EBX: for EBICS;\n- SWF: RT single request type\n- SWA: RT multiple request type\n- SWS: SWIFTNet S&F single request type\n- SWM: SWIFTNet S&F multiple request type", "$ref": "#/components/schemas/FilePrimaryNetId" }, "fileSecondaryNetId": { "description": "The primary file network identification (Mandatory if the section is present) Can be the same provider of Secondary Network\nAvailable values:\n- EAS: for SIANET\n- EBX: for EBICS;\n- SWF: RT single request type\n- SWA: RT multiple request type\n- SWS: SWIFTNet S&F single request type\n- SWM: SWIFTNet S&F multiple request type", "$ref": "#/components/schemas/FileSecondaryNetId" }, "fileActiveOutputNet": { "description": "The secondary file network identification. Can be the same provider of Primary Network", "$ref": "#/components/schemas/FileActiveOutputNet" }, "primaryFileIntRecNetId": { "description": "It indicates if the system uses the primary or secondary network to send files (Mandatory if the section is present)", "$ref": "#/components/schemas/PrimaryFileIntRecNetId" }, "secondaryFileIntRecNetId": { "description": "The primary receiving network identification for the File Interface (Mandatory if the section is present) Can be the same provider of Secondary Network", "$ref": "#/components/schemas/SecondaryFileIntRecNetId" }, "productList": { "description": "The following section is repeated as many times as the Products subscribed by the Participant are. The following sub-section is present if and only if the BIC of the request is the same as the inquiring SenderBic", "type": "array", "items": { "$ref": "#/components/schemas/ProductList1" } }, "currenciesList": { "description": "List of currencies subscribed from Participant. Structure is present only if A05 is one of submittedAOS", "type": "array", "items": { "$ref": "#/components/schemas/CurrenciesList" } } }, "required": [ "initParameterValidity", "endParameterValidity", "bic", "technicalBic", "name", "tipsOwnerBic", "roleChange", "psrReq", "rsfReq", "drrReq", "msrReq", "maxFileSize", "compression", "bbTimeoutMgm", "bbPositiveCnf", "tipsAdherence", "transactionalPrimaryNetId", "transactionalActiveOutputNet", "filePrimaryNetId", "fileActiveOutputNet", "primaryFileIntRecNetId" ] }, "ParamHistory": { "type": "object", "properties": { "name": { "description": "It is the name of the AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Name" }, "bicAp": { "description": "The BIC of the AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Bic11" }, "dpBic": { "description": "The Participant BIC related to the AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Bic8" }, "submittedAOSinst": { "description": "The AOS associated to INST defaultProduct subscribed by the Participant.", "$ref": "#/components/schemas/AOSList" }, "submittedAOSEolo": { "description": "The AOS associated to EOLO defaultProduct subscribed by the Participant.", "$ref": "#/components/schemas/AOSList" }, "status": { "description": "The current status of the AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Status4" }, "initParticipantValidity": { "description": "The initial date of validity of the configured AP parameters (Mandatory if the section is present)", "$ref": "#/components/schemas/Date" }, "endParticipantValidity": { "description": "The end date of validity of the configured AP parameters (Mandatory if the section is present)", "$ref": "#/components/schemas/Date" } }, "required": [ "bicAp", "dpBic", "name", "status", "initParticipantValidity", "endParticipantValidity" ] }, "ParticipantDetailsResponse": { "type": "object", "properties": { "name": { "description": "It is the name of the BIC", "$ref": "#/components/schemas/Name" }, "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "bic": { "description": "The BIC of the request", "$ref": "#/components/schemas/Bic8" }, "technicalBic": { "description": "It indicates if the BIC is a technical one (1) or not (0)", "$ref": "#/components/schemas/TechnicalBic1" }, "lsp": { "description": "It indicates if the BIC is served for Liquidity Funding/Defunding (value Yes) or not (val-ue No)", "$ref": "#/components/schemas/Lsp" }, "initValidityDate": { "description": "The initial date of validity of the configured BIC", "$ref": "#/components/schemas/Date" }, "endValidityDate": { "description": "The end date of validity of the configured BIC", "$ref": "#/components/schemas/Date" }, "status": { "description": "The status of the BIC", "$ref": "#/components/schemas/Status4" }, "parametersHistory": { "description": "The following section is present as many times as the rows of the Parameters Modification History related to the BIC are", "type": "array", "items": { "$ref": "#/components/schemas/ParametersHistory" } } }, "required": [ "dateTime", "bic" ] }, "ParticipantOperationDetails": { "type": "object", "properties": { "name": { "description": "It is the name of the AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Name" }, "dpBic": { "description": "The Participant BIC related to the AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Bic8" }, "initParticipantValidity": { "description": "The initial date of validity of the configured AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Date" }, "endParticipantValidity": { "description": "The end date of validity of the configured AP (Mandatory if the section is present)", "$ref": "#/components/schemas/Date" }, "technicalBic": { "description": "It indicates if the BIC is a technical one (1) or not (0). It can contain only “1 “(TechnicalBic) or “0” (no TechnicalBic) (schema validation)", "$ref": "#/components/schemas/TechnicalBic" }, "bbPositiveCnf": { "description": "It indicates if the Participant asked for confirmation of the credited payment amount (Mandatory if the section is present)", "$ref": "#/components/schemas/BbPositiveCnf1" }, "bbTimeoutMgm": { "description": "It indicates if the SCT Inst has to reject the transaction that are not confirmed or rejected within the timeout expiration time by the Participant, when acting as Beneficiary Bank (Mandatory if the section is present)", "$ref": "#/components/schemas/BbTimeoutMgm1" }, "liquidityManagement": { "description": "It can contain 0 (not required) or 1 (required).", "$ref": "#/components/schemas/LiquidityManagement1" }, "branchFundsBalanceId": { "description": "If present, the branchFundsBalanceId of the Liquidity Branch Funds Balance the SenderBic is a member of", "$ref": "#/components/schemas/BranchFundsBalanceId" }, "tipsAdherence": { "description": "It indicates if the Participant is allowed to exchange transactions to/from the TIPS System, or it is not.", "$ref": "#/components/schemas/TipsAdherence1" }, "tipsNetwOpt": { "description": "The Network used in the communication with TIPS. It can only assume the following values:\n- “EAS” for SIANet\n- “SWI” for SWIFTNet Instant", "$ref": "#/components/schemas/TipsNetwOpt" }, "compression": { "description": "It can contain 0 (not required) or 1 (required).", "$ref": "#/components/schemas/Compression1" }, "LSP": { "description": "It indicates if the BIC is a Liquidity Servised Provider or not.", "$ref": "#/components/schemas/LSP" }, "automaticLiquidityAdjus": { "description": "It indicates whether it is required or not to have automatic liquidity adjustments at the end of each LAC", "$ref": "#/components/schemas/AutomaticLiquidityAdjus" }, "tipsUserBic": { "description": "BIC used for reachability in TIPS through a DCA account", "$ref": "#/components/schemas/TipsUserBic" }, "tipsAccoOwnBic": { "description": "TIPS DCA Account Owner for Instra-Service Liquidity Transfer", "$ref": "#/components/schemas/Bic11" }, "tipsDcaCashAccountNumber": { "description": "TIPS Account number", "$ref": "#/components/schemas/TipsDCA" }, "activeOutNet": { "description": "It indicates if the system uses the primary or secondary network to send files", "$ref": "#/components/schemas/ActiveOutNet" }, "primaryFileIntRecNetId": { "description": "The primary receiving network identification for the File Interface.Can be the same provider of Secondary Network", "$ref": "#/components/schemas/PrimaryFileIntRecNetId" }, "secondaryFileIntRecNetId": { "description": "The secondary receiving network identification for the File Interface\nCan be the same provider of Primary Network", "$ref": "#/components/schemas/SecondaryFileIntRecNetId" }, "msrReq": { "description": "It indicates if the Participant asked for receive MSR.\nIt can contain 0 (not required) or 1 (required)", "$ref": "#/components/schemas/MsrReq1" }, "psrReq": { "description": "It indicates if the Participant asked for receive PSR\nIt can contain 0 (not required) or 1 (required)", "$ref": "#/components/schemas/PsrReq1" }, "rsfReq": { "description": "It indicates if the Participant asked for receive RSF.\nIt can contain 0 (not required) or 1 (required)", "$ref": "#/components/schemas/RsfReq1" }, "drrReq": { "description": "It indicates if the Participant asked for receive DRR. It can contain 0 (not required) or 1 (required)", "$ref": "#/components/schemas/DrrReq1" }, "maxFileSize": { "description": "The maximum size of a file that is sent by the CS to the DP.", "$ref": "#/components/schemas/MaxFileSize1" }, "submittedAOS": { "description": "The AOSs subscribed by the Participant.", "$ref": "#/components/schemas/SubmittedAOS" }, "traInterfActiveOutputNet": { "description": "It indicates if the system uses the primary or secondary network to send files (Mandatory if the section is present)", "$ref": "#/components/schemas/ActiveOutNet" }, "filePrimaryNetId": { "description": "The primary file network identification (Mandatory if the section is present) Can be the same provider of Secondary Network", "$ref": "#/components/schemas/FilePrimaryNetId1" }, "fileSecondaryNetId": { "description": "The secondaryfile network identification (Mandatory if the section is present) Can be the same provider of Secondary Network", "$ref": "#/components/schemas/FileSecondaryNetId1" }, "transactionalPrimaryNetId": { "description": "The primary network identification\nCan be the same provider of Secondary Network.It can contain:\n- “EAS” for SIANet\n- “EBX” for EBICS\n- “SWI” for Swift Real Time", "$ref": "#/components/schemas/TransactionalPrimaryNetId2" }, "transactionalSecondaryNetId": { "description": "The secondary network identification\nCan be the same provider of Primary Network.\nIt can contain:\n- “EAS” for SIANet\n- “EBX” for EBICS\n- “SWI” for Swift Real Time", "$ref": "#/components/schemas/TransactionalSecondaryNetId2" }, "productList": { "description": "The following section is repeated as many times as the Products subscribed by the Participant are. The following sub-section is present if and only if the BIC of the request is the same as the inquiring SenderBic", "type": "array", "items": { "$ref": "#/components/schemas/ProductList7" } } }, "required": [ "dpBic", "name", "initParticipantValidity", "endParticipantValidity", "technicalBic", "bbPositiveCnf", "bbTimeoutMgm", "liquidityManagement", "tipsAdherence", "tipsNetwOpt", "compression", "LSP", "automaticLiquidityAdjus", "tipsUserBic", "tipsAccoOwnBic", "tipsDcaCashAccountNumber", "activeOutNet", "primaryFileIntRecNetId", "msrReq", "psrReq", "rsfReq", "drrReq", "maxFileSize", "submittedAOS", "traInterfActiveOutputNet", "filePrimaryNetId", "transactionalPrimaryNetId", "productList" ] }, "ParticipantOperationDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API response creation", "$ref": "#/components/schemas/DateTime" }, "operationDetails": { "$ref": "#/components/schemas/OperationDetails" }, "participantOperationDetails": { "$ref": "#/components/schemas/ParticipantOperationDetails" }, "apOperationDetails": { "description": "The BIC to which the operation refers", "$ref": "#/components/schemas/ApOperationDetails" }, "massiveInsertDetails": { "type": "array", "items": { "$ref": "#/components/schemas/MassiveInsertDetails" } } }, "required": [ "operationDetails" ] }, "PaymentDetails": { "type": "object", "properties": { "isReceptionDate": { "description": "Defines the search date criterion between:\n- 0: acceptance date\n- 1: reception date.\n\n **Validation Rule(s)** Must be 0,1. (ErrorCode XA13)", "$ref": "#/components/schemas/IsReceptionDate" }, "acceptanceReceptionDate": { "description": "Date to be used for both acceptance and reception search criteria.\n\n **Validation Rule(s)** It must not be greater than the current date (ErrorCode DT01)\n\nIf isReceptionDate is 1: the\nacceptanceReceptionDate + timeFrom + timeTo must be used to search the transactions by reception date criterion.\n\nIf isReceptionDate is 0: the\nacceptanceReceptionDate + timeFrom + timeTo must be used to search the transactions by the oldest AcceptanceDateTime ( AT-T056 ) of the IPs that will be returned in the API Response", "$ref": "#/components/schemas/Date" }, "timeFrom": { "description": "The oldest timestamp of the sending or receiving of the transactions by the system.\nFormat: HH:MM:SS\n\n **Validation Rule(s)** If isReceptionDate is 1 timeFrom is mandatory and the time interval timeFrom – timeTo must be shorter than one hour. (ErrorCode DT01)", "$ref": "#/components/schemas/Time" }, "timeTo": { "description": "The greatest timestamp of the sending or receiving of the transactions by the system.\nFormat: HH:MM:SS\n\n **Validation Rule(s)** If isReceptionDate is 1 timeTo is mandatory and the time interval timeFrom – timeTo must be shorter than one hour. (ErrorCode DT01)", "$ref": "#/components/schemas/Time" }, "transactionId": { "description": "The identification of the transaction", "$ref": "#/components/schemas/TransactionId" }, "debtorBic": { "description": "The Debtor Agent of the transaction", "$ref": "#/components/schemas/Bic11" }, "creditorBic": { "description": "RT1 BIC whose position will be updated, can be a LP or one of his LSPs.", "$ref": "#/components/schemas/Bic11" }, "instructingBic": { "description": "The Instructing Agent of the transaction\n\n **Validation Rule(s)** Either the InstructingBic or the InstructedBic must be equal to the SenderBic (ErrorCode XA07). If the InstructingBic is the SenderBic only the IPs sent from the SenderBIC to the system are returned.", "$ref": "#/components/schemas/Bic8" }, "instructedBic": { "description": "The Instructed Agent of the transaction\n\n **Validation Rule(s)** Either the InstructingBic or the InstructedBic must be equal to the SenderBic (ErrorCode XA07). If the InstructedBic is the SenderBic only the IPs sent from the system to the SenderBic are returned.", "$ref": "#/components/schemas/Bic8" }, "ipStatus": { "description": "The status of the IP\n\n **Validation Rule(s)** It can assume only one of the configured values on the system. The possible values are:\n“PBB” Processed by the Beneficiary Bank\n“RBB” Rejected by the Beneficiary Bank\n“RBE” Rejected by EBA\n“PBE” Processed by EBA\n“RBC” Rejected by SCT Inst\n“PEN” Pending\n\"WTG\" Waiting (only retrieve in-flight non-time critical transactions)\n (ErrorCode XA03)", "$ref": "#/components/schemas/IpStatus" }, "lac": { "description": "The LAC of the IP\n\n **Validation Rule(s)** It must be one of the configured Checkpoint in the system (ErrorCode XA03)", "$ref": "#/components/schemas/LacNumber" }, "endToEndID": { "description": "The End to End Id.\n\n **Validation Rule(s)** It must correspond to an End to End Id present in the Database (error XA03 – unknown value in the system)", "$ref": "#/components/schemas/EndToEndID" }, "csm": { "description": "The Clearing and Settlement Mechanism by which transactions were processed.\n\n **Validation Rule(s)** It must be one of the configured vaue:\nRT1: Transaction Settled in RT1;\nRT1-TIPS: Transaction settled in TIPS though RT1 Techenical Account;\nTIPS: Transaction settlend in TIPS on DCA account\n(ErrorCode XA03)", "$ref": "#/components/schemas/Csm1" }, "amountRange": { "$ref": "#/components/schemas/AmountRange" }, "productId": { "description": "Field used to filter transaction for configured defaultProduct\n\n **Validation Rule(s)** Product must be a defaultProduct defined in the system (ErrorCode XA03)\nThe SenderBIC must be configured for the chosen product.\n(ErrorCode XA13)", "$ref": "#/components/schemas/ProductId1" } }, "required": [ "isReceptionDate", "acceptanceReceptionDate", "csm", "productId" ] }, "PaymentDetails1": { "type": "object", "properties": { "isReceptionDate": { "description": "Defines the type of the date return in\nacceptanceReceptionDateTime.\nIf isReceptionDate = 0 is the acceptance date and time\nIf isReceptionDate = 1 is reception date and time", "$ref": "#/components/schemas/IsReceptionDate" }, "acceptanceReceptionDateTime": { "description": "The AcceptanceDateTime of the IP (Mandatory if the section is present)\nIf isReceptionDate is 1 is the transaction reception date\nIf isReceptionDate is 0 is the acceptance date and time of the IP", "$ref": "#/components/schemas/ZonedDateTime" }, "transactionId": { "description": "The identification of the original transaction IP (Mandatory if the section is present)", "$ref": "#/components/schemas/TransactionId" }, "debtorBic": { "description": "The debtor agent of the IP (Mandatory if the section is present)", "$ref": "#/components/schemas/Bic11" }, "creditorBic": { "description": "RT1 BIC whose position will be updated, can be a LP or one of his LSPs. (Mandatory if the section is present)", "$ref": "#/components/schemas/Bic11" }, "instructingBic": { "description": "The instructing agent of the IP (Mandatory if the section is present)", "$ref": "#/components/schemas/Bic8" }, "instructedBic": { "description": "The BIC of the instructed agent of the IP or the BIC of the Central System if the transaction was rejected by RT1 without completion of the Routing process (Mandatory if the section is present)", "$ref": "#/components/schemas/Bic8" }, "credSettMethod": { "description": "The Settlement Method of the creditor agent.\nPossible values are:\n• “LQPS” (LiQuidity PoSition) – Clearing intra-RT1 and, if required, set-tlement with liquidity position;\n• “RT1A” (RT1 technical Account) – Clearing cross-systems (e.g. RT1-TIPS) and settlement with RT1 AS Technical Account;\n• TDCA (TIPS DCA) – Clearing cross-systems (e.g. RT1-TIPS) and, if required, settlement with TIPS DCA.", "$ref": "#/components/schemas/CredSettMethod" }, "debSettMethod": { "description": "The Settlement Method of the debtor agent.\nPossible values are:\n• “LQPS” (LiQuidity PoSition) – Clearing intra-RT1 and, if required, set-tlement with liquidity position;\n• “RT1A” (RT1 technical Account) – Clearing cross-systems (e.g. RT1-TIPS) and settlement with RT1 AS Technical Account;\n• TDCA (TIPS DCA) – Clearing cross-systems (e.g. RT1-TIPS) and, if required, settlement with TIPS DCA.", "$ref": "#/components/schemas/DebSettMethod" }, "amount": { "description": "The amount of the IP (Mandatory if the section is present)", "$ref": "#/components/schemas/Amount" }, "ipStatus": { "description": "The status of the IP ref. 10.10. The possible values are:\n“PBB” Processed by the Beneficiary Bank\n“RBB” Rejected by the Beneficiary Bank\n“RBE” Rejected by EBA\n“PBE” Processed by EBA\n“RBC” Rejected by SCT Inst\n“PEN” Pending\n\"WTG\" Waiting (only retrieve in-flight non-time critical transactions)\n (Mandatory if the section is present)", "$ref": "#/components/schemas/IpStatus" }, "reasonCode": { "description": "The reason code associated to the status of the IP: it is mandatory if the payment was rejected (IPStatus is “RBB”, “RBC” or “RBE”), otherwise it is not present", "$ref": "#/components/schemas/ReasonCode" }, "lac": { "description": "The LAC in which the IP was received and processed (Mandatory if the section is present)", "$ref": "#/components/schemas/LacNumber" }, "endToEndID": { "description": "The End to End Id (mandatory if section is present).", "$ref": "#/components/schemas/EndToEndID" }, "productId": { "description": "Product of the payment", "$ref": "#/components/schemas/ProductId1" } }, "required": [ "isReceptionDate", "acceptanceReceptionDateTime", "transactionId", "debtorBic", "creditorBic", "instructingBic", "instructedBic", "amount", "ipStatus", "lac", "endToEndID", "productId" ] }, "PaymentDetails2": { "type": "object", "properties": { "acceptanceDateTime": { "description": "The AcceptanceDateTime of the IP", "$ref": "#/components/schemas/ZonedDateTime" }, "transactionId": { "description": "The identifier of the transaction", "$ref": "#/components/schemas/TransactionId" }, "debtorBic": { "description": "The debtor agent of the IP present in the request", "$ref": "#/components/schemas/Bic11" }, "trxDirection": { "description": "Direction of transaction", "$ref": "#/components/schemas/TrxDirection" }, "instructedAmt": { "description": "Amount of transaction in original currency (non-euro leg)", "$ref": "#/components/schemas/Amount" }, "originalCurrency": { "description": "Code of original currency of transaction (non-euro leg)", "$ref": "#/components/schemas/OriginalCurrency" }, "uetr": { "description": "UETR", "$ref": "#/components/schemas/Uetr" } }, "required": [ "acceptanceDateTime", "transactionId", "debtorBic" ] }, "PaymentDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria21" } }, "required": [ "dateTime", "criteria" ] }, "PaymentDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "paymentDetails": { "$ref": "#/components/schemas/PaymentDetails2" }, "interbankSettlementDate": { "description": "The Settlement Date of the IP", "$ref": "#/components/schemas/Date" }, "creditorBic": { "description": "RT1 BIC whose position will be updated, can be a LP or one of his LSPs", "$ref": "#/components/schemas/Bic11" }, "instructingBic": { "description": "The instructing agent of the IP", "$ref": "#/components/schemas/Bic8" }, "instructedBic": { "description": "The BIC of the instructed agent of the IP or the BIC of the Central System if the transaction was rejected by RT1 without completion of the Routing process", "$ref": "#/components/schemas/Bic8" }, "amount": { "description": "The amount of the IP", "$ref": "#/components/schemas/Amount" }, "acceptanceTime": { "description": "The AcceptanceTime of the Originator Bank", "$ref": "#/components/schemas/Time" }, "productId": { "description": "The Product of the transaction", "$ref": "#/components/schemas/ProductId" }, "aos": { "description": "The AOS of the transaction", "$ref": "#/components/schemas/Aos" }, "receptionTime": { "description": "The system time of the IP reception from the Originator Bank", "$ref": "#/components/schemas/Time" }, "sendingTime": { "description": "The system time of the IP sending to the Beneficiary Bank", "$ref": "#/components/schemas/Time" }, "confirmationTime": { "description": "The system time of the confirmation reception from the Beneficiary Bank", "$ref": "#/components/schemas/Time" }, "sendingConfirmationTime": { "description": "The system time of the confirmation sending to the Originator Bank", "$ref": "#/components/schemas/Time" }, "ipStatus": { "description": "The status of the IP. The possible values are:\n“PBB” Processed by the Beneficiary Bank\n“RBB” Rejected by the Beneficiary Bank\n“RBE” Rejected by EBA\n“PBE” Rejected by EBA\n“RBC” Rejected by SCT Inst\n“PEN” Pending\n\"WTG\" Waiting (only retrieve in-flight non-time critical transactions)", "$ref": "#/components/schemas/IpStatus1" }, "reasonCode": { "description": "The reason code associated to the status of the IP: it is mandatory if the IP Status is Rejected, by CSM or by the Beneficiary Bank, otherwise it is not present", "$ref": "#/components/schemas/ReasonCode" } }, "required": [ "dateTime" ] }, "PaymentStatus": { "type": "string", "enum": [ "PSTL", "STLD", "CAND", "FNLD", "RJTD", "FAIL" ], "examples": [ "PSTL" ] }, "PrimaryFileIntRecNetId": { "type": "string", "maxLength": 100, "examples": [ "EAS" ] }, "PrimaryRecNetId": { "type": "string", "maxLength": 100, "examples": [ "EAS" ] }, "PrimarySendNetId": { "type": "string", "maxLength": 100, "examples": [ "EAS" ] }, "ProcessingType": { "type": "string", "maxLength": 4, "examples": [ "BLCK" ] }, "Product": { "type": "string", "minLength": 4, "maxLength": 4, "examples": [ "INST" ] }, "ProductId": { "type": "string", "maxLength": 4, "examples": [ "INST" ] }, "ProductId1": { "type": "string", "minLength": 4, "maxLength": 4, "examples": [ "INST" ] }, "ProductId2": { "type": "string", "pattern": "[0-9A-Z]", "minLength": 4, "maxLength": 4, "examples": [ "INST" ] }, "ProductId3": { "type": "string", "pattern": "[0-9A-Z]", "maxLength": 4, "examples": [ "INST" ] }, "ProductIds": { "type": "string", "pattern": "[0-9A-Z]", "maxLength": 40, "examples": [ "INST" ] }, "ProductList": { "type": "object", "properties": { "productId": { "description": "Product of the participant", "$ref": "#/components/schemas/ProductId1" } }, "required": [ "productId" ] }, "ProductList1": { "type": "object", "properties": { "productId": { "description": "The identifier of the Product (Mandatory if the section is present)", "$ref": "#/components/schemas/ProductId" }, "primaryRecNetId": { "description": "The primary receiving network identification for the ProductId (Mandatory if the section is present)\nCan be the same provider of Secondary Network", "$ref": "#/components/schemas/PrimaryRecNetId" }, "secondaryRecNetId": { "description": "The secondary receiving network identification for the ProductId\nCan be the same provider of Primary Network", "$ref": "#/components/schemas/SecondaryRecNetId" }, "primarySendNetId": { "description": "The primary sending network identification for the ProductId (Mandatory if the section is present)\nCan be the same provider of Secondary Network", "$ref": "#/components/schemas/PrimarySendNetId" }, "secondarySendNetId": { "description": "The secondary sending network identification for the ProductId\nCan be the same provider of Primary Network", "$ref": "#/components/schemas/SecondarySendNetId" }, "admissionProfile": { "description": "The admission profile (Mandatory if the section is present)", "$ref": "#/components/schemas/AdmissionProfile" } }, "required": [ "productId", "primaryRecNetId", "primarySendNetId", "admissionProfile" ] }, "ProductList2": { "type": "object", "properties": { "actionType": { "description": "The type of action that must be applied to the ProductId\n\n **Validation Rule(s)** Mandatory only if the section is present (ErrorCode XA04).\nIt can contain only :\n- “INS” to insert the ProductId among the ones subscribed by the DP\n- “UPD” to update a ProductId already subscribed by the DP\n- “RMV” to remove a ProductId that was subscribed by the Participant (ErrorCode XA07)", "$ref": "#/components/schemas/ActionType" }, "productId": { "description": "The identifier of the product\n\n **Validation Rule(s)** Mandatory only if the section is present (ErrorCode XA04).\nIt must be a product id configured in the system (ErrorCode XA03)\nList of products can’t include a Product if corresponding defaultProduct is not included (Error Code XA03)", "$ref": "#/components/schemas/ProductId" }, "primaryRecNetId": { "description": "The primary receiving network identification for the ProductId\nCan be the same provider of Secondary Network\n\n **Validation Rule(s)** Mandatory only if the section is present and the ActionType is “INS” (ErrorCode XA04).", "$ref": "#/components/schemas/PrimaryRecNetId" }, "secondaryRecNetId": { "description": "The secondary receiving network identification for the ProductId Can be the same provider of Sec.Network", "$ref": "#/components/schemas/SecondaryRecNetId" }, "primarySendNetId": { "description": "The primary sending network identification for the ProductId Can be the same provider of Secondary Network\n\n **Validation Rule(s)** Mandatory only if the section is present and the ActionType is “INS” (ErrorCode XA04).", "$ref": "#/components/schemas/PrimarySendNetId" }, "secondarySendNetId": { "description": "The secondary sending network identification for the ProductId Can be the same provider of Primary Network", "$ref": "#/components/schemas/SecondarySendNetId" }, "admissionProfile": { "description": "The admission profile\n\n **Validation Rule(s)** Mandatory only if the section is present and the ActionType is “INS” (ErrorCode XA04).\nIt can contain one of the following accepted values:\n“CAD” - for a Participant or Addressable PSP that acts as both Creditor and Debtor Bank\n“CRD” - for a Participant or Addressable PSP that only acts as a Creditor only Bank\n(ErrorCode XA03)", "$ref": "#/components/schemas/AdmissionProfile" } }, "required": [ "actionType", "productId" ] }, "ProductList3": { "type": "object", "properties": { "productId": { "description": "Product of the Aps", "$ref": "#/components/schemas/ProductId1" } }, "required": [ "productId" ] }, "ProductList4": { "type": "object", "properties": { "productId": { "description": "Product subscribed by the AP (Mandatory if the section is present)", "$ref": "#/components/schemas/ProductId2" }, "admissionProfile": { "description": "The admission profile of the AP (Mandatory if the section is present)", "$ref": "#/components/schemas/AdmissionProfile" } }, "required": [ "productId", "admissionProfile" ] }, "ProductList5": { "type": "object", "properties": { "productId": { "description": "Product subscribed by the AP (Mandatory if the section is present)\n\n **Validation Rule(s)** List of products can’t include a Product if corresponding defaultProduct is not included (Error Code XA03)\nThe SenderBIC must be configured for the chosen product. (ErrorCode XA13)", "$ref": "#/components/schemas/ProductId3" }, "admissionProfile": { "description": "The admission profile of the AP\n\n **Validation Rule(s)** It can contain only a configured value in the system (ErrorCode XA03)", "$ref": "#/components/schemas/AdmissionProfile" } }, "required": [ "productId", "admissionProfile" ] }, "ProductList6": { "type": "object", "properties": { "productId": { "description": "Product subscribed by the AP (Mandatory if the section is present)\n\n **Validation Rule(s)** List of products can’t include a Product if corresponding defaultProduct is not included (Error Code XA03)\nThe SenderBIC must be configured for the chosen product. (ErrorCode XA13)", "$ref": "#/components/schemas/ProductId3" }, "admissionProfile": { "description": "The admission profile of the AP\n\n **Validation Rule(s)** It can contain only a configured value in the system. The possible values are:", "$ref": "#/components/schemas/AdmissionProfile" } }, "required": [ "productId", "admissionProfile" ] }, "ProductList7": { "type": "object", "properties": { "productId": { "description": "The identifier of the product.", "$ref": "#/components/schemas/ProductId" }, "primaryRecNetId": { "description": "The primary receiving network identification for the ProductId\nCan be the same provider of Secondary Network", "$ref": "#/components/schemas/PrimaryRecNetId" }, "primarySendNetId": { "description": "The primary sending network identification for the ProductId Can be the same provider of Secondary Network", "$ref": "#/components/schemas/PrimarySendNetId" }, "secondaryRecNetId": { "description": "The secondary receiving network identification for the ProductId\nCan be the same provider of Secondary Network", "$ref": "#/components/schemas/SecondaryRecNetId" }, "secondarySendNetId": { "description": "The secondary sending network identification for the ProductId Can be the same provider of Primary Network", "$ref": "#/components/schemas/SecondarySendNetId" }, "admissionProfile": { "description": "The admission profile (Mandatory if the section is present). Possible values are:\n“CAD” - for a Participant or Addressable PSP that acts as both Creditor and Debtor Bank\n“CRD” - for a Participant or Addressable PSP that only acts as a Creditor only Bank", "$ref": "#/components/schemas/AdmissionProfile1" } }, "required": [ "productId", "primaryRecNetId", "primarySendNetId", "admissionProfile" ] }, "ProductsUnavailable": { "type": "string", "pattern": "[0-9A-Z]", "maxLength": 35, "examples": [ "INST" ] }, "PrrData": { "type": "object", "properties": { "numSentPRR": { "description": "It is the sum of the following fields:\nNumRjtPRR,\nNumHeldPRR ,\nNumSettledPRR.", "$ref": "#/components/schemas/NumSentPRR" }, "numRjtPRR": { "description": "The number of PRR that were received from the SenderBic and rejected by SCT Inst.", "$ref": "#/components/schemas/NumRjtPRR" }, "numSettledPRR": { "description": "The number of PRR that were received from the SenderBic and positively processed.", "$ref": "#/components/schemas/NumSettledPRR" }, "amountSentPRR": { "description": "It is the sum of the following fields:\nAmountRjtPRR\nAmountHeldPRR\nAmountSettledPRR", "$ref": "#/components/schemas/Amount" }, "amountRjtPRR": { "description": "The sum of the values of the PRR transactions included in the NumRjtPRR", "$ref": "#/components/schemas/Amount" }, "amountSettledPRR": { "description": "The sum of the values of the PRR transactions included in the NumSettledPRR field", "$ref": "#/components/schemas/Amount" } } }, "PrrData1": { "type": "object", "properties": { "numSentPRR": { "description": "It is the sum of the following fields:\nNumRjtPRR,\nNumSettledPRR.", "$ref": "#/components/schemas/NumSentPRR" }, "numRjtPRR": { "description": "The number of PRR that were received from the SenderBic and rejected by SCT Inst", "$ref": "#/components/schemas/NumRjtPRR" }, "numSettledPRR": { "description": "The number of PRR that were received from the SenderBic and positively processed.", "$ref": "#/components/schemas/NumSettledPRR" }, "amountSentPRR": { "description": "It is the sum of the following fields:\nAmountRjtPRR\nAmountSettledPRR.", "$ref": "#/components/schemas/Amount" }, "amountRjtPRR": { "description": "The sum of the values of the returns transactions included in the NumRjtPRR", "$ref": "#/components/schemas/Amount" }, "amountSettledPRR": { "description": "The sum of the values of the returns transactions included in the NumSettledPRR field", "$ref": "#/components/schemas/Amount" } } }, "PrrDataDRR": { "type": "object", "properties": { "numHeldPRR": { "description": "For future use, currently set to 0.", "$ref": "#/components/schemas/NumHeldPRR" }, "amountHeldPRR": { "description": "The sum of the values of the PRR transactions included in the NumHeldPRR field", "$ref": "#/components/schemas/Amount" }, "prrData": { "$ref": "#/components/schemas/PrrData" } } }, "PsrReq": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "PsrReq1": { "type": "string", "enum": [ "0", "1" ], "maxLength": 1, "examples": [ "0" ] }, "Reason": { "type": "string", "examples": [ "CNOR" ] }, "ReasonCode": { "type": "string", "maxLength": 4, "examples": [ "AB06" ] }, "ReasonCodeToBB": { "type": "string", "maxLength": 4, "examples": [ "AB06" ] }, "ReasonCodeToOB": { "type": "string", "maxLength": 4, "examples": [ "AB06" ] }, "RecallData": { "type": "object", "properties": { "numSentRecall": { "description": "The number of Recall instructions received from the SenderBic by the system. This counter includes also the rejected by SCT Inst.", "$ref": "#/components/schemas/NumSentRecall" }, "numRjtRecall": { "description": "The number of Recall instructions received from the SenderBic that were rejected by the system", "$ref": "#/components/schemas/NumRjtRecall" }, "amountSentRecall": { "description": "The sum of the values of the Recall transactions included in the NumSentRecall field", "$ref": "#/components/schemas/Amount" }, "amountRjtRecall": { "description": "The sum of the values of the Recall transactions included in the NumRjtRecall field", "$ref": "#/components/schemas/Amount" } } }, "RecallData1": { "type": "object", "properties": { "numSentRecall": { "description": "The number of Recall instructions received from the SenderBic by the system", "$ref": "#/components/schemas/NumSentRecall" }, "numRjtRecall": { "description": "The number of Recall instructions received from the SenderBic that were rejected by the system", "$ref": "#/components/schemas/NumRjtRecall" }, "amountSentRecall": { "description": "The sum of the values of the Recall transactions included in the NumSentRecall field", "$ref": "#/components/schemas/Amount" }, "amountRjtRecall": { "description": "The sum of the values of the Recall transactions included in the NumRjtRecall field", "$ref": "#/components/schemas/Amount" } } }, "RecordType": { "type": "string", "maxLength": 4, "examples": [ "HDRR" ] }, "Reference": { "type": "string", "maxLength": 35, "examples": [ "ID028472018304" ] }, "ReferenceId": { "type": "string", "maxLength": 22, "examples": [ "ID028472018304" ] }, "ReferenceId1": { "description": "referenceId", "type": "string", "maxLength": 22, "examples": [ "ID028472018304" ] }, "ReferenceId2": { "description": "reference Id", "type": "string", "maxLength": 22, "examples": [ "ID028472018304" ] }, "RejectParticipantOperationResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API response creation", "$ref": "#/components/schemas/DateTime" }, "operationItem": { "$ref": "#/components/schemas/OperationItem" } }, "required": [ "dateTime", "operationItem" ] }, "ReleaseInfo": { "type": "object", "properties": { "amount": { "description": "The amount to be defunded\n\n **Validation Rule(s)** • The involved Position must be greater than or equal to the Amount\n• The Amount cannot be greater than 999999999999.99\n• If the position is shared in a branchFundsBalance, the Liquidity Position of the branchFundsBalance must not be lesser than the Amount to be defunded\n(ErrorCode XA05)\nThe Amount cannot be equal to zero (ErrorCode XA05)\nOnly decimal notation is allowed (XA05).", "$ref": "#/components/schemas/Amount1" }, "lspBic": { "description": "The BIC of the LSP whose liquidity is managed by the SenderBic. If present, the system will defund the Amount from the LSPBic liquidity.\n\n **Validation Rule(s)** • The LSPBic liquidity must be managed by its LP, and its LP must be equal to the SenderBic (ErrorCode XA14)\n• LSPBic must be a not-suspended Participant (ErrorCode PY01)\nIt must not be present contemporarily with the pair MemberBic and branchFundsBalanceId (ErrorCode XA17)", "$ref": "#/components/schemas/Bic8" }, "memberBic": { "description": "The BIC of the Member for which it is requested the defunding of liquidity\n\n **Validation Rule(s)** Mandatory if the branchFundsBalanceId is present (ErrorCode XA04)\nThe MemberBic must belong to the specified branchFundsBalanceId and must not be suspended(ErrorCode XA06)\nIt must not be present contemporarily with LSPBic (ErrorCode XA17)", "$ref": "#/components/schemas/Bic8" }, "branchFundsBalanceId": { "description": "The id of the branchFundsBalance to which the MemberBic belongs.\n\n **Validation Rule(s)** Mandatory if MemberBic is present (ErrorCode XA04 )\nIt must not be present contemporarily with LSPBic (ErrorCode XA17)", "$ref": "#/components/schemas/BranchFundsBalanceId" } }, "required": [ "amount" ] }, "RequestedThrough": { "type": "string", "enum": [ "A2A", "U2A" ], "maxLength": 3, "examples": [ "A2A" ] }, "RequestedThrough1": { "type": "string", "enum": [ "A2A", "U2A" ], "examples": [ "A2A" ] }, "RequesterPBICCode": { "type": "string", "minLength": 8, "maxLength": 11, "examples": [ "IPSDPF21XXX" ] }, "RequestId": { "description": "Request Identification.", "type": "string", "maxLength": 36, "examples": [ "6567cd11-207a-4318-839b-182f2199139e" ] }, "RequestId1": { "type": "string", "maxLength": 36, "examples": [ "6567cd11-207a-4318-839b-182f2199139e" ] }, "Requestor": { "type": "string", "maxLength": 20, "examples": [ "ID20391" ] }, "Requestor1": { "type": "string", "maxLength": 8, "examples": [ "ID20391" ] }, "RequestStatus": { "type": "string", "enum": [ "ATH", "WTG", "EXE", "RJS" ], "examples": [ "ATH" ] }, "RequestStatus1": { "type": "string", "enum": [ "ATH", "RJS" ], "examples": [ "ATH" ] }, "RequestStatus2": { "type": "string", "maxLength": 3, "examples": [ "ATH" ] }, "ResetToBasePosition": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "Response": { "type": "object", "properties": { "lspBic": { "description": "The LSPBic contained in the request", "$ref": "#/components/schemas/Bic8" }, "bicExceptionDayValues": { "description": "The following section is present only if the LSPBic is present and it is repeated as many times as the LACs are.", "type": "array", "items": { "$ref": "#/components/schemas/BicExceptionDayValues" } }, "memberBic": { "description": "The MemberBIC contained in the request", "$ref": "#/components/schemas/Bic8" }, "branchFundsBalanceId": { "description": "The branchFundsBalanceId contained in the request", "$ref": "#/components/schemas/BranchFundsBalanceId" }, "businessDate": { "description": "The BusinessDate contained in the request", "$ref": "#/components/schemas/Date" }, "memberExceptionDayValues": { "description": "The following section is repeated as many times as the LACs are.", "type": "array", "items": { "$ref": "#/components/schemas/MemberExceptionDayValues" } } } }, "Response1": { "type": "object", "properties": { "lspbranchFundsBalanceMemBic": { "description": "corresponding to the BIC of the Participant, of the LSP or of the branchFundsBalance Member BIC", "$ref": "#/components/schemas/Bic8" }, "numInstructions": { "description": "The total number of instructions listed in the following section", "$ref": "#/components/schemas/NumInstructions" }, "instructions": { "description": "The following section is repeated as many times as the rows satisfying the request are.", "type": "array", "items": { "$ref": "#/components/schemas/Instructions" } } }, "required": [ "numInstructions" ] }, "ResponseList": { "type": "object", "properties": { "name": { "description": "It is the name of the DP", "$ref": "#/components/schemas/Name" }, "bic": { "description": "The panticipant BIC", "$ref": "#/components/schemas/Bic8" }, "technicalBic": { "description": "It indicates if the BIC is a technical one (1) or not (0)", "$ref": "#/components/schemas/TechnicalBic1" }, "lsp": { "description": "It indicates if the BIC is served for Liquidity Funding/Defunding (value Yes) or not (value No)", "$ref": "#/components/schemas/Lsp" }, "tipsAccountOwnerBic": { "description": "TIPS DCA Account Owner for Instra-Service Liquidity Transfer (li-quidity funding/defunding)", "$ref": "#/components/schemas/Bic11Only" }, "tipsUserBic": { "description": "BIC used for reachability in TIPS through a DCA account", "$ref": "#/components/schemas/Bic11Only" }, "submittedAOSinst": { "description": "The AOS associated to INST defaultProduct subscribed by the Participant.", "$ref": "#/components/schemas/AOSList" }, "submittedAOSeolo": { "description": "The AOS associated to EOLO defaultProduct subscribed by the Participant.", "$ref": "#/components/schemas/AOSList" }, "status": { "description": "The current status of the DP", "$ref": "#/components/schemas/Status3" }, "initValidityDate": { "description": "The initial date of validity of the configured DP", "$ref": "#/components/schemas/Date" }, "endValidityDate": { "description": "The end date of validity of the configured DP", "$ref": "#/components/schemas/Date" }, "tipsAdherence": { "description": "It indicates if the Participant joined to TIPS (1) or not (0) (Mandatory if the section is present)", "$ref": "#/components/schemas/TipsAdherence" }, "network": { "description": "Field used to filter Participant for the Network Channel used", "$ref": "#/components/schemas/Network" }, "newBic": { "description": "The new BIC of Participant following a “Change BIC” operation.", "$ref": "#/components/schemas/Bic8" }, "newRole": { "description": "The new Role indicator :\n• “N” – no “Change Role” operation has been requested;\n• “Y” – the Participant has changed their Role.", "$ref": "#/components/schemas/NewRole1" }, "productList": { "description": "List of products", "type": "array", "items": { "$ref": "#/components/schemas/ProductList" } } }, "required": [ "bic", "technicalBic", "lsp", "name", "status", "initValidityDate", "endValidityDate", "productList" ] }, "ResponseList1": { "type": "object", "properties": { "operationType": { "description": "The operation type.\nValues allowed:\n- “INS” Inserted\n- “REM” Removed\n- “UPD” Updated\n- “MIN” Massive Insert\n- “RNL” R-only\n- \"MOD\" Amend\n- \"REV\" Revoke\n- “ACP” APSP Change P.", "$ref": "#/components/schemas/OperationType1" }, "referenceId": { "description": "Unique reference ID of the operation", "$ref": "#/components/schemas/ReferenceId" }, "critical": { "description": "This flag indicates if the operation is critical or not-critical", "$ref": "#/components/schemas/Critical" }, "status": { "description": "The status of the participant operation.\nValues allowed:\nWTG: waiting;\nSUB: submitted;\nATH: authorized;\nRJT rejected\nEXE: executed", "$ref": "#/components/schemas/Status7" }, "requestor": { "description": "The user who submitted the operation", "$ref": "#/components/schemas/Requestor" }, "dateOfRequest": { "description": "Submission date", "$ref": "#/components/schemas/Date" }, "confirmer": { "description": "The user Id of the user who confirmed the operation. Applicable only in case of “Critical” operation", "$ref": "#/components/schemas/Confirmer" }, "dateOfConfirm": { "description": "The date of the confirmation by Participant User. Applicable only in case of “Critical” operation", "$ref": "#/components/schemas/DateOfConfirm" }, "authorizer": { "description": "The user who authorized/rejected the operation", "$ref": "#/components/schemas/Authorizer" }, "dateOfExecution": { "description": "Date at which the operation went live", "$ref": "#/components/schemas/Date" } }, "required": [ "operationType", "referenceId", "critical", "status", "requestor", "dateOfRequest", "authorizer", "dateOfExecution" ] }, "ResponseList2": { "type": "object", "properties": { "bic": { "description": "The BIC to which the parameters are applied", "$ref": "#/components/schemas/Bic8" }, "incThrottDayId": { "description": "Possible values are: ID01, ID02, ID03, ID04, ID05, ID06, ID07, ID08, ID09, ID10", "$ref": "#/components/schemas/ThrottDayId" }, "incThrottDay": { "description": "Rate of transaction per second to be reached for throttling to activate per Traffic to RT1 during High Volume Hours", "$ref": "#/components/schemas/ThrottNumber" }, "incThrottNightId": { "description": "Possible values are: ID01, ID02, ID03, ID04, ID05, ID06, ID07, ID08, ID09, ID10", "$ref": "#/components/schemas/ThrottDayId" }, "incThrottNight": { "description": "Rate of transaction per second to be reached for throttling to activate per Traffic to RT1 during Low Volume Hours", "$ref": "#/components/schemas/ThrottNumber" }, "outThrottDayId": { "description": "Possible values are: ID01, ID02, ID03, ID04, ID05, ID06, ID07, ID08, ID09, ID10", "$ref": "#/components/schemas/ThrottDayId" }, "outThrottDay": { "description": "Rate of transaction per second to be reached for throttling to activate per Traffic from RT1 during High Volume Hours. If the record for the requested BIC is not found, the values will be retrieved from the “Outgoing traffic during day default (tps)”.", "$ref": "#/components/schemas/ThrottNumber" }, "outThrottNightId": { "description": "Possible values are: ID01, ID02, ID03, ID04, ID05, ID06, ID07, ID08, ID09, ID10", "$ref": "#/components/schemas/ThrottDayId" }, "outThrottNight": { "description": "Rate of transaction per second to be reached for throttling to activate per Traffic from RT1 during Low Volume Hours. If the record for the requested BIC is not found, the values will be retrieved from the “Outgoing traffic during night default (tps)”.", "$ref": "#/components/schemas/ThrottNumber" } }, "required": [ "bic" ] }, "RestrictionTypeId": { "type": "string", "maxLength": 35, "examples": [ "BLCK" ] }, "ReturnAcctTp": { "type": "string", "maxLength": 4, "examples": [ "CFCN" ] }, "RoleChange": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "RoutingType": { "type": "string", "enum": [ "DIR", "ADR", "TPS" ], "maxLength": 3, "examples": [ "DIR" ] }, "RsfReq": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "RsfReq1": { "type": "string", "enum": [ "0", "1" ], "maxLength": 1, "examples": [ "0" ] }, "SecondaryFileIntRecNetId": { "type": "string", "maxLength": 100, "examples": [ "EAS" ] }, "SecondaryRecNetId": { "type": "string", "maxLength": 100, "examples": [ "EAS" ] }, "SecondarySendNetId": { "type": "string", "maxLength": 100, "examples": [ "EAS" ] }, "SendAccountQueryToTips": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "SenderBic": { "description": "Bic", "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}", "examples": [ "IPSDID21" ] }, "SenderBic1": { "description": "sender Bic", "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}", "examples": [ "IPSDID21" ] }, "SenderBic2": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}", "examples": [ "IPSDID21" ] }, "SenderPosition": { "type": "object", "properties": { "bic": { "description": "Sender BIC", "$ref": "#/components/schemas/Bic8" }, "sign": { "description": "“C” for Credit Amount, “D” for Debit Amount.", "$ref": "#/components/schemas/Sign" }, "amount": { "description": "Amount corresponding to the real-time Position of the Participant at the time of query", "$ref": "#/components/schemas/Amount" }, "timestamp": { "description": "TimeStamp of the moment the system retrieved the Position of the Participant", "$ref": "#/components/schemas/DateTime" } }, "required": [ "bic", "sign", "amount", "timestamp" ] }, "Sign": { "type": "string", "enum": [ "C", "D" ], "examples": [ "C" ] }, "Status": { "type": "string", "enum": [ "WTG", "STD", "RJT" ], "maxLength": 3, "examples": [ "WTG" ] }, "Status1": { "type": "string", "enum": [ "NTF", "RJS", "TSD", "STD", "ERR" ], "maxLength": 3, "examples": [ "NTF" ] }, "Status2": { "type": "string", "enum": [ "STD", "NTF", "ERR", "TSD", "RJS", "RCON", "RREJ" ], "maxLength": 4, "examples": [ "STD" ] }, "Status3": { "type": "string", "enum": [ "ALL", "ENB", "SUS", "DIS", "CNG", "INS", "RNL" ], "maxLength": 3, "examples": [ "ALL" ] }, "Status4": { "type": "string", "maxLength": 3, "examples": [ "CNG" ] }, "Status5": { "type": "string", "enum": [ "ALL", "CNG", "DIS", "ENB", "INS", "RNL", "SUS" ], "maxLength": 3, "examples": [ "ALL" ] }, "Status6": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "Status7": { "type": "string", "enum": [ "WTG", "SUB", "ATH", "RJT", "RJS", "EXE" ], "examples": [ "WTG" ] }, "SubmittedAOS": { "type": "string", "maxLength": 30, "examples": [ "A01" ] }, "Taw1End": { "type": "string", "examples": [ "2024-11-12:2024-11-11" ] }, "Taw1Start": { "type": "string", "examples": [ "2024-11-12:2024-11-11" ] }, "Taw2End": { "type": "string", "examples": [ "2024-11-12:2024-11-11" ] }, "Taw2Start": { "type": "string", "examples": [ "2024-11-12:2024-11-11" ] }, "TechnicalBic": { "type": "string", "enum": [ "0", "1" ], "maxLength": 1, "examples": [ "0" ] }, "TechnicalBic1": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "ThrottDayId": { "type": "string", "examples": [ "ID01" ] }, "ThrottNumber": { "type": "integer", "maximum": 9999, "examples": [ 1 ] }, "Time": { "description": "Standard ISO Time.", "type": "string", "pattern": "[0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(\\.[0-9]{1,6}){0,1}", "examples": [ "16:00:00" ] }, "TimeDDTHH": { "description": "Time of the specific instruction", "type": "string", "examples": [ "0.5731597222222222" ] }, "TimeDetails": { "type": "object", "properties": { "startTimeHighVolume": { "description": "Start Time for what will be regarded as High Volume Hours or Daytime for throttling parameters", "$ref": "#/components/schemas/TimeVolume" }, "startTimeLowVolume": { "description": "Start Time for what will be regarded as Low Volume Hours or Nighttime for throttling parameters", "$ref": "#/components/schemas/TimeVolume" } }, "required": [ "startTimeHighVolume", "startTimeLowVolume" ] }, "TimeVolume": { "type": "string", "examples": [ "16:00" ] }, "TipsAdherence": { "type": "string", "enum": [ "0", "1" ], "examples": [ "0" ] }, "TipsAdherence1": { "type": "string", "enum": [ "0", "1" ], "maxLength": 1, "examples": [ "0" ] }, "TipsCmbIdentifier": { "type": "string", "maxLength": 34, "examples": [ "CMB Id in Return Account camt.004" ] }, "TipsDCA": { "type": "string", "maxLength": 34, "examples": [ "123456IPHSITM0DCA0001" ] }, "TipsDcaAccountId": { "type": "string", "maxLength": 34, "examples": [ "1234" ] }, "TipsNetwOpt": { "type": "string", "enum": [ "EAS", "SWI" ], "maxLength": 3, "examples": [ "EAS" ] }, "TipsNetworkOption": { "type": "string", "maxLength": 3, "examples": [ "EAS" ] }, "TipsNetworkOption1": { "type": "string", "enum": [ "EAS", "SWI" ], "examples": [ "EAS" ] }, "TipsUserBic": { "type": "string", "maxLength": 11, "examples": [ "IPSDID21XXX" ] }, "TransactionalActiveOutputNet": { "type": "integer", "examples": [ 1 ] }, "TransactionalPrimaryNetId": { "type": "string", "maxLength": 3, "examples": [ "EAS" ] }, "TransactionalPrimaryNetId1": { "type": "string", "enum": [ "EAS", "EBX", "SWI" ], "examples": [ "EAS" ] }, "TransactionalPrimaryNetId2": { "type": "string", "enum": [ "EAS", "EBX", "SWI" ], "maxLength": 3, "examples": [ "EAS" ] }, "TransactionalSecondaryNetId": { "type": "string", "maxLength": 3, "examples": [ "EAS" ] }, "TransactionalSecondaryNetId1": { "type": "string", "enum": [ "EAS", "EBX", "SWI" ], "examples": [ "EAS" ] }, "TransactionalSecondaryNetId2": { "type": "string", "enum": [ "EAS", "EBX", "SWI" ], "maxLength": 3, "examples": [ "EAS" ] }, "TransactionDetails": { "type": "object", "properties": { "transactionId": { "description": "The identification of the transaction", "$ref": "#/components/schemas/TransactionId" }, "transactionType": { "description": "The type of transaction\n\n **Validation Rule(s)** It must be one of the configured values in the system (ErrorCode XA03).\nPRR = Positive Response to a Recall\nRCL = Recall\nNRR = Negative Response for a Recall\nINV = investigation\nPST = Payment Status Report\nCNR = Claim non-receipt (camt.027)", "$ref": "#/components/schemas/TransactionType1" }, "isReceptionDate": { "description": "Defines the search date criterion between:\n- 0: acceptance date\n- 1: reception date.\n\n **Validation Rule(s)** Must be 0,1. (ErrorCode XA13)", "$ref": "#/components/schemas/IsReceptionDate" }, "settlementReceptionDate": { "description": "If isReceptionDate is 1 the date must be used to search transaction for reception date.\nIf isReceptionDate is 0 the date must be used to search transaction for the settlement date of the transactions. The date of the AT-T056 field for “PST” and “INV” transaction types.\n\n **Validation Rule(s)** It must not be greater than the current date (ErrorCode DT01)", "$ref": "#/components/schemas/Date" }, "debtorBic": { "description": "The debtor agent of the transactions for R-messages, of the original transaction for “PST”, \"CNR\" and “INV” transaction type", "$ref": "#/components/schemas/Bic11" }, "creditorBic": { "description": "RT1 BIC whose position will be updated, can be a LP or one of his LSPs", "$ref": "#/components/schemas/Bic11" } }, "required": [ "transactionType", "isReceptionDate", "settlementReceptionDate" ] }, "TransactionDetails1": { "type": "object", "properties": { "transactionId": { "description": "The identification of the transaction (Mandatory if the section is present)", "$ref": "#/components/schemas/TransactionId" }, "transactionType": { "description": "The type of transaction (Mandatory if the section is present)\nPRR = Positive Response to a Recall\nRCL = Recall\nNRR = Negative Response for a Recall\nINV = Investigation\nPST = Payment Status Report\nCNR = Claim non-receipt (camt.027)", "$ref": "#/components/schemas/TransactionType1" }, "settlementDate": { "description": "The settlement date of the transaction for R-messages, or the AT-T056 date for “PST” and “INV” transaction type (Mandatory if the section is present)", "$ref": "#/components/schemas/Date" }, "debtorBic": { "description": "The debtor agent of the transaction for R-messages, of the original transaction for “PST”, \"CNR\" and “INV” transaction type", "$ref": "#/components/schemas/Bic11" }, "creditorBic": { "description": "RT1 BIC whose position will be updated, can be a LP or one of his LSPs", "$ref": "#/components/schemas/Bic11" } }, "required": [ "transactionId", "transactionType", "settlementDate" ] }, "TransactionDetails2": { "type": "object", "properties": { "transactionId": { "description": "The transaction identification contained in the request", "$ref": "#/components/schemas/TransactionId" }, "transactionType": { "description": "The type of the transaction contained in the request", "$ref": "#/components/schemas/TransactionType1" }, "settlementDate": { "description": "The settlement date of the transaction", "$ref": "#/components/schemas/Date" }, "debtorBic": { "description": "The debtor agent of the transaction of the transaction for R-messages only, of the original transaction for “PST”, \"CNR\" and “INV” transaction type", "$ref": "#/components/schemas/Bic11" }, "creditorBic": { "description": "RT1 BIC whose position will be updated, can be a LP or one of his LSPs", "$ref": "#/components/schemas/Bic11" }, "csm": { "description": "The Clearing and Settlement Mechanism that settled/processed the transaction,\n• “RT1” for messages entirely processed in SCT Inst;\n• “RT1-TIPS” for messages processed in TIPS through RT1 Technical Account; and\n• “TIPS” for for messages processed in TIPS through TIPS DCA Account", "$ref": "#/components/schemas/Csm1" }, "trxDirection": { "description": "Direction of transaction", "$ref": "#/components/schemas/TrxDirection" }, "instructedAmt": { "description": "Amount of transaction in original currency (non-euro leg)", "$ref": "#/components/schemas/Amount" }, "originalCurrency": { "description": "Code of original currency of transaction (non-euro leg)", "$ref": "#/components/schemas/OriginalCurrency" }, "uetr": { "description": "UETR", "$ref": "#/components/schemas/Uetr" } }, "required": [ "transactionId", "transactionType", "settlementDate" ] }, "TransactionDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria23" } }, "required": [ "dateTime", "criteria" ] }, "TransactionDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "Standard ISO Date-Time.", "$ref": "#/components/schemas/DateTime" }, "transactionDetails": { "$ref": "#/components/schemas/TransactionDetails2" }, "debtorSettlementMethod": { "description": "The Settlement Method of the debtor agent.\nPossible values are:\n• “LQPS” (LiQuidity PoSition) – Clearing intra-RT1 and, if required, set-tlement with liquidity position;\n• “RT1A” (RT1 technical Account) – Clearing cross-systems (e.g. RT1-TIPS) and settlement with RT1 AS Technical Account;\n• TDCA (TIPS DCA) – Clearing cross-systems (e.g. RT1-TIPS) and, if required, settlement with TIPS DCA.", "$ref": "#/components/schemas/DebtorSettlementMethod" }, "creditorSettlementMethod": { "description": "The Settlement Method of the creditor agent.\nPossible values are:\n• “LQPS” (LiQuidity PoSition) – Clearing intra-RT1 and, if required, set-tlement with liquidity position;\n• “RT1A” (RT1 technical Account) – Clearing cross-systems (e.g. RT1-TIPS) and settlement with RT1 AS Technical Account;\n• TDCA (TIPS DCA) – Clearing cross-systems (e.g. RT1-TIPS) and, if required, settlement with TIPS DCA.", "$ref": "#/components/schemas/CreditorSettlementMethod" }, "lac": { "description": "The LAC of the reception and processing of the transaction", "$ref": "#/components/schemas/LacNumber" }, "debitPartyBic": { "description": "The TIPS Account Owner BIC of the Debit Party.\nThis field is present only for SCT Inst Transaction and Positive Response for a Recall transaction.", "$ref": "#/components/schemas/Bic11Only" }, "creditPartyBic": { "description": "The TIPS Account Owner BIC of the Credit Party.\nThis field is present only for SCT Inst Transaction and Positive Response for a Recall transaction.", "$ref": "#/components/schemas/Bic11Only" }, "instructingBic": { "description": "The instructing agent of the transaction", "$ref": "#/components/schemas/Bic8" }, "instructedBic": { "description": "The BIC of the instructed agent of the transaction or the BIC of the Central System if the transaction was rejected by RT1 without completion of the Routing process", "$ref": "#/components/schemas/Bic8" }, "amount": { "description": "The amount of the transaction", "$ref": "#/components/schemas/Amount" }, "productId": { "description": "The Product of the transaction", "$ref": "#/components/schemas/ProductId" }, "aos": { "description": "The AOS of the transaction", "$ref": "#/components/schemas/Aos" }, "originalSettlementDate": { "description": "The settlement date of the original transaction, only for R-mgs transaction", "$ref": "#/components/schemas/Date" }, "originalTransactionId": { "description": "The identification of the original transaction, only for R-mgs transactions", "$ref": "#/components/schemas/OriginalTransactionId1" }, "originalAmount": { "description": "The amount of the original transaction, only for R-mgs transactions", "$ref": "#/components/schemas/Amount" }, "routingType": { "description": "The routing applied by the system to deliver the instruction, “DIR” for Direct , “ADR” for Addressable PSP or \"TPS\" for PSP reachable in TIPS", "$ref": "#/components/schemas/RoutingType" }, "transactionStatus": { "description": "The status of the transaction", "$ref": "#/components/schemas/TransactionStatus1" }, "reasonCode": { "description": "The reason code of the transaction.", "$ref": "#/components/schemas/ReasonCode" }, "reasonCodeToOB": { "description": "The reason code generated by the System and forwarded to the OB in pacs.002 message.", "$ref": "#/components/schemas/ReasonCodeToOB" }, "reasonCodeToBB": { "description": "The reason code generated by the System and forwarded to the BB in pacs.002 message.", "$ref": "#/components/schemas/ReasonCodeToBB" }, "receptionTime": { "description": "The timestamp when the transaction was received by SCT Inst Service from the Instructing Agent. (Time Zoned format: YYYY-MM-DD-hh.mm.ss.mmmmmm+hh:mm).", "$ref": "#/components/schemas/ZonedDateTime" }, "sendingTimeToOB": { "description": "The timestamp when the transaction was sent by SCT Inst Service to the OB of the payment/ original payment", "$ref": "#/components/schemas/ZonedDateTime" }, "sendingTimeToBB": { "description": "The timestamp when the transaction was sent by SCT Inst Service to the BB of the payment/ original payment", "$ref": "#/components/schemas/ZonedDateTime" }, "confirmationTimeFromBB": { "description": "The timestamp when the confirmation from the BB was received by the SCT Inst Service", "$ref": "#/components/schemas/ZonedDateTime" }, "confirmationTimeToBB": { "description": "The timestamp when the transaction was confirmed by the SCT Inst Service to the BB", "$ref": "#/components/schemas/ZonedDateTime" } }, "required": [ "dateTime" ] }, "TransactionId": { "type": "string", "maxLength": 35, "examples": [ "TXID20231003JMMVPACS8040" ] }, "Transactionid": { "type": "string", "examples": [ "TXID20231003JMMVPACS8040" ] }, "TransactionStatus": { "type": "string", "enum": [ "PBB", "RBB", "RBE", "PBE", "RBC", "PEN", "STD", "RJS", "NTF", "VAL", "WTG" ], "maxLength": 3, "examples": [ "STD" ] }, "TransactionStatus1": { "type": "string", "maxLength": 3, "examples": [ "STD" ] }, "TransactionType": { "type": "string", "enum": [ "PRR", "IPT" ], "maxLength": 3, "examples": [ "PRR" ] }, "TransactionType1": { "type": "string", "enum": [ "PRR", "RCL", "NRR", "INV", "PST", "CNR" ], "maxLength": 3, "examples": [ "PRR" ] }, "TrxDirection": { "type": "string", "enum": [ "IN", "OUT" ], "maxLength": 3, "examples": [ "IN" ] }, "Type": { "type": "string", "enum": [ "CPFR", "APFR", "CPFN", "CLRR", "ALRR", "ELRR", "EPFN" ], "maxLength": 4, "examples": [ "CPFR" ] }, "Uetr": { "type": "string", "maxLength": 36, "examples": [ "6fcc7290-7e8d-4518-a8c7-3c5c640b7f7b" ] }, "UpdateAPRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria12" } }, "required": [ "dateTime", "criteria" ] }, "UpdateAPResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "referenceId": { "description": "The univocal reference per SenderBic and date assigned by the system to the request.", "$ref": "#/components/schemas/ReferenceId" }, "requestStatus": { "description": "The status of the submitted command :\nIf the API request has been accepted then it is equal to “ATH”.\nIf the API request has been accepted then it is equal to “WTG”.\nIf the API request has been accepted then it is equal to “EXE”, for not Critical Parameter.\nIf the API request fails, then it is equal to “RJS” (meaning that the original change operation will not be rejected).”", "$ref": "#/components/schemas/RequestStatus" } } }, "UpdatedData": { "type": "object", "properties": { "numSentReqStatusUpd": { "description": "The number of Request for Status Update messages that were sent from the SenderBic", "$ref": "#/components/schemas/NumSentReqStatusUpd" }, "numReceivedReqStatusUpd": { "description": "The number of Request for Status Update messages that were received from the SenderBic", "$ref": "#/components/schemas/NumReceivedReqStatusUpd" } } }, "UpdateParticipantRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "criteria": { "$ref": "#/components/schemas/Criteria10" } }, "required": [ "dateTime", "criteria" ] }, "UpdateParticipantResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the response creation", "$ref": "#/components/schemas/DateTime" }, "requestStatus": { "description": "The status of the submitted command :\nIf the API request has been accepted then it is equal to “ATH”.\nIf the API request has been accepted then it is equal to “WTG”.\nIf the API request has been accepted then it is equal to “EXE”, for not Critical Parameter.\nIf the API request fails, then it is equal to “RJS” (meaning that the original change operation will not be rejected).”", "$ref": "#/components/schemas/RequestStatus" }, "referenceId": { "description": "The univocal reference per SenderBic and date assigned by the system to the request", "$ref": "#/components/schemas/ReferenceId" } } }, "Values": { "type": "object", "properties": { "lspBic": { "description": "The LSPBic contained in the request", "$ref": "#/components/schemas/Bic8" }, "lspBicDefaultDayValues": { "description": "The following section is present only if the LSPBic is valued and it is repeated as many times as the days of the week, from Monday to Sunday", "type": "array", "items": { "$ref": "#/components/schemas/LspBicDefaultDayValues" } }, "memberBic": { "description": "The MemberBic contained in the request", "$ref": "#/components/schemas/Bic8" }, "branchFundsBalanceId": { "description": "The branchFundsBalanceId contained in the request", "$ref": "#/components/schemas/BranchFundsBalanceId" }, "memberDefaultDayValues": { "description": "The following section is repeated as many times as the days of the week are, from Monday to Sunday", "type": "array", "items": { "$ref": "#/components/schemas/MemberDefaultDayValues" } } } }, "Year": { "type": "integer", "examples": [ 2024 ] }, "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" } } } } } }