{ "openapi": "3.1.0", "info": { "version": "3", "title": "EBACL STEP2 CGS REST API", "description": "STEP2 System CGS Module - API Specifications Annex", "contact": { "name": "EBA CLEARING", "url": "https://www.ebaclearing.eu" }, "x-info-creation-date": "2026-06-15", "x-info-release": "V20261114", "x-info-oasis-version": "3.0.20", "x-info-customization": "SWIFT" }, "servers": [ { "url": "https://api.swiftnet.sipn.swift.com/ebacl-step2-cgs/v1", "description": "Live Environment" }, { "url": "https://api-test.swiftnet.sipn.swift.com/ebacl-step2-cgs/v1", "description": "Test Environment" }, { "url": "https://api.common.swiftnet.sipn.swift.com/ebacl-step2-cgs/v1", "description": "Extended availability Live environment" }, { "url": "https://api-pilot.common.swiftnet.sipn.swift.com/ebacl-step2-cgs/v1", "description": "Extended availability Test environment" } ], "tags": [ { "name": "Alerts", "description": "Alerts" }, { "name": "Commands", "description": "Commands" }, { "name": "Configuration Parameters", "description": "Configuration Parameters" }, { "name": "Interest Calculation", "description": "Interest Calculation" }, { "name": "LCR Management", "description": "LCR Management" }, { "name": "Liquidity Position", "description": "Liquidity Position" }, { "name": "List Files", "description": "List Files" }, { "name": "Participant Management", "description": "Participant Management" }, { "name": "Preferred Agent", "description": "Preferred Agent" } ], "security": [ { "oauthBearerToken": [] } ], "paths": { "/listSettlementBICs/{senderBIC}": { "post": { "tags": [ "Preferred Agent" ], "operationId": "listSettlementBICs", "summary": "It allows the Participant to inquire the Settlement BICs list.", "description": "The listSettlement request allows the STEP2 Preferred Agents and STEP2 BICs configured for settlement in CGS to retrieve the CGS Settlement BIC list", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP 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/ListSettlementBICsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "settlementBIC": "IPSDID21XXX", "preferredAgentBIC": "TESTIT88", "status": "ENB", "initialValidityDate": "2019-06-21", "endValidityDate": "2024-11-08", "preferredS2Service": "SCT" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSettlementBICsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBICs": [ { "preferredAgentBIC": "TESTIT88", "settlementBIC": "IPSDID21XXX", "preferredS2Service": "SCT", "name": "ExampleBank01", "initialValidityDate": "2019-06-21", "endValidityDate": "2024-11-08", "status": "ENB" }, { "preferredAgentBIC": "BICDPA23", "settlementBIC": "TESBIC11XXX", "preferredS2Service": "COR", "name": "ExampleBank02", "initialValidityDate": "2024-11-08", "endValidityDate": "9999-12-31", "status": "DIS" } ] } } } } }, "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" } } } }, "/settlementBICDetails/{senderBIC}": { "post": { "tags": [ "Preferred Agent" ], "operationId": "settlementBICDetails", "summary": "It allows the Participant to inquire the details of a Settlement BIC.", "description": "The settlementBICDetails allows the STEP2 Preferred Agents and STEP2 BICs configured for settlement in CGS to get the details of a specific Settlement BIC", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP 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/SettlementBICDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBIC": "IPSDID21XXX" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettlementBICDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBICDetails": { "settlementBIC": "IPSDID21XXX", "status": "ENB", "initialValidityDate": "2019-06-21", "endValidityDate": "2024-11-08", "preferredAgentBIC": "TESTIT88", "preferredS2Service": "SCT", "parModhistory": [ { "initParameterValidity": "2019-06-21", "endParameterValidity": "2024-11-08", "detailsHistory": { "name": "ExampleBank01", "automaticAdjustment": true, "eodFulDefund": false, "lmrFileRequired": true, "lnrFileRequired": false, "dlrFileRequired": true, "maxRcvgFileSize": 100000, "configuredS2Dp": [ { "s2DpBIC": "TESTIT88", "s2Service": "SCT" }, { "s2DpBIC": "BICDPA23", "s2Service": "COR" } ] } }, { "initParameterValidity": "2024-11-08", "endParameterValidity": "9999-12-31", "detailsHistory": { "name": "ExampleBank01", "automaticAdjustment": true, "eodFulDefund": false, "lmrFileRequired": true, "lnrFileRequired": false, "dlrFileRequired": true, "maxRcvgFileSize": 100000, "configuredS2Dp": [ { "s2DpBIC": "TESTIT88", "s2Service": "SCT" }, { "s2DpBIC": "BICDPA23", "s2Service": "COR" } ] } } ] } } } } } }, "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" } } } }, "/updateSettlementBIC/{senderBIC}": { "put": { "tags": [ "Participant Management" ], "operationId": "updateSettlementBIC", "summary": "It allows the Participant to update the configuration of the Settlement BIC in CGS routing table", "description": "The updateSettlementBIC request allows the STEP2 Preferred Agent to update the routing configuration parameters for a specific Settlement BIC in the CGS Routing Table.\nThis function is managed under BCWS dual control and it generates an “Update Settlement BIC” operation logged as “TO BE AUTHORIZED”.\nIf no change is made to any parameters (besides the effective date), the request for update will be rejeceted (ErrorCode XA31)", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” or “Changed” (errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSettlementBICRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBICCode": "IPSDID21XXX", "effectiveDate": "2019-06-21", "settlementBICParameters": { "settlBICName": "ExampleBank01", "eodFulDefund": false, "lnrFileRequired": false, "maxRcvgFileSize": 1000 } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSettlementBICResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandRef": "F010190208113908" } } } } }, "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" } } } }, "/amendChangeSettlementBIC/{senderBIC}": { "post": { "tags": [ "Participant Management" ], "operationId": "amendChangeSettlementBIC", "summary": "It allows Participants to amend an operation related to a Settlement BIC", "description": "The amendChangeSettlementBIC request allows Participants to amend an operation related to a Settlement BIC\nIf no change is made to any parameters, the request for update will be rejeceted (ErrorCode XA31)", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” (errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AmendChangeSettlementBICRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBIC": { "settlementBICCode": "IPSDID21XXX", "initialSettBICValidityDate": "2019-06-21", "endSettBICValidityDate": "2024-11-08" }, "settlementBICAmend": { "settlBICName": "ExampleBank01", "automaticAdjustment": true, "eodFulDefund": false, "lmrFileRequired": true, "lnrFileRequired": false, "dlrFileRequired": true, "maxRcvgFileSize": 100000 } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AmendChangeSettlementBICResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandRef": "F010190208113908" } } } } }, "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" } } } }, "/revokeChangeSettlementBIC/{senderBIC}": { "post": { "tags": [ "Participant Management" ], "operationId": "revokeChangeSettlementBIC", "summary": "It allows Participants to revoke an operation related to a Settlement BIC ", "description": "The revokeChangeSettlementBIC request allows allows Participants to revoke an operation related to a Settlement BIC", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” (errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeChangeSettlementBICRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBIC": "IPSDID21XXX", "initParticipantValidity": "2019-06-21", "endParticipantValidity": "2024-11-08" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeChangeSettlementBICResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandRef": "F010190208113908" } } } } }, "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" } } } }, "/currentPosition/{senderBIC}": { "post": { "tags": [ "Liquidity Position" ], "operationId": "currentPosition", "summary": "It allows STEP2 Preferred Agent to inquire its current position", "description": "The currentPosition request allows the STEP2 Preferred Agent to retrieve its current position in a selected date range", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP 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/CurrentPositionRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBIC": "IPSDID21XXX" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentPositionResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "currentPosition": { "settlementBIC": "IPSDID21XXX", "amount": 1000, "timeStamp": "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" } } } }, "/positionLac/{senderBIC}": { "post": { "tags": [ "Liquidity Position" ], "operationId": "positionLac", "summary": "It allows STEP2 Preferred Agent to inquire the position at a specific LAC.", "description": "The positionLac request allows the STEP2 Preferred Agent to retrieve the position at a specific LAC", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP 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/PositionLacRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBIC": "IPSDID21XXX", "businessDateFrom": "2019-06-21", "businessDateTo": "2024-11-08", "lacNumber": "01" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PositionLacResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "positionHistory": [ { "settlementBIC": "IPSDID21XXX", "businessDate": "2019-06-21", "lacNumber": "01", "amount": 1000, "timeStamp": "2019-06-21T23:20:50.000001" }, { "settlementBIC": "TESBIC11XXX", "businessDate": "2024-11-08", "lacNumber": "02", "amount": 100000, "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" } } } }, "/setDefaultAgenda/{senderBIC}": { "put": { "tags": [ "Liquidity Position" ], "operationId": "setDefaultAgenda", "summary": "It allows STEP2 Preferred Agent to set and/or change the default thresholds related to its position. ", "description": "The setDefaultAgenda request allows the STEP2 Preferred Agent to set and/or change the default thresholds related to its position, setting the values for\n- Lower Position;\n- Base Position;\n- Upper Position;\n- Reset to base position flag\nfor each LAC of each TARGET day of the week.", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP 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/SetDefaultAgendaRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBIC": "IPSDID21XXX", "defaultDailyThresholds": [ { "day": 5, "lacDefaultAgenda": [ { "lacNumber": "01", "lowerPosition": 100000, "basePosition": 99999999999999, "upperPosition": 1, "resetToBasePos": true }, { "lacNumber": "02", "lowerPosition": 99999999999999, "basePosition": 1, "upperPosition": 100000, "resetToBasePos": false } ] }, { "day": 4, "lacDefaultAgenda": [ { "lacNumber": "01", "lowerPosition": 100000, "basePosition": 99999999999999, "upperPosition": 1, "resetToBasePos": true }, { "lacNumber": "02", "lowerPosition": 99999999999999, "basePosition": 1, "upperPosition": 100000, "resetToBasePos": false } ] } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDefaultAgendaResponse" }, "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" } } } }, "/getDefaultAgenda/{senderBIC}": { "post": { "tags": [ "Liquidity Position" ], "operationId": "getDefaultAgenda", "summary": "It allows STEP2 Preferred Agent to inquire the default thresholds related to its position.", "description": "The getDefaultAgenda request allows the STEP2 Preferred Agent to retrieve the default thresholds related to its position, namely\n- Lower Position;\n- Base Position;\n- Upper Position;\n- Reset to base position flag", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” or “Changed” (errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDefaultAgendaRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBIC": "IPSDID21XXX" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDefaultAgendaResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBIC": "IPSDID21XXX", "defaultAgenda": { "defaultDailyThresholds": [ { "day": 5, "lacDefaultAgenda": [ { "lacNumber": "01", "lowerPosition": 100000, "basePosition": 99999999999999, "upperPosition": 1, "resetToBasePos": true }, { "lacNumber": "02", "lowerPosition": 99999999999999, "basePosition": 1, "upperPosition": 100000, "resetToBasePos": false } ] }, { "day": 4, "lacDefaultAgenda": [ { "lacNumber": "01", "lowerPosition": 100000, "basePosition": 99999999999999, "upperPosition": 1, "resetToBasePos": true }, { "lacNumber": "02", "lowerPosition": 99999999999999, "basePosition": 1, "upperPosition": 100000, "resetToBasePos": false } ] } ] } } } } } }, "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" } } } }, "/setCalendar/{senderBIC}": { "put": { "tags": [ "Liquidity Position" ], "operationId": "setCalendar", "summary": "It allows STEP2 Preferred Agent to change one or more of the default values set in the Liquidity Agenda for specific LAC(s) of a specific day of the year, including the current one.", "description": "The setCalendar request allows the STEP2 Preferred Agent to change one or more of the default values set in the Liquidity Agenda for specific LAC(s) of a specific day of the year, including the current one", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP 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/SetCalendarRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBIC": "IPSDID21XXX", "businessDate": "2019-06-21", "exceptionLacValues": [ { "lacNumber": "01", "lowerPosition": 100000, "basePosition": 99999999999999, "upperPosition": 1, "resetToBasePos": true }, { "lacNumber": "02", "lowerPosition": 99999999999999, "basePosition": 1, "upperPosition": 100000, "resetToBasePos": false } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCalendarResponse" }, "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" } } } }, "/listCalendar/{senderBIC}": { "post": { "tags": [ "Liquidity Position" ], "operationId": "listCalendar", "summary": "It allows STEP2 Preferred Agent to inquire the changed values in the Agenda set for specific LAC(s) of a specific day of the year.", "description": "The listCalendar request allows the STEP2 Preferred Agent to retrieve the changed values in the Agenda set for specific LAC(s) of a specific day of the year", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP 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/ListCalendarRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBIC": "IPSDID21XXX", "businessDate": "2019-06-21" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCalendarResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "businessDate": "2019-06-21", "exceptionLacValues": [ { "settlementBIC": "IPSDID21XXX", "lacNumber": "01", "lowerPosition": 100000, "basePosition": 99999999999999, "upperPosition": 1, "resetToBasePos": true }, { "settlementBIC": "TESBIC11XXX", "lacNumber": "02", "lowerPosition": 99999999999999, "basePosition": 1, "upperPosition": 100000, "resetToBasePos": false } ] } } } } }, "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" } } } }, "/liquidityManagement/{senderBIC}": { "put": { "tags": [ "Liquidity Position" ], "operationId": "liquidityManagement1", "summary": "It allows STEP2 Preferred Agent to fund/defund liquidity from its position. As soon as the command is authorized, the Settlement BIC’s position is debited of the defunded amount and a LAF file is generated for T2I.", "description": "The liquidityManagement request allows the STEP2 Preferred Agent to fund/defund liquidity from its position. As soon as the command is authorized, the settlementBIC’s position is debited of the defunded amount and a LAF file is generated for T2I.", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” or “Changed” (errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)\nFunding and Defunding commands will not be available during Non-Target days according to TAW management. (errorCode XA25)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiquidityManagementRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBIC": "IPSDID21XXX", "amount": 1000, "transferTp": "F" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiquidityManagementResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "availableLiquidity": 1000 } } } } }, "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" } } } }, "/listFundingDefunding/{senderBIC}": { "post": { "tags": [ "Liquidity Position" ], "operationId": "listFundingDefunding", "summary": "It allows STEP2 Preferred Agent to retrieve detail information related to liquidity instructions (funding/defunding).:", "description": "The listFundingDefunding request allows the STEP2 Preferred Agent to retrieve information on single liquidity instructions including emergency instructions issued by EBACL", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” or “Changed” (errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFundingDefundingRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "settlementBIC": "IPSDID21XXX", "instructionTp": "RFU", "instructionReference": "INSREF1234567890", "instructionStatus": "VAL", "businessDateFrom": "2019-06-21", "businessDateTo": "2024-11-08", "amountFrom": 1000, "amountTo": 100000, "debitSttlmBIC": "TESBIC22XXX", "creditSttlmBIC": "TESBIC33XXX" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFundingDefundingResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "fundingDefunding": [ { "settlementBIC": "IPSDID21XXX", "responseInstructionTp": "RDE", "instructionReference": "INSREF1234567890", "instructionStatus": "VAL", "date": "2019-06-21", "amount": 1000, "debitSttlmBIC": "TESBIC22XXX", "creditSttlmBIC": "TESBIC33XXX", "debitBIC": "TESBIC99XXX", "creditBIC": "TESBIC22XXX", "settlementDateTime": "2019-06-21T23:20:50.000001" }, { "settlementBIC": "TESBIC11XXX", "responseInstructionTp": "TFU", "instructionReference": "INSREF1234567111", "instructionStatus": "ERR", "date": "2024-11-08", "amount": 100000, "debitSttlmBIC": "TESBIC33XXX", "creditSttlmBIC": "TESBIC99XXX", "debitBIC": "TESBIC22XXX", "creditBIC": "TESBIC33XXX", "settlementDateTime": "2024-11-08T14:29:00.012345" } ], "endOfList": true, "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" } } } }, "/interestMonthlyReport/{senderBIC}": { "post": { "tags": [ "Interest Calculation" ], "operationId": "interestMonthlyReport", "summary": "It allowsSTEP2 Preferred Agent to retrieve monthly information resulting from the “Interest Calculation Process” of a specific month", "description": "The interestMonthlyReport request allows the STEP2 Preferred Agent to retrieve monthly information resulting from the “Interest Calculation Process” for its Settlement BIC.\nData are available by the first TARGET business day of the month, once calculated by the system. Since calculations may differ from the set of information provided by the ECB (especially due to the rounding mechanism), Participants are invited to take note of this figure only upon EBA CLEARING email confirmation. Once confirmed as valid, the amount is collected from Participants on the third TARGET business day of the month. Once collected, daily interest details are available for Participants.\nIf for the selected period there are not validated data, \"no data found\" response is provided. If the range selected by the user includes more months for which EBA CLEARING has validated only some months, the report is provided only for the months already validated.", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” or “Changed” (errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterestMonthlyReportRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "settlementBIC": "IPSDID21XXX", "monthFrom": 202411, "monthTo": 201801 } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterestMonthlyReportResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "interestReport": [ { "settlementBIC": "IPSDID21XXX", "month": 202411, "monthlyInterestAmount": 1000 }, { "settlementBIC": "TESBIC11XXX", "month": 201801, "monthlyInterestAmount": 100000 } ] } } } } }, "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" } } } }, "/interestDailyReport/{senderBIC}": { "post": { "tags": [ "Interest Calculation" ], "operationId": "interestDailyReport", "summary": "It allows STEP2 Preferred Agent to retrieve daily information resulting from the “Interest Calculation Process”.", "description": "The interestReport request allows the STEP2 Preferred Agent to retrieve the daily information resulting from the “Interest Calculation Process” of a specific month for its Settlement BIC. Data are available by the first TARGET business day of the month, once calculated by the system. ", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” or “Changed” (errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterestDailyReportRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "settlementBIC": "IPSDID21XXX", "month": 202411 } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterestDailyReportResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "settlementBIC": "IPSDID21XXX", "interestReports": { "dailyReport": [ { "date": "2019-06-21", "interestRate": 1000, "snapshotTime": "16:00:00", "eodPosition": 100000, "dailyInterestAmount": 99999.01 }, { "date": "2024-11-08", "interestRate": 100000, "snapshotTime": "00:00:01", "eodPosition": 99999.01, "dailyInterestAmount": 1000 } ] } } } } } }, "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" } } } }, "/lcrList/{senderBIC}": { "post": { "tags": [ "LCR Management" ], "operationId": "lcrList", "summary": "It allows STEP2 Preferred Agent to inquire queued and processed (settled / cancelled / revoked / rejected) LCRs.", "description": "The lcrList request allows the STEP2 Preferred Agent to retrieve processed (settled / cancelled / revoked / rejected) and queued LCRs for its settlementBIC", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP 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/LcrListRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "settlementBIC": "IPSDID21XXX", "instgAgt": "TESTIT88", "instdAgt": "BICDPA23", "instgSttlmBIC": "TESBIC11XXX", "instdSttlmBIC": "TESBIC99XXX", "settlementDateFrom": "2019-06-21", "settlementDateTo": "2024-11-08", "dateTimeFrom": "2019-06-21T23:20:50.000001", "dateTimeTo": "2024-11-08T14:29:00.012345", "lcrReference": "REF0123456789111", "lacNumber": "01", "lcrStatus": "STTLD", "service": "SCT" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LcrListResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "lcrs": [ { "instgAgt": "TESTIT88", "instdAgt": "BICDPA23", "instgSttlmBIC": "IPSDID21XXX", "instdSttlmBIC": "TESBIC11XXX", "settlementDate": "2019-06-21", "businessDateTime": "2019-06-21T23:20:50.000001", "lcrReference": "REF0123456789111", "lacNumber": "01", "lcrStatus": "STTLD", "service": "SCT", "amount": 1000, "originalBulkReferenceId": "TESTBULKREF135000000000000000000123", "originalInputFileReferenceId": "TESTFILEREF01234", "dbrCrdFlag": "C", "CreationDateTime": "2024-11-08T14:29:00.012345" }, { "instgAgt": "BICDPA23", "instdAgt": "DPBICA88", "instgSttlmBIC": "TESBIC11XXX", "instdSttlmBIC": "TESBIC99XXX", "settlementDate": "2024-11-08", "businessDateTime": "2024-11-08T14:29:00.012345", "lcrReference": "REF0123456789000", "lacNumber": "02", "lcrStatus": "CANC", "service": "COR", "amount": 100000, "originalBulkReferenceId": "TESTBULKREF135000000000000000999999", "originalInputFileReferenceId": "CGSTFILEREF01234", "dbrCrdFlag": "D", "CreationDateTime": "9999-12-31T12:55:45.000001" } ], "endOfList": true, "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" } } } }, "/lcrDetails/{senderBIC}": { "post": { "tags": [ "LCR Management" ], "operationId": "lcrDetails", "summary": "It allows STEP2 Preferred Agent to retrieve details of queued and processed (settled / cancelled / revoked / rejected) LCRs.", "description": "The lcrList request allows the STEP2 Preferred Agent to retrieve details of a single LCR for a specific settlementBIC (mandatory to set up the request).", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP 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/LcrDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "settlementBIC": "IPSDID21XXX", "settlementDate": "2019-06-21", "lcrReference": "REF0123456789111" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LcrDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "lcrDetails": { "service": "SCT", "lcrReference": "REF0123456789111", "businessDate": "2019-06-21", "originalBulk": "TESTBULKREF135000000000000000000123", "originalFileRef": "TESTFILEREF01234", "bulkType": "Pacs.008", "instgAgt": "TESTIT88", "instdAgt": "BICDPA23", "instgSttlmBIC": "IPSDID21XXX", "instdSttlmBIC": "TESBIC11XXX", "credPartyBIC": "DPBICA88", "debPartyBIC": "TESTIT88", "lacInputFromS2": "01", "cgsLacInput": "02", "cgsLacOutput": "10", "amount": 1000, "numTransactions": 100000, "lcrStatus": "STTLD", "s2LcrCreationTimestamp": "2019-06-21T23:20:50.000001", "cgsLcrStatusUpdate": "2024-11-08T14:29:00.012345", "dbrCrdFlag": "C" } } } } } }, "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" } } } }, "/revokeLcr/{senderBIC}": { "put": { "tags": [ "LCR Management" ], "operationId": "revokeLcr", "summary": "It allows STEP2 Preferred Agent to revoke queued LCRs resulting in a negative settlement of the LCR that is rejected back to the relevant STEP2 Service.", "description": "The revokeLcr request allows the STEP2 Preferred Agent to revoke a single queued LCR or all queued LCRs, resulting in a negative settlement of the LCR(s) that will be rejected back to the relevant STEP2 Service", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” or “Changed”\n(errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeLcrRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "settlementBIC": "IPSDID21XXX", "businessDate": "2019-06-21", "lcrReference": "REF0123456789111" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeLcrResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandRef": "F010190208113908", "commandStatus": "TO BE AUTHORIZED" } } } } }, "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": [ "List Files" ], "operationId": "listFiles", "summary": "It allows STEP2 Preferred Agent to retrieve the list of LMR and LNR output files generated by the Module.", "description": "The listFiles request allows the STEP2 Preferred Agent to retrieve the list of LMR and LNR output files generated by the module", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” or “Changed” (errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFilesRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "preferredAgentBIC": "TESTIT88", "fileType": "LNR", "fileStatus": "TSD", "dateTimeFrom": "2019-06-21T23:20:50.000001", "dateTimeTo": "2024-11-08T14:29:00.012345", "dateType": "Calendar Date", "fileReference": "TESTFILEREF01234", "lacNumber": "01" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFilesResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "fileList": [ { "preferredAgentBIC": "TESTIT88", "fileType": "LNR", "dateTime": "2019-06-21T23:20:50.000001", "date": "2019-06-21", "lacNumber": "01", "fileReference": "TESTFILEREF01234", "fileStatus": "TSD", "networkFileName": "S202SCTTESTITMMF800AAA.I", "network": "SWF" }, { "preferredAgentBIC": "BICDPA23", "fileType": "LMR", "dateTime": "2024-11-08T14:29:00.012345", "date": "2024-11-08", "lacNumber": "02", "fileReference": "CGSTFILEREF01234", "fileStatus": "ERR", "networkFileName": "S202CORTESTITMMF111ABC.I", "network": "EAS" } ], "endOfList": true, "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": [ "List Files" ], "operationId": "fileDetails", "summary": "It allows STEP2 Preferred Agent to retrieve details of LMR and LNR output files generated by the Module.", "description": "The fileDetails request allows the STEP2 Preferred Agent to retrieve details of LMR and LNR output files generated by the module", "parameters": [ { "name": "senderBIC", "description": "The BIC of the DP sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP 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/FileDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "businessDate": "2019-06-21", "fileType": "LNR", "networkFileName": "S202SCTTESTITMMF800AAA.I" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "fileDetails": { "sendingInstitution": "TESTIT88", "receivingInstitution": "BICDPA23", "moduleIdentifier": "CGS", "businessDate": "2019-06-21", "creationDtTm": "2019-06-21T23:20:50.000001", "calendarDate": "2024-11-08", "fileReference": "TESTFILEREF01234", "fileType": "LNR", "networkFileName": "S202SCTTESTITMMF800AAA.I", "lacNumber": "01", "fileStatus": "TSD", "lastStatusUpdate": "2024-11-08T14:29:00.012345", "lmrData": { "numTotBulks": 100000, "positionLacOpen": 1000, "positionLacClose": 100000, "liquidityInstrDebitPosition": 99999.01, "liquidityInstrCreditPosition": 1000, "processedLCRDebitPosition": 100000, "processedLCRCreditPosition": 99999.01 }, "lnrData": { "positionNotification": 1000, "positionDtTm": "2019-06-21T23:20:50.000001" }, "dlrData": { "numTotBulks": 100000, "dateTimeOpeningBalance": "2019-06-21T23:20:50.000001", "positionOpening": 1000, "dateTimeClosingBalance": "2024-11-08T14:29:00.012345", "positionClosing": 100000, "liquidityInstrDebitPosition": 99999.01, "liquidityInstrCreditPosition": 1000, "processedLCRDebitPosition": 100000, "processedLCRCreditPosition": 99999.01 } } } } } } }, "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" } } } }, "/retransmitOutFiles/{senderBIC}": { "post": { "tags": [ "List Files" ], "operationId": "retransmitOutFiles", "summary": "It allows to ask for the resending of a single file for which the Participant was the receiver.", "description": "The retransmitOutFiles request allows the STEP2 Preferred Agent to ask for the resending of files for which the Preferred Agent was the receiver. The retransmission of files can be requested for a single file in the suitable status", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP 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/RetransmitOutFilesRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202SCTTESTITMMF800AAA.I" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetransmitOutFilesResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandRef": "F010190208113908", "commandStatus": "TO BE AUTHORIZED" } } } } }, "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" } } } }, "/resendAll/{senderBIC}": { "post": { "tags": [ "List Files" ], "operationId": "resendAll", "summary": "It allows the Participant to ask the comprehensive re-transmission of output files for which the Participant was the receiver.", "description": "The resendAll request allows the STEP2 Preferred Agent to ask for the resending of files for which the Preferred Agent was the receiver. The retransmission of files can be requested for all of files with status TSG (Transmitting) or ERR (Error), according to filter criteria and rules on date foreseen in CGS", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP 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/ResendAllRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "fileType": "LNR", "fileStatus": "TSD", "lacNumber": "01", "dateFrom": "2019-06-21", "dateTo": "2024-11-08" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResendAllResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandRef": "F010190208113908", "commandStatus": "TO BE AUTHORIZED" } } } } }, "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": [ "Alerts" ], "operationId": "listAlerts", "summary": "It allows the Participant to enquire the list of alerts generated by the module for its BIC. ", "description": "The listAlerts request allows the STEP2 Preferred Agent to retrieve the list of alerts produced by the module for its BIC", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” or “Changed” (errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAlertsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "settlementBIC": "IPSDID21XXX", "dateTimeFrom": "2019-06-21T23:20:50.000001", "dateTimeTo": "2024-11-08T14:29:00.012345", "eventDescription": "SETTLEMENT BIC INPART001 IS NOT PRESENT" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAlertsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "alerts": [ { "dateTime": "2019-06-21T23:20:50.000001", "eventType": "WRN", "eventDescription": "SETTLEMENT BIC INPART001 IS NOT PRESENT" }, { "dateTime": "2024-11-08T14:29:00.012345", "eventType": "SEC", "eventDescription": "OPERATION NOT ALLOWED" } ], "endOfList": true, "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" } } } }, "/listCommands/{senderBIC}": { "post": { "tags": [ "Commands" ], "operationId": "listCommands", "summary": "It allows the STEP2 Preferred Agent to inquire the list of submitted commands.", "description": "The listCommands request allows the STEP2 Preferred Agent to retrieve the status of Commands that were submitted by the Participant", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” or “Changed” (errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCommandsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "commandType": "F01", "commandStatus": "TO BE AUTHORIZED", "requestDateTimeFrom": "2019-06-21T23:20:50.000001", "requestDateTimeTo": "2024-11-08T14:29:00.012345", "authRejectDateTimeFrom": "9999-12-31T12:55:45.000001", "authRejectDateTimeTo": "2019-06-21T23:20:50.000001", "userIssuer": "APIUSER1", "userAuthReject": "APIUSER2" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCommandsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commands": [ { "commandType": "F01", "commandStatus": "TO BE AUTHORIZED", "requestDateTime": "2019-06-21T23:20:50.000001", "authRejectDateTime": "2024-11-08T14:29:00.012345", "userIssuer": "APIUSER1", "userAuthReject": "APIUSER2", "commandRef": "F010190208113908" }, { "commandType": "F02", "commandStatus": "EXECUTED", "requestDateTime": "2024-11-08T14:29:00.012345", "authRejectDateTime": "9999-12-31T12:55:45.000001", "userIssuer": "APIUSER2", "userAuthReject": "APIUSER3", "commandRef": "F011390508223918" } ], "endOfList": true, "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" } } } }, "/commandDetails/{senderBIC}": { "post": { "tags": [ "Commands" ], "operationId": "commandDetails", "summary": "It allows the STEP2 Preferred Agent to retrieve the details of a single command submitted.", "description": "The commandDetails request allows the STEP2 Preferred Agent to retrieve the status of a single command submitted by the Participant", "parameters": [ { "name": "senderBIC", "description": "The BIC of the DP sending the API Request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP 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/CommandDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandRef": "F010190208113908" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommandDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandRef": "F010190208113908", "commandType": "F01", "commandStatus": "TO BE AUTHORIZED", "requestDateTime": "2024-11-08T14:29:00.012345", "authRejectDateTime": "9999-12-31T12:55:45.000001", "userIssuer": "APIUSER1", "userAuthReject": "APIUSER2", "fundingDefundingDetails": { "settlementBIC": "IPSDID21XXX", "amount": 1000 }, "revokeLcrDetails": { "instgAgt": "TESTIT88", "instdAgt": "BICDPA23", "lcrReference": "REF0123456789111", "lcrStatus": "STTLD", "instgSttlmBIC": "IPSDID21XXX", "instdSttlmBIC": "TESBIC11XXX", "s2Service": "SCT", "businessDate": "2019-06-21" }, "revokeAllLcrDetails": { "businessDate": "2019-06-21", "settlementBIC": "IPSDID21XXX" }, "retransmitOutFileDetails": { "settlementBIC": "IPSDID21XXX", "preferredAgentBIC": "TESTIT88", "fileType": "LNR", "fileReference": "TESTFILEREF01234", "fileStatus": "TSD", "lac": "01", "businessDate": "2019-06-21" }, "resendAllDetails": { "fileType": "LNR", "timestampLastUpdate": "2019-06-21T23:20:50.000001", "fileStatus": "TSD" }, "agendaDetails": { "settlementBIC": "IPSDID21XXX", "dailyThresholds": { "day": 5, "lacAgenda": [ { "lacNumber": "01", "lowerPosition": 100000, "basePosition": 99999999999999, "upperPosition": 1, "resetToBasePos": true }, { "lacNumber": "02", "lowerPosition": 99999999999999, "basePosition": 1, "upperPosition": 100000, "resetToBasePos": false } ] } }, "calendarDetails": { "settlementBIC": "IPSDID21XXX", "dailyThresholds": { "day": 5, "lacAgenda": [ { "lacNumber": "01", "lowerPosition": 100000, "basePosition": 99999999999999, "upperPosition": 1, "resetToBasePos": true }, { "lacNumber": "02", "lowerPosition": 99999999999999, "basePosition": 1, "upperPosition": 100000, "resetToBasePos": false } ] } } } } } } }, "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" } } } }, "/listOperation/{senderBIC}": { "post": { "tags": [ "Commands" ], "operationId": "listOperation", "summary": "It allows the STEP2 Preferred Agent to inquire the status of operations submitted.", "description": "The listOperation allows the STEP2 Preferred Agent to retrieve participant operations stored in the Settlement BICs routing table, based on customized search criteria.", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” or “Changed” (errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOperationRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "userIssuer": "APIUSER1", "userAuthReject": "APIUSER2", "settlementBIC": "IPSDID21XXX", "operationType": "Update", "operationStatus": "Authorized", "commandRef": "F010190208113908", "requestDate": "2019-06-21", "authRejectExecDateTime": "2019-06-21T23:20:50.000001", "effectiveDate": "2024-11-08" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOperationResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "operations": [ { "userIssuer": "APIUSER1", "userAuthReject": "APIUSER2", "settlementBIC": "IPSDID21XXX", "operationType": "Update", "operationStatus": "Authorized", "commandRef": "F010190208113908", "requestDateTime": "2019-06-21T23:20:50.000001", "authRejectExecDateTime": "2024-11-08T14:29:00.012345", "effectiveDate": "2019-06-21", "critical": true }, { "userIssuer": "APIUSER2", "userAuthReject": "APIUSER3", "settlementBIC": "TESBIC11XXX", "operationType": "Amend Change", "operationStatus": "Executed", "commandRef": "F011390508223918", "requestDateTime": "2024-11-08T14:29:00.012345", "authRejectExecDateTime": "9999-12-31T12:55:45.000001", "effectiveDate": "2024-11-08", "critical": false } ], "endOfList": true, "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" } } } }, "/operationDetails/{senderBIC}": { "post": { "tags": [ "Commands" ], "operationId": "operationDetails", "summary": "It allows the STEP2 Preferred Agent to inquire the details of a single operation submitted.", "description": "The operationDetails request allows the STEP2 Preferred Agent to retrieve details of specific routing table operations.", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” or “Changed” (errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandRef": "F010190208113908" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "operationDetails": { "settlementBIC": "TESBIC22XXX", "operationType": "Update, Amend Change, Revoke Change", "operationStatus": "Authorized", "commandRef": "REF012345678911111", "effectiveDate": "2019-06-21", "requestDateTime": "2019-06-21T23:20:50.000001", "authRejectDateTime": "2024-11-08T14:29:00.012345", "userIssuer": "APIUSER1", "userAuthReject": "APIUSER2", "critical": true, "CGSSettlementBIC": { "preferredAgentBIC": "TESTIT88", "preferredS2Service": "SCT", "settlBICName": "ExampleBank01", "eodFulDefund": false, "lnrFileRequired": false, "maxRcvgFileSize": 1000, "configuredS2Dp": [ { "s2DpBIC": "TESTIT88", "s2Service": "SCT" }, { "s2DpBIC": "BICDPA23", "s2Service": "COR" } ] } } } } } } }, "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}": { "put": { "tags": [ "Commands" ], "operationId": "rejectParticipantOperation", "summary": "It allows the STEP2 Preferred Agent to reject an operation previously submitted via API", "description": "The rejectParticipantOperation request allows the STEP2 Preferred Agent to reject a specific change operation submitted and not yet authorized.", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” or “Changed”\n(errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectParticipantOperationRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandRef": "F010190208113908" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectParticipantOperationResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandRef": "F010190208113908" } } } } }, "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" } } } }, "/listLACsConfiguration/{senderBIC}": { "post": { "tags": [ "Configuration Parameters" ], "operationId": "listLACsConfiguration", "summary": "It allows the STEP2 Preferred Agent to inquire the current or default configuration of CGS cut-offs.", "description": "The listLACsConfiguration request allows the STEP2 Preferred Agent to retrieve the current or default configuration of CGS Cut-offs for both Live and Pilot environment. The times returned in the Response indicate a CET format time.", "parameters": [ { "name": "senderBIC", "description": "The BIC sending the request\n\n **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)\nSending DP must not have status “Disabled” or “Changed” (errorCode PY01)\nSending DP must correspond to a Preferred Agent enabled in the CGS Routing Table (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLACsConfigurationRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001" } } } } } }, "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": "16:00:00", "lacAdjustmentTime": "00:00:01", "nightTimeSettlement": true }, { "lac": "02", "lacSendingCutOffTime": "00:00:01", "lacAdjustmentTime": "23:59:59", "nightTimeSettlement": false } ], "otherModuleCutOff": { "openingTime": "16:00:00", "taw1Start": "00:00:01", "taw1End": "23:59:59", "taw2Start": "16:00:00", "taw2End": "00:00:01", "taw3Start": "23:59:59", "taw3End": "16:00:00", "taw4Start": "00:00:01", "taw4End": "23:59:59", "cgsEOD": "16:00:00", "sctEOD": "00:00:01", "corEOD": "23:59:59", "b2bEOD": "16:00:00" } } } } } }, "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": { "AgendaDetails": { "type": "object", "properties": { "settlementBIC": { "description": "The STEP2 Settlement BIC owning a liquidity position in CGS", "$ref": "#/components/schemas/Bic11Only" }, "dailyThresholds": { "$ref": "#/components/schemas/DailyThresholds" } }, "required": [ "settlementBIC", "dailyThresholds" ] }, "Alerts": { "type": "object", "properties": { "dateTime": { "description": "The Date and Time at which the alert was issued", "$ref": "#/components/schemas/DateTime" }, "eventType": { "description": "The type of event", "$ref": "#/components/schemas/EventType" }, "eventDescription": { "description": "The description of the alert", "$ref": "#/components/schemas/EventDescription" } }, "required": [ "dateTime", "eventType", "eventDescription" ] }, "AmendChangeSettlementBICRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "settlementBIC": { "$ref": "#/components/schemas/SettlementBIC" }, "settlementBICAmend": { "$ref": "#/components/schemas/SettlementBICAmend" } }, "required": [ "dateTime", "settlementBIC" ] }, "AmendChangeSettlementBICResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "commandRef": { "description": "The command reference", "$ref": "#/components/schemas/CommandReference" } }, "required": [ "dateTime", "commandRef" ] }, "Amount": { "description": "Standard Amount", "type": "number", "format": "double", "minimum": 0, "maximum": 1000000000000000, "examples": [ 1000 ] }, "Amount1": { "description": "Standard Amount", "type": "number", "format": "double", "maximum": 1000000000000000, "examples": [ 1000 ] }, "BIC11": { "description": "The Generic BIC of participant", "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}", "examples": [ "TESBIC22XXX" ] }, "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": { "description": "The BIC of direct participant", "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}", "examples": [ "TESTIT88" ] }, "Boolean": { "description": "True or False indicator", "type": "boolean", "examples": [ true ] }, "BulkReference": { "description": "The bulk reference of the file", "type": "string", "pattern": "([A-Za-z0-9]|[+|\\?|/|\\-|:|\\(|\\)|\\.|,|']){1,35}", "examples": [ "TESTBULKREF135000000000000000000123" ] }, "CGSSettlementBIC": { "type": "object", "properties": { "preferredAgentBIC": { "description": "The configured preferred agent. It corresponds to the senderBIC", "$ref": "#/components/schemas/BIC8" }, "preferredS2Service": { "description": "The configured preferred service", "$ref": "#/components/schemas/Service" }, "settlBICName": { "description": "The name of the Settlement BIC", "$ref": "#/components/schemas/ParticipantName" }, "automaticAdjustment": { "description": "Whether the participant is configured for Automatic Adjustment", "$ref": "#/components/schemas/Boolean" }, "eodFulDefund": { "description": "Whether the participant is configured for EOD Full Defunding", "$ref": "#/components/schemas/Boolean" }, "lmrFileRequired": { "description": "Whether the participant is configured to receive LMR files", "$ref": "#/components/schemas/Boolean" }, "lnrFileRequired": { "description": "Whether the participant is configured to receive LNR files", "$ref": "#/components/schemas/Boolean" }, "DlrFileRequired": { "description": "Whether the participant is configured to receive DLR files", "$ref": "#/components/schemas/Boolean" }, "maxRcvgFileSize": { "description": "The Max Receiving File Size configured for the Settlement BIC", "$ref": "#/components/schemas/StandardInteger" }, "configuredS2Dp": { "description": "The following details are listed for each STEP2 BIC linked to the settlement BIC", "type": "array", "items": { "$ref": "#/components/schemas/ConfiguredS2Dp1" } } } }, "CommandDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request", "$ref": "#/components/schemas/DateTime" }, "commandRef": { "description": "The command reference", "$ref": "#/components/schemas/CommandReference" } }, "required": [ "dateTime", "commandRef" ] }, "CommandDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the creation of the API response", "$ref": "#/components/schemas/DateTime" }, "commandRef": { "description": "The command reference", "$ref": "#/components/schemas/CommandReference" }, "commandType": { "description": "The command type", "$ref": "#/components/schemas/CommandType" }, "commandStatus": { "description": "The command status", "$ref": "#/components/schemas/CommandStatus" }, "requestDateTime": { "description": "The date and time at which the command was issued", "$ref": "#/components/schemas/DateTime" }, "authRejectDateTime": { "description": "The date and time at which the command was rejected or authorized", "$ref": "#/components/schemas/DateTime" }, "userIssuer": { "description": "The user who issued the command", "$ref": "#/components/schemas/User" }, "userAuthReject": { "description": "The user who authorized/rejected the command", "$ref": "#/components/schemas/User" }, "fundingDefundingDetails": { "description": "If commandType is L03 or L04, then this block must be present", "$ref": "#/components/schemas/FundingDefundingDetails" }, "revokeLcrDetails": { "description": "If commandType is F02, then this block must be present", "$ref": "#/components/schemas/RevokeLcrDetails" }, "revokeAllLcrDetails": { "description": "If commandType is F03, then this block must be present", "$ref": "#/components/schemas/RevokeAllLcrDetails" }, "retransmitOutFileDetails": { "description": "If commandType is F01, then this block must be present", "$ref": "#/components/schemas/RetransmitOutFileDetails" }, "resendAllDetails": { "description": "If commandType is F04, then this block must be present", "$ref": "#/components/schemas/ResendAllDetails" }, "agendaDetails": { "description": "If commandType is L01, then this block must be present", "$ref": "#/components/schemas/AgendaDetails" }, "calendarDetails": { "description": "If commandType is L02, then this block must be present", "$ref": "#/components/schemas/AgendaDetails" } }, "required": [ "dateTime", "commandRef", "commandType", "commandStatus", "requestDateTime", "authRejectDateTime", "userIssuer", "userAuthReject" ] }, "CommandReference": { "description": "Command reference", "type": "string", "maxLength": 22, "examples": [ "F010190208113908" ] }, "Commands": { "type": "object", "properties": { "commandType": { "description": "The command type", "$ref": "#/components/schemas/CommandType" }, "commandStatus": { "description": "The command status", "$ref": "#/components/schemas/CommandStatus" }, "requestDateTime": { "description": "The date and time in which the command has been issued", "$ref": "#/components/schemas/DateTime" }, "authRejectDateTime": { "description": "The date and time in which the command has been executed or rejected", "$ref": "#/components/schemas/DateTime" }, "userIssuer": { "description": "The UserID of the user that has issued the command", "$ref": "#/components/schemas/User" }, "userAuthReject": { "description": "The UserID of the user that has authorized or rejected the command", "$ref": "#/components/schemas/User" }, "commandRef": { "description": "The reference of command", "$ref": "#/components/schemas/CommandReference" } }, "required": [ "commandType", "commandStatus", "requestDateTime", "userIssuer", "commandRef" ] }, "CommandStatus": { "description": "Command status.", "type": "string", "enum": [ "TO BE AUTHORIZED", "EXECUTED", "REJECTED" ], "examples": [ "TO BE AUTHORIZED" ] }, "CommandType": { "description": "Command type", "type": "string", "enum": [ "L01", "L02", "L03", "L04", "F02", "F03", "F01", "F04" ], "examples": [ "F01" ] }, "ConfiguredS2Dp": { "type": "object", "properties": { "s2DpBIC": { "description": "BIC8 of the STEP2 DP from which the CGS can receive LCRs.", "$ref": "#/components/schemas/BIC8" }, "s2Service": { "description": "STEP2 Service configured for the STEP2 DP BIC", "$ref": "#/components/schemas/Service" } }, "required": [ "s2DpBIC", "s2Service" ] }, "ConfiguredS2Dp1": { "type": "object", "properties": { "s2DpBIC": { "description": "The STEP2 BIC", "$ref": "#/components/schemas/BIC8" }, "s2Service": { "description": "The service linked to the STEP2 BIC", "$ref": "#/components/schemas/Service" } } }, "CurrentPosition": { "type": "object", "properties": { "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS", "$ref": "#/components/schemas/Bic11Only" }, "amount": { "description": "Amount corresponding to the position requested", "$ref": "#/components/schemas/Amount" }, "timeStamp": { "description": "TimeStamp of the moment when the system retrieved the position of the Participant", "$ref": "#/components/schemas/DateTime" } }, "required": [ "settlementBIC", "amount", "timeStamp" ] }, "CurrentPositionRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS\n\n **Validation Rule(s)** It must correspond to one of the settlement BIC configured for the senderBIC, corresponding to the Preferred Agent (errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" } }, "required": [ "dateTime", "settlementBIC" ] }, "CurrentPositionResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "currentPosition": { "$ref": "#/components/schemas/CurrentPosition" } }, "required": [ "dateTime", "currentPosition" ] }, "DailyReport": { "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/Amount1" }, "snapshotTime": { "description": "The time to which the Participant’s Position has been retrieved", "$ref": "#/components/schemas/Time" }, "eodPosition": { "description": "The settlementBIC’s Position retrieved at the Snapshot Time", "$ref": "#/components/schemas/Amount1" }, "dailyInterestAmount": { "description": "The Interest Amount calculated by the System for the impacted “date”", "$ref": "#/components/schemas/Amount1" } }, "required": [ "date", "interestRate", "snapshotTime", "eodPosition", "dailyInterestAmount" ] }, "DailyThresholds": { "type": "object", "properties": { "day": { "description": "The day of the week. The value must be between 1 and 5:\n1 – Monday,\n2- Tuesday,\n3 – Wednesday,\n4 – Thursday,\n5 – Friday.", "$ref": "#/components/schemas/Day" }, "lacAgenda": { "type": "array", "items": { "$ref": "#/components/schemas/LacDefaultAgenda1" } } }, "required": [ "day", "lacAgenda" ] }, "Date": { "description": "Standard ISO Date.", "type": "string", "pattern": "[0-9]{4,4}\\-[0-9]{2,2}\\-[0-9]{2,2}", "examples": [ "2019-06-21" ] }, "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" ] }, "DateType": { "type": "string", "enum": [ "Calendar Date", "Business Date" ], "examples": [ "Calendar Date" ] }, "Day": { "type": "number", "minimum": 1, "maximum": 5, "examples": [ 5 ] }, "DefaultAgenda": { "type": "object", "properties": { "defaultDailyThresholds": { "description": "It must be present 5 times: 1 occurrence/day", "type": "array", "maxItems": 5, "items": { "$ref": "#/components/schemas/DefaultDailyThresholds1" } } }, "required": [ "defaultDailyThresholds" ] }, "DefaultDailyThresholds": { "type": "object", "properties": { "day": { "description": "The day of the week. The value must be between 1 and 5:\n1 – Monday,\n2- Tuesday,\n3 – Wednesday,\n4 – Thursday,\n5 – Friday.\n\n **Validation Rule(s)** It must be present 5 times: 1 occurrence/day", "$ref": "#/components/schemas/Day" }, "lacDefaultAgenda": { "description": " **Validation Rule(s)** It must be present one occurrence/lac\n(errorCode XA07)", "type": "array", "items": { "$ref": "#/components/schemas/LacDefaultAgenda" } } }, "required": [ "day", "lacDefaultAgenda" ] }, "DefaultDailyThresholds1": { "type": "object", "properties": { "day": { "description": "The day of the week", "$ref": "#/components/schemas/Day" }, "lacDefaultAgenda": { "description": "It must be present one occurrence/lac", "type": "array", "items": { "$ref": "#/components/schemas/LacDefaultAgenda1" } } }, "required": [ "day", "lacDefaultAgenda" ] }, "DetailsHistory": { "type": "object", "properties": { "name": { "description": "The Settlement BIC name", "$ref": "#/components/schemas/ParticipantName" }, "automaticAdjustment": { "description": "This parameter indicates if the Participant opt-out from the automatic liquidity adjustments performed by the system at the EOL. In this case, thresholds are configured only to trigger alerts.\nAllowed values:\n- true\n- false", "$ref": "#/components/schemas/Boolean" }, "eodFulDefund": { "description": "This parameter indicates if on the last LAC of the business day, the CGS Module will perform an automatic full defunding of the Participant position in order to avoid remuneration of outstanding liquidity. Allowed values:\n- true\n- false", "$ref": "#/components/schemas/Boolean" }, "lmrFileRequired": { "description": "This parameter indicates whether the Participant wishes to receive the LMR output file. Allowed values:\n- true\n- false", "$ref": "#/components/schemas/Boolean" }, "lnrFileRequired": { "description": "This parameter indicates whether the Participant wishes to receive the LNR output file. Allowed values:\n- true\n- false", "$ref": "#/components/schemas/Boolean" }, "dlrFileRequired": { "description": "This parameter indicates whether the Participant wishes to receive daily liquidity reconciliation report. Allowed values:\n- true\n- false", "$ref": "#/components/schemas/Boolean" }, "maxRcvgFileSize": { "description": "The maximum size of an output file generated and sent by the CGS to this Participant.", "$ref": "#/components/schemas/Number" }, "configuredS2Dp": { "description": "STEP2 DP BIC configured in CGS module from which LCR requests can be received by the CGS.", "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/ConfiguredS2Dp" } } }, "required": [ "name", "automaticAdjustment", "eodFulDefund", "lmrFileRequired", "lnrFileRequired", "dlrFileRequired", "maxRcvgFileSize" ] }, "DlrData": { "type": "object", "properties": { "numTotBulks": { "description": "The total number of bulks contained in the file", "$ref": "#/components/schemas/Number" }, "dateTimeOpeningBalance": { "description": "The date and time of the last LAC Sending cut-off of previous business date.", "$ref": "#/components/schemas/DateTime" }, "positionOpening": { "description": "The position of Settlement BIC at dateTimeOpeningBalance.", "$ref": "#/components/schemas/Amount1" }, "dateTimeClosingBalance": { "description": "The date and time of the last LAC Sending cut-off of current business date.", "$ref": "#/components/schemas/DateTime" }, "positionClosing": { "description": "The position of Settlement BIC at dateTimeClosingBalance.", "$ref": "#/components/schemas/Amount1" }, "liquidityInstrDebitPosition": { "description": "The CGS Settlement BIC debit position resulting from the processing of liquidity instructions (funding/defunding) exchanged with T2I from dateTimeOpeningBalance to dateTimeClosingBalance.", "$ref": "#/components/schemas/Amount1" }, "liquidityInstrCreditPosition": { "description": "The CGS Settlement BIC credit position resulting from the processing of liquidity instructions (funding /defunding) exchanged with T2I from dateTimeOpeningBalance to dateTimeClosingBalance.", "$ref": "#/components/schemas/Amount1" }, "processedLCRDebitPosition": { "description": "The CGS settlement BIC debit position resulting from settled LCRs from dateTimeOpeningBalance to dateTimeClosingBalance.", "$ref": "#/components/schemas/Amount1" }, "processedLCRCreditPosition": { "description": "The CGS settlement BIC credit position resulting from settled LCRs from dateTimeOpeningBalance to dateTimeClosingBalance.", "$ref": "#/components/schemas/Amount1" } }, "required": [ "numTotBulks" ] }, "EndOfList": { "description": "End of list indicator.", "type": "boolean", "examples": [ true ] }, "ErrorCode": { "description": "Error code", "type": "string", "pattern": "[A-Za-z0-9]{4,4}", "examples": [ "AX01" ] }, "ErrorCodeDescription": { "description": "Message", "type": "string", "maxLength": 255, "examples": [ "Transaction rejected" ] }, "ErrorResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "errorCode": { "description": "It is set equal to the corresponding errorCode (see values allowed in the system) of the wrong request", "$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/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", "requestId" ] }, "EventDescription": { "description": "Event description", "type": "string", "maxLength": 1000, "examples": [ "SETTLEMENT BIC INPART001 IS NOT PRESENT" ] }, "EventType": { "description": "Event type", "type": "string", "enum": [ "SEC", "FTL", "ERR", "WRN", "NOR" ], "examples": [ "WRN" ] }, "ExceptionLacValues": { "type": "object", "properties": { "lacNumber": { "description": "The relevant LAC number\n\n **Validation Rule(s)** Mandatory if the section is present.\nIt must be a valid LAC\n(errorCode SC01)\nIf the pair BusinessDate-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" }, "lowerPosition": { "description": "The lower position to be set for the calendar\n\n **Validation Rule(s)** It must be between 0 and Base\n(errorCode XA05)", "$ref": "#/components/schemas/Number" }, "basePosition": { "description": "The base position to be set for the calendar\n\n **Validation Rule(s)** It must be equal or greater than 0 and between Lower and Upper (errorCode XA05)", "$ref": "#/components/schemas/Number" }, "upperPosition": { "description": "The upper position to be set for the calendar\n\n **Validation Rule(s)** It must be a valid value\n(errorCode SC01)", "$ref": "#/components/schemas/Number" }, "resetToBasePos": { "description": "Whether the LAC is set with reset to base option or not\n\n **Validation Rule(s)** It must be a valid value\n(errorCode SC01)", "$ref": "#/components/schemas/Boolean" } }, "required": [ "lacNumber", "lowerPosition", "basePosition", "upperPosition", "resetToBasePos" ] }, "ExceptionLacValues1": { "type": "object", "properties": { "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS", "$ref": "#/components/schemas/Bic11Only" }, "lacNumber": { "description": "LAC number for which the values are set", "$ref": "#/components/schemas/LacNumber" }, "lowerPosition": { "description": "LAC-n lower position", "$ref": "#/components/schemas/Number" }, "basePosition": { "description": "LAC-n base position", "$ref": "#/components/schemas/Number" }, "upperPosition": { "description": "LAC-n upper position", "$ref": "#/components/schemas/Number" }, "resetToBasePos": { "description": "Reset to base position option. Allowed values:\n- true\n- false", "$ref": "#/components/schemas/Boolean" } }, "required": [ "settlementBIC", "lacNumber", "lowerPosition", "basePosition", "upperPosition", "resetToBasePos" ] }, "FileDetails": { "type": "object", "properties": { "sendingInstitution": { "description": "The STEP2 CS BIC code", "$ref": "#/components/schemas/BIC8" }, "receivingInstitution": { "description": "The BIC of the Direct Participant configured as the Preferred Agent. It corresponds to the senderBIC", "$ref": "#/components/schemas/BIC8" }, "moduleIdentifier": { "description": "fixed value CGS", "$ref": "#/components/schemas/ModuleIdentifier" }, "businessDate": { "description": "The business date in which this file was created by CGS", "$ref": "#/components/schemas/Date" }, "creationDtTm": { "description": "Date and Time of file creation", "$ref": "#/components/schemas/DateTime" }, "calendarDate": { "description": "The file calendar date", "$ref": "#/components/schemas/Date" }, "fileReference": { "description": "The Sender’s File Reference for the file created by the module.", "$ref": "#/components/schemas/FileReference" }, "fileType": { "description": "The file type", "$ref": "#/components/schemas/FileType" }, "networkFileName": { "description": "The network file name", "$ref": "#/components/schemas/NetworkFileName" }, "lacNumber": { "description": "The LAC in which the file was created for sending to the Participant", "$ref": "#/components/schemas/LacNumber" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatus" }, "lastStatusUpdate": { "description": "The date and time of the last status update", "$ref": "#/components/schemas/DateTime" }, "lmrData": { "description": "If fileType is “LMR”, then lmrData is present", "$ref": "#/components/schemas/LmrData" }, "lnrData": { "description": "If FileType is “LNR”, then lnrData is present", "$ref": "#/components/schemas/LnrData" }, "dlrData": { "description": "If fileType is “DLR”, then dlrData is present", "$ref": "#/components/schemas/DlrData" } }, "required": [ "sendingInstitution", "receivingInstitution", "moduleIdentifier", "businessDate", "creationDtTm", "calendarDate", "fileType", "networkFileName", "lacNumber", "fileStatus", "lastStatusUpdate" ] }, "FileDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria8" } }, "required": [ "dateTime", "searchCriteria" ] }, "FileDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "fileDetails": { "$ref": "#/components/schemas/FileDetails" } }, "required": [ "dateTime", "fileDetails" ] }, "FileList": { "type": "object", "properties": { "preferredAgentBIC": { "description": "The Step2 Preferred Agent BIC linked to the Settlement BIC", "$ref": "#/components/schemas/BIC8" }, "fileType": { "description": "The type of file.", "$ref": "#/components/schemas/FileType" }, "dateTime": { "description": "The date and time of the file's creation", "$ref": "#/components/schemas/DateTime" }, "date": { "description": "The Date Type. In this field must be set Business Date or Calendar Date", "$ref": "#/components/schemas/Date" }, "lacNumber": { "description": "The LAC running when the file was created", "$ref": "#/components/schemas/LacNumber" }, "fileReference": { "description": "The Sender’s File Reference created by the module", "$ref": "#/components/schemas/FileReference" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatus" }, "networkFileName": { "description": "The network file name", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The network used for the reception/sending of the file", "$ref": "#/components/schemas/Network" } }, "required": [ "preferredAgentBIC", "fileType", "dateTime", "date", "lacNumber", "fileReference", "fileStatus", "networkFileName", "network" ] }, "FileReference": { "description": "Sender's File Reference for the file. Generated by the sending DP for ICFs and by the STEP2 central system for all others files", "type": "string", "pattern": "[0-9A-Z]{16,16}", "examples": [ "TESTFILEREF01234" ] }, "FileStatus": { "description": "Status of the file", "type": "string", "enum": [ "TSD", "TSG", "ERR", "RNS" ], "examples": [ "TSD" ] }, "FileType": { "description": "The type of File", "type": "string", "enum": [ "LNR", "LMR", "DLR" ], "examples": [ "LNR" ] }, "FundingDefunding": { "type": "object", "properties": { "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS", "$ref": "#/components/schemas/Bic11Only" }, "responseInstructionTp": { "description": "The instruction type", "$ref": "#/components/schemas/InstructionTypeResponse" }, "instructionReference": { "description": "The instruction’s unique reference created by the system", "$ref": "#/components/schemas/InstructionReference" }, "instructionStatus": { "description": "The instruction status", "$ref": "#/components/schemas/InstructionStatus" }, "date": { "description": "Date interval in which the instruction has been sent or received to / from T2I", "$ref": "#/components/schemas/Date" }, "amount": { "description": "Amount of the instruction", "$ref": "#/components/schemas/Amount1" }, "debitSttlmBIC": { "description": "Settlement BIC to be debited", "$ref": "#/components/schemas/BIC11" }, "creditSttlmBIC": { "description": "Settlement BIC to be credited", "$ref": "#/components/schemas/BIC11" }, "debitBIC": { "description": "Participant to be debited", "$ref": "#/components/schemas/BIC11" }, "creditBIC": { "description": "Participant to be credited", "$ref": "#/components/schemas/BIC11" }, "settlementDateTime": { "description": "The instruction settlement timestamp", "$ref": "#/components/schemas/DateTime" } }, "required": [ "responseInstructionTp", "instructionReference", "instructionStatus", "date", "amount", "debitSttlmBIC", "creditSttlmBIC", "settlementDateTime" ] }, "FundingDefundingDetails": { "type": "object", "properties": { "settlementBIC": { "description": "The STEP2 Settlement BIC owning a liquidity position in CGS", "$ref": "#/components/schemas/Bic11Only" }, "amount": { "description": "The requested amount[maximum allowed length 15d]", "$ref": "#/components/schemas/Amount1" } }, "required": [ "settlementBIC", "amount" ] }, "GetDefaultAgendaRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request", "$ref": "#/components/schemas/DateTime" }, "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS\n\n **Validation Rule(s)** It must correspond to one of the settlement BIC configured for the senderBIC, corresponding to the Preferred Agent (errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" } }, "required": [ "dateTime", "settlementBIC" ] }, "GetDefaultAgendaResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS", "$ref": "#/components/schemas/Bic11Only" }, "defaultAgenda": { "$ref": "#/components/schemas/DefaultAgenda" } }, "required": [ "dateTime", "defaultAgenda" ] }, "InstructionReference": { "description": "Instruction?s unique reference created by the system", "type": "string", "maxLength": 16, "examples": [ "INSREF1234567890" ] }, "InstructionStatus": { "description": "Instruction Status", "type": "string", "enum": [ "VAL", "NVA", "ERR", "DEL" ], "examples": [ "VAL" ] }, "InstructionTypeRequest": { "description": "Type of the instructions", "type": "string", "enum": [ "RFU", "RDE", "FUN", "DEF" ], "examples": [ "RFU" ] }, "InstructionTypeResponse": { "description": "Type of the instructions", "type": "string", "enum": [ "RFU", "RDE", "FRJ", "PFU", "TFU", "T2F", "RRT", "RRM", "SRE" ], "examples": [ "RDE" ] }, "InterestDailyReportRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria3" } }, "required": [ "dateTime", "searchCriteria" ] }, "InterestDailyReportResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "settlementBIC": { "description": "The Settlement BIC of the Preferred Agent sending the request", "$ref": "#/components/schemas/Bic11Only" }, "interestReports": { "$ref": "#/components/schemas/InterestReports" } }, "required": [ "dateTime", "interestReports" ] }, "InterestMonthlyReportRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria2" } }, "required": [ "dateTime", "searchCriteria" ] }, "InterestMonthlyReportResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "interestReport": { "type": "array", "items": { "$ref": "#/components/schemas/InterestReport" } } }, "required": [ "dateTime", "interestReport" ] }, "InterestReport": { "type": "object", "properties": { "settlementBIC": { "description": "The settlement BIC of the preferred agent sending the request", "$ref": "#/components/schemas/Bic11Only" }, "month": { "description": "The month to be considered", "$ref": "#/components/schemas/YearMonth" }, "monthlyInterestAmount": { "description": "The total Interest amount calculated for the “month” to be settled for the relevant settlementBIC", "$ref": "#/components/schemas/Amount1" } }, "required": [ "month", "monthlyInterestAmount" ] }, "InterestReports": { "type": "object", "properties": { "dailyReport": { "description": "The following section can 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", "maxItems": 31, "items": { "$ref": "#/components/schemas/DailyReport" } } }, "required": [ "dailyReport" ] }, "LacDefaultAgenda": { "type": "object", "properties": { "lacNumber": { "description": "The relevant LAC\n\n **Validation Rule(s)** It must a valid code\n(errorCode SC01)", "$ref": "#/components/schemas/LacNumber" }, "lowerPosition": { "description": "LAC-n lower position\n\n **Validation Rule(s)** It must be between 0 and Base\n(errorCode XA05)", "$ref": "#/components/schemas/Number" }, "basePosition": { "description": "LAC-n base position\n\n **Validation Rule(s)** It must be equal or greater than 0 and between Lower and Upper\n(errorCode XA05)", "$ref": "#/components/schemas/Number" }, "upperPosition": { "description": "LAC-n upper position\n\n **Validation Rule(s)** It must be a valid value\n(errorCode SC01)", "$ref": "#/components/schemas/Number" }, "resetToBasePos": { "description": "Reset to base position option. Possible values:\n- true\n- false\n\n **Validation Rule(s)** It must be a valid value\n(errorCode SC01)", "$ref": "#/components/schemas/Boolean" } }, "required": [ "lacNumber", "lowerPosition", "basePosition", "upperPosition", "resetToBasePos" ] }, "LacDefaultAgenda1": { "type": "object", "properties": { "lacNumber": { "description": "The relevant LAC number", "$ref": "#/components/schemas/LacNumber" }, "lowerPosition": { "description": "LAC-n lower position", "$ref": "#/components/schemas/Number" }, "basePosition": { "description": "LAC-n base position", "$ref": "#/components/schemas/Number" }, "upperPosition": { "description": "LAC-n upper position", "$ref": "#/components/schemas/Number" }, "resetToBasePos": { "description": "Reset to base position option.\nAllowed values:\n- true\n- false", "$ref": "#/components/schemas/Boolean" } }, "required": [ "lacNumber", "lowerPosition", "basePosition", "upperPosition", "resetToBasePos" ] }, "LacNumber": { "description": "The LAC in which the relevant LCR was generated", "type": "string", "pattern": "[0-9]{1,2}", "examples": [ "01" ] }, "LacParameters": { "type": "object", "properties": { "lac": { "description": "The relevant liquidity adjustment checkpoint to which the timings above applies.", "$ref": "#/components/schemas/LacNumber" }, "lacSendingCutOffTime": { "description": "Identifies the relevant LAC Sending cut-off", "$ref": "#/components/schemas/Time" }, "lacAdjustmentTime": { "description": "Identifies the relevant LAC Adjustment Time", "$ref": "#/components/schemas/Time" }, "nightTimeSettlement": { "description": "Identifies whether the relevant LAC is configured (true) or not (false) for Night-Time Settlement", "$ref": "#/components/schemas/Boolean" } }, "required": [ "lac", "lacSendingCutOffTime", "lacAdjustmentTime", "nightTimeSettlement" ] }, "LcrDetails": { "type": "object", "properties": { "service": { "description": "The identifier of the STEP2 Service", "$ref": "#/components/schemas/Service" }, "lcrReference": { "description": "The reference of the LCR", "$ref": "#/components/schemas/OperationReference" }, "businessDate": { "description": "The relevant business date", "$ref": "#/components/schemas/Date" }, "originalBulk": { "description": "The original bulk reference", "$ref": "#/components/schemas/BulkReference" }, "originalFileRef": { "description": "The original input file reference", "$ref": "#/components/schemas/FileReference" }, "bulkType": { "description": "The bulk type", "$ref": "#/components/schemas/MessageType" }, "instgAgt": { "description": "The STEP2 DP Instructing Agent.\nCorresponds to the Credit Party DP for Pacs.003 and Pacs.004 messages processed in SDD;\nCorresponds Debit Party for Pacs.004 and Pacs.008 in SCT and for Pacs.007 in SDD", "$ref": "#/components/schemas/BIC8" }, "instdAgt": { "description": "The STEP2 DP Instructed Agent.\nCorresponds to the Debit Party DP for Pacs.003 and Pacs.004 messages processed in SDD;\nCorresponds Credit Party for Pacs.004 and Pacs.008 in SCT and for Pacs.007 in SDD.", "$ref": "#/components/schemas/BIC8" }, "instgSttlmBIC": { "description": "The Settlement BIC configured for the Instructing Agent", "$ref": "#/components/schemas/Bic11Only" }, "instdSttlmBIC": { "description": "The Settlement BIC configured for the Instructed Agent", "$ref": "#/components/schemas/Bic11Only" }, "credPartyBIC": { "description": "The Credit Party BIC\nThis field corresponds to the Instructed Agent of the original instruction for Pacs.004 and Pacs.008", "$ref": "#/components/schemas/BIC8" }, "debPartyBIC": { "description": "The Debit Party BIC\nThis field corresponds to the Instructing Agent of the original instruction for Pacs.004 and Pacs.008", "$ref": "#/components/schemas/BIC8" }, "lacInputFromS2": { "description": "The LAC running on the relevant STEP2 Service when the LCR has been put on the Request Input Queue", "$ref": "#/components/schemas/LacNumber" }, "cgsLacInput": { "description": "The LAC running on CGS Module when the LCR has been retrieved from the Request Input Queue", "$ref": "#/components/schemas/LacNumber" }, "cgsLacOutput": { "description": "The LAC running on CGS when the LCR has been put on the Response Output Queue", "$ref": "#/components/schemas/LacNumber" }, "amount": { "description": "The amount managed in the relevant LCR", "$ref": "#/components/schemas/Amount1" }, "numTransactions": { "description": "The number of transactions included in the relevant LCR\n[maximum length 12n]", "$ref": "#/components/schemas/Number1" }, "lcrStatus": { "description": "The LCR status", "$ref": "#/components/schemas/LcrStatus" }, "s2LcrCreationTimestamp": { "description": "The timestamp when the STEP2 Service created the LCR", "$ref": "#/components/schemas/DateTime" }, "cgsLcrStatusUpdate": { "description": "The timestamp when the CGS updated positively/negatively the LCR status and sent back the outcome to the related STEP2 Service", "$ref": "#/components/schemas/DateTime" }, "dbrCrdFlag": { "description": "Whether the LCR results in a debit or credit position\nC=Credit\nD=Debit", "$ref": "#/components/schemas/Sign" } }, "required": [ "service", "lcrReference", "businessDate", "originalBulk", "originalFileRef", "bulkType", "instgAgt", "instdAgt", "instgSttlmBIC", "instdSttlmBIC", "credPartyBIC", "debPartyBIC", "lacInputFromS2", "cgsLacInput", "cgsLacOutput", "amount", "numTransactions", "lcrStatus", "s2LcrCreationTimestamp", "cgsLcrStatusUpdate", "dbrCrdFlag" ] }, "LcrDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria5" } }, "required": [ "dateTime", "searchCriteria" ] }, "LcrDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "lcrDetails": { "$ref": "#/components/schemas/LcrDetails" } }, "required": [ "dateTime", "lcrDetails" ] }, "LcrListRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria4" }, "offset": { "description": "Offset is used in lists that support pagination\n\n **Validation Rule(s)** If present, it must report the value of the previous lcrList Positive Response", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "searchCriteria" ] }, "LcrListResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "lcrs": { "type": "array", "items": { "$ref": "#/components/schemas/Lcrs" } }, "endOfList": { "description": "Flag field used to inform if the last element (record) of the list has been reached:\ntrue= the record list is completed\nfalse= the record list is partial", "$ref": "#/components/schemas/Boolean" }, "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", "lcrs", "endOfList" ] }, "Lcrs": { "type": "object", "properties": { "instgAgt": { "description": "The Instructing Agent BIC", "$ref": "#/components/schemas/BIC8" }, "instdAgt": { "description": "The Instructed Agent BIC", "$ref": "#/components/schemas/BIC8" }, "instgSttlmBIC": { "description": "The Settlement BIC configured for the Instructing Agent", "$ref": "#/components/schemas/Bic11Only" }, "instdSttlmBIC": { "description": "The Settlement BIC configured for the Instructed Agent", "$ref": "#/components/schemas/Bic11Only" }, "settlementDate": { "description": "The LCR Settlement Date", "$ref": "#/components/schemas/Date" }, "businessDateTime": { "description": "DateTime when the LCR closed its lifecycle", "$ref": "#/components/schemas/DateTime" }, "lcrReference": { "description": "The LCR Reference", "$ref": "#/components/schemas/OperationReference" }, "lacNumber": { "description": "The LAC in which the lifecycle of the relevant LCR completed", "$ref": "#/components/schemas/LacNumber" }, "lcrStatus": { "description": "The LCR status", "$ref": "#/components/schemas/LcrStatus" }, "service": { "description": "The identifier of the STEP2 Service", "$ref": "#/components/schemas/Service" }, "amount": { "description": "The amount of the LCR", "$ref": "#/components/schemas/Amount1" }, "originalBulkReferenceId": { "description": "The reference Id of the original bulk", "$ref": "#/components/schemas/BulkReference" }, "originalInputFileReferenceId": { "description": "The reference Id of the original input file", "$ref": "#/components/schemas/FileReference" }, "dbrCrdFlag": { "description": "Whether the LCR results in a debit or credit position\nC=Credit\nD=Debit", "$ref": "#/components/schemas/Sign" }, "CreationDateTime": { "description": "The date and time of the API response creation", "$ref": "#/components/schemas/DateTime" } }, "required": [ "instgAgt", "instdAgt", "instgSttlmBIC", "instdSttlmBIC", "settlementDate", "businessDateTime", "lcrReference", "lacNumber", "lcrStatus", "service", "amount", "originalBulkReferenceId", "originalInputFileReferenceId", "dbrCrdFlag", "CreationDateTime" ] }, "LcrStatus": { "description": "The LCR status", "type": "string", "enum": [ "STTLD", "CANC", "REVK", "RJCT", "QUEU" ], "examples": [ "STTLD" ] }, "LiquidityManagementRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request", "$ref": "#/components/schemas/DateTime" }, "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS\n\n **Validation Rule(s)** It must correspond to one of the settlement BIC configured for the senderBIC, corresponding to the Preferred Agent (errorCode PY01).\n\nDPWS users whose Settlement BIC has been suspended are not allowed to defund their liquidity", "$ref": "#/components/schemas/Bic11Only" }, "amount": { "description": "Amount to be funded or defunded according to transferTp\n\n **Validation Rule(s)** The Position must be greater than or equal to the Amount\n(errorCode XA05)\nThe Amount cannot be greater than 999999999999.99\n(errorCode XA05)\nThe Amount cannot be equal to 0\n(errorCode XA05)\nOnly decimal notation is allowed\n(errorCode XA05)", "$ref": "#/components/schemas/Amount1" }, "transferTp": { "description": "Value allowed:\nF (request for funding)\nD (defunding)\n\n **Validation Rule(s)** It must be a valid code\n(errorCode SC01)", "$ref": "#/components/schemas/TransferType" } }, "required": [ "dateTime", "settlementBIC", "amount", "transferTp" ] }, "LiquidityManagementResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "availableLiquidity": { "description": "The available liquidity.\nIn case of defunding operations, the amount is calculated starting from the current amount minus the defunding amount in the request", "$ref": "#/components/schemas/Amount1" } }, "required": [ "dateTime", "availableLiquidity" ] }, "ListAlertsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria9" }, "offset": { "description": "Indicator used to manage pagination\n\n **Validation Rule(s)** If set, it must correspond to the value provided in the previous listAlerts Response", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "searchCriteria" ] }, "ListAlertsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "alerts": { "description": "List of alerts matching search criteria", "type": "array", "items": { "$ref": "#/components/schemas/Alerts" } }, "endOfList": { "description": "Whether the provided list contains all relevant records. Possible values:\ntrue= the list is complete\nfalse= the list is not complete", "$ref": "#/components/schemas/Boolean" }, "offset": { "description": "Provided only if endOfList is set to false. It must be used in the subsequent listAlerts Request to get the next portion of the list", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "alerts", "endOfList" ] }, "ListCalendarRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS\n\n **Validation Rule(s)** It must correspond to one of the settlement BIC configured for the senderBIC, corresponding to the Preferred Agent (errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "businessDate": { "description": "The business date for which the values are requested\n\n **Validation Rule(s)** The date can be the current date (TARGET date) or a future target date no further than one year from the current one (errorCode DT01)", "$ref": "#/components/schemas/Date" } }, "required": [ "dateTime", "settlementBIC", "businessDate" ] }, "ListCalendarResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "businessDate": { "description": "The business date for which the values are requested", "$ref": "#/components/schemas/Date" }, "exceptionLacValues": { "type": "array", "items": { "$ref": "#/components/schemas/ExceptionLacValues1" } } }, "required": [ "dateTime", "businessDate", "exceptionLacValues" ] }, "ListCommandsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria10" }, "offset": { "description": "The pointer returned in the previous API Response, useful to obtain the next group of records satisfying the same filtering criteria.\n\n **Validation Rule(s)** It can be filled only with the same value as the offset field of the previous API Response returned to the previous API Request with the same filtering criteria (it must be empty for the first API Request)", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "searchCriteria" ] }, "ListCommandsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response", "$ref": "#/components/schemas/DateTime" }, "commands": { "type": "array", "items": { "$ref": "#/components/schemas/Commands" } }, "endOfList": { "description": "The flag used to show if the list is complete or not\ntrue= The list is completed\nfalse= The list is partial", "$ref": "#/components/schemas/EndOfList" }, "offset": { "description": "It indicates if there are more records satisfying the searching criteria; to get them, the offset value must be copied in the offset field of a new API Request that must also contain the same filtering criteria than the current one", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "commands", "endOfList" ] }, "ListFilesRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria7" }, "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", "searchCriteria" ] }, "ListFilesResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "fileList": { "type": "array", "items": { "$ref": "#/components/schemas/FileList" } }, "endOfList": { "description": "Flag field used to inform if the last element (record) of the list has been reached:\ntrue= the record list is completed\nfalse= the record list is partial", "$ref": "#/components/schemas/Boolean" }, "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", "fileList", "endOfList" ] }, "ListFundingDefundingRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria1" }, "offset": { "description": "The pointer returned in the previous API Response, useful to obtain the next group of instructions satisfying the same filtering criteria.\n\n **Validation Rule(s)** It can be filled only with the same value as the Pointer field of the previous API Response returned to the previous API Request with the same filtering criteria (it must be empty for the first API Request).", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "searchCriteria" ] }, "ListFundingDefundingResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "fundingDefunding": { "type": "array", "items": { "$ref": "#/components/schemas/FundingDefunding" } }, "endOfList": { "description": "Flag field used to inform if the last element (record) of the list has been reached:\ntrue= the record list is completed\nfalse= the record list is partial", "$ref": "#/components/schemas/Boolean" }, "offset": { "description": "It indicates if there are more instructions satisfying the searching criteria; to get them, the Pointer value must be copied in the Pointer field of a new API Request that must also contain the same filtering criteria than the current one.", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "fundingDefunding", "endOfList" ] }, "ListLACsConfigurationRequest": { "type": "object", "properties": { "dateTime": { "description": "Standard ISO Date-Time.\nThe date and time of the request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria12" } }, "required": [ "dateTime" ] }, "ListLACsConfigurationResponse": { "type": "object", "properties": { "dateTime": { "description": "Standard ISO Date-Time.\nThe 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" } }, "otherModuleCutOff": { "$ref": "#/components/schemas/OtherModuleCutOff" } }, "required": [ "dateTime", "lacParameters", "otherModuleCutOff" ] }, "ListOperationRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria11" }, "offset": { "description": "The pointer returned in the previous API Response, useful to obtain the next group of records satisfying the same filtering criteria.\n\n **Validation Rule(s)** It can be filled only with the same value as the offset field of the previous API Response returned to the previous API Request with the same filtering criteria (it must be empty for the first API Request)", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime" ] }, "ListOperationResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the the API Response creation", "$ref": "#/components/schemas/DateTime" }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/Operations" } }, "endOfList": { "description": "The flag used to show if the list is complete or not\ntrue= The list is completed\nfalse= The list is partial", "$ref": "#/components/schemas/EndOfList" }, "offset": { "description": "It indicates if there are more records satisfying the searching criteria; to get them, the offset value must be copied in the offset field of a new API Request that must also contain the same filtering criteria than the current one", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "operations", "endOfList" ] }, "ListSettlementBICsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria" } }, "required": [ "dateTime" ] }, "ListSettlementBICsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Responsecreation", "$ref": "#/components/schemas/DateTime" }, "settlementBICs": { "type": "array", "items": { "$ref": "#/components/schemas/SettlementBICs" } } }, "required": [ "dateTime", "settlementBICs" ] }, "LmrData": { "type": "object", "properties": { "numTotBulks": { "description": "The total number of bulks contained in the file", "$ref": "#/components/schemas/Number" }, "positionLacOpen": { "description": "The position of Settlement BIC at LAC opening", "$ref": "#/components/schemas/Amount1" }, "positionLacClose": { "description": "The position of Settlement BIC at LAC closure", "$ref": "#/components/schemas/Amount1" }, "liquidityInstrDebitPosition": { "description": "The CGS Settlement BIC debit position resulting from the processing of liquidity instructions (funding/ defunding) exchanged with T2I", "$ref": "#/components/schemas/Amount1" }, "liquidityInstrCreditPosition": { "description": "The CGS Settlement BIC credit position resulting from the processing of liquidity instructions (funding /defunding) exchanged with T2I", "$ref": "#/components/schemas/Amount1" }, "processedLCRDebitPosition": { "description": "The CGS settlement BIC debit position resulting from settled LCRs. The position of Settlement BIC at LAC closure", "$ref": "#/components/schemas/Amount1" }, "processedLCRCreditPosition": { "description": "The CGS settlement BIC credit position resulting from settled LCRs", "$ref": "#/components/schemas/Amount1" } }, "required": [ "numTotBulks" ] }, "LnrData": { "type": "object", "properties": { "positionNotification": { "description": "The Settlement BIC position:\n- For camt.052: the position exceeding the threshold;\n- For camt.054: the position after the adjustment occurred.", "$ref": "#/components/schemas/Amount1" }, "positionDtTm": { "description": "The position date and time:\n- For camt.052: the date and time of the operation that caused the threshold to exceed;\n- For camt.054: the date and time of the adjustment.", "$ref": "#/components/schemas/DateTime" } }, "required": [ "positionNotification", "positionDtTm" ] }, "MessageType": { "description": "The type of message", "type": "string", "enum": [ "Pacs.003", "Pacs.004", "Pacs.007", "Pacs.008" ], "examples": [ "Pacs.008" ] }, "ModuleIdentifier": { "type": "string", "enum": [ "CGS" ], "examples": [ "CGS" ] }, "Network": { "description": "Network from which the file is received or sent", "type": "string", "enum": [ "EAS", "EBX", "SWF", "SWA", "SWS", "SWM" ], "examples": [ "SWF" ] }, "NetworkFileName": { "description": "Network file name of the file", "type": "string", "pattern": "[A-Z0-9]{15,30}\\.[A-Z]{1,1}", "examples": [ "S202SCTTESTITMMF800AAA.I" ] }, "Number": { "description": "Standard Number", "type": "number", "maximum": 999999999999999, "examples": [ 100000 ] }, "Number1": { "description": "Standard Number", "type": "number", "maximum": 999999999999, "examples": [ 100000 ] }, "Offset": { "description": "Offset is used in lists that support pagination", "type": "string", "examples": [ "AAaa88ss2345fggGGDDaaaHH" ] }, "OperationDetails": { "type": "object", "properties": { "settlementBIC": { "description": "The Settlement BIC to which the operation refers", "$ref": "#/components/schemas/BIC11" }, "operationType": { "description": "The operation type.\nIt can include: Update, Amend Change, Revoke Change", "$ref": "#/components/schemas/OperationType1" }, "operationStatus": { "description": "The operation status", "$ref": "#/components/schemas/OperationStatus" }, "commandRef": { "description": "The reference of the operation", "$ref": "#/components/schemas/OperationReference1" }, "effectiveDate": { "description": "The effective date of the requested operation", "$ref": "#/components/schemas/Date" }, "requestDateTime": { "description": "The date and time of the issuing of the operation", "$ref": "#/components/schemas/DateTime" }, "authRejectDateTime": { "description": "The date and time of the authorization/rejection of the operation", "$ref": "#/components/schemas/DateTime" }, "userIssuer": { "description": "The user Id of the user who issued the operation", "$ref": "#/components/schemas/User" }, "userAuthReject": { "description": "The user Id of the user who authorized/rejected the operation", "$ref": "#/components/schemas/User" }, "critical": { "description": "Whether the operation is critical or not. Possible values:\ntrue=critical\nfalse=non-critical", "$ref": "#/components/schemas/Boolean" }, "CGSSettlementBIC": { "$ref": "#/components/schemas/CGSSettlementBIC" } }, "required": [ "settlementBIC", "operationType", "operationStatus", "commandRef", "effectiveDate", "requestDateTime", "userIssuer", "critical" ] }, "OperationDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "commandRef": { "description": "The operation reference", "$ref": "#/components/schemas/CommandReference" } }, "required": [ "dateTime", "commandRef" ] }, "OperationDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "operationDetails": { "$ref": "#/components/schemas/OperationDetails" } }, "required": [ "dateTime" ] }, "OperationReference": { "description": "The unique reference that identifies the operation leading to the Settlement BIC position", "type": "string", "maxLength": 16, "examples": [ "REF0123456789111" ] }, "OperationReference1": { "description": "The unique reference that identifies the operation leading to the Settlement BIC position", "type": "string", "maxLength": 22, "examples": [ "REF012345678911111" ] }, "Operations": { "type": "object", "properties": { "userIssuer": { "description": "The UserID of the user that has issued the command", "$ref": "#/components/schemas/User" }, "userAuthReject": { "description": "The UserID of the user that has authorized or rejected the command", "$ref": "#/components/schemas/User" }, "settlementBIC": { "description": "The Settlement BIC related to the request", "$ref": "#/components/schemas/Bic11Only" }, "operationType": { "description": "The type of operation", "$ref": "#/components/schemas/OperationType" }, "operationStatus": { "description": "The status of the relevant operation", "$ref": "#/components/schemas/OperationStatus" }, "commandRef": { "description": "The reference of the operation", "$ref": "#/components/schemas/CommandReference" }, "requestDateTime": { "description": "The date and time at which the command has been issued", "$ref": "#/components/schemas/DateTime" }, "authRejectExecDateTime": { "description": "The date and time at which the command has been authorized or rejected", "$ref": "#/components/schemas/DateTime" }, "effectiveDate": { "description": "The business date starting from which the relevant operation is effective.", "$ref": "#/components/schemas/Date" }, "critical": { "description": "Whether the relevant operation is critical or non-critical", "$ref": "#/components/schemas/Boolean" } }, "required": [ "userIssuer", "settlementBIC", "operationType", "operationStatus", "commandRef", "requestDateTime", "effectiveDate", "critical" ] }, "OperationStatus": { "type": "string", "enum": [ "Submitted", "To be Authorized", "Authorized", "Executed", "Rejected", "Rejected by system" ], "examples": [ "Authorized" ] }, "OperationType": { "type": "string", "enum": [ "Update", "Amend Change", "Revoke Change" ], "examples": [ "Update" ] }, "OperationType1": { "type": "string", "examples": [ "Update, Amend Change, Revoke Change" ] }, "OtherModuleCutOff": { "type": "object", "properties": { "openingTime": { "description": "Identifies the CGS Opening Time", "$ref": "#/components/schemas/Time" }, "taw1Start": { "description": "Identifies the start of the first TARGET Availability Window for the day.", "$ref": "#/components/schemas/Time" }, "taw1End": { "description": "Identifies the end of the first TARGET Availability Window for the day.", "$ref": "#/components/schemas/Time" }, "taw2Start": { "description": "Identifies the start of the second TARGET Availability Window for the day.", "$ref": "#/components/schemas/Time" }, "taw2End": { "description": "Identifies the end of the second TARGET Availability Window for the day.", "$ref": "#/components/schemas/Time" }, "taw3Start": { "description": "Identifies the start of the TARGET Availability Window for a Non-Target day following a Target day.", "$ref": "#/components/schemas/Time" }, "taw3End": { "description": "Identifies the end of the of the TARGET Availability Window for a Non-Target day following a Target day.", "$ref": "#/components/schemas/Time" }, "taw4Start": { "description": "Identifies the start of the TARGET Availability Window for a Target day following a Non-Target day.", "$ref": "#/components/schemas/Time" }, "taw4End": { "description": "Identifies the end of the of the TARGET Availability Window for a Target day following a Non-Target day.", "$ref": "#/components/schemas/Time" }, "cgsEOD": { "description": "Identifies the CGS EOD", "$ref": "#/components/schemas/Time" }, "sctEOD": { "description": "Identifies the SCT EOD", "$ref": "#/components/schemas/Time" }, "corEOD": { "description": "Identifies the CORE EOD", "$ref": "#/components/schemas/Time" }, "b2bEOD": { "description": "Identifies the B2B EOD", "$ref": "#/components/schemas/Time" } }, "required": [ "openingTime", "cgsEOD", "sctEOD", "corEOD", "b2bEOD" ] }, "ParModhistory": { "type": "object", "properties": { "initParameterValidity": { "description": "Initial Validity Date of the parameter change", "$ref": "#/components/schemas/Date" }, "endParameterValidity": { "description": "End Validity Date of the parameter change", "$ref": "#/components/schemas/Date" }, "detailsHistory": { "description": "Present only in case the sender BIC inquires its details", "$ref": "#/components/schemas/DetailsHistory" } }, "required": [ "initParameterValidity", "endParameterValidity" ] }, "ParticipantName": { "description": "Name of Participant", "type": "string", "pattern": "(^\\S+.*){1,50}", "examples": [ "ExampleBank01" ] }, "ParticipantStatus": { "description": "Status of participant", "type": "string", "enum": [ "INS", "ENB", "DIS", "SUS", "CHG" ], "examples": [ "ENB" ] }, "PositionHistory": { "type": "object", "properties": { "settlementBIC": { "$ref": "#/components/schemas/Bic11Only" }, "businessDate": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS", "$ref": "#/components/schemas/Date" }, "lacNumber": { "description": "The relevant LAC", "$ref": "#/components/schemas/LacNumber" }, "amount": { "description": "Amount corresponding to the position requested", "$ref": "#/components/schemas/Amount" }, "timeStamp": { "description": "TimeStamp of the moment the system retrieved the position of the Participant", "$ref": "#/components/schemas/DateTime" } }, "required": [ "settlementBIC", "businessDate", "lacNumber", "amount", "timeStamp" ] }, "PositionLacRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS\n\n **Validation Rule(s)** It must correspond to one of the settlement BIC configured for the senderBIC, corresponding to the Preferred Agent (errorCode PY01)\nIt must be a valid business date (errorCode DT01)", "$ref": "#/components/schemas/Bic11Only" }, "businessDateFrom": { "description": "The lowest value of date range for searching.\n\n **Validation Rule(s)** It can be maximum D-90 calendar days, where D is the current business day (errorCode DT01)\nIt must be a valid business date (errorCode DT01)", "$ref": "#/components/schemas/Date" }, "businessDateTo": { "description": "The highest value of date range for searching.\n\n **Validation Rule(s)** It must be greater than or equal to the businessDateFrom and maximum the current business day (errorCode DT01)", "$ref": "#/components/schemas/Date" }, "lacNumber": { "description": "LAC number\n\n **Validation Rule(s)** It must a valid code\n(errorCode SC01)", "$ref": "#/components/schemas/LacNumber" } }, "required": [ "dateTime", "settlementBIC", "businessDateFrom", "businessDateTo", "lacNumber" ] }, "PositionLacResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "positionHistory": { "type": "array", "items": { "$ref": "#/components/schemas/PositionHistory" } } }, "required": [ "dateTime", "positionHistory" ] }, "RejectParticipantOperationRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "commandRef": { "description": "The reference of the operation to be rejected\n\n **Validation Rule(s)** The relevant operation must not have been authorized yet\n(errorCode XA07)", "$ref": "#/components/schemas/CommandReference" } }, "required": [ "dateTime", "commandRef" ] }, "RejectParticipantOperationResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "commandRef": { "description": "The reference of the operation rejected with the API request (this operation is logged in the system in REJ status)", "$ref": "#/components/schemas/CommandReference" } }, "required": [ "dateTime", "commandRef" ] }, "RequestId": { "description": "Request Identification", "type": "string", "maxLength": 36, "examples": [ "REQID000011112222333445661234567890" ] }, "ResendAllDetails": { "type": "object", "properties": { "fileType": { "description": "The file type", "$ref": "#/components/schemas/FileType" }, "timestampLastUpdate": { "description": "The date and time of the last command’s update.", "$ref": "#/components/schemas/DateTime" }, "fileStatus": { "description": "The status of the files", "$ref": "#/components/schemas/FileStatus" } }, "required": [ "fileType", "timestampLastUpdate", "fileStatus" ] }, "ResendAllRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "fileType": { "description": "The file type", "$ref": "#/components/schemas/FileType" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatus" }, "lacNumber": { "description": "The relevant LAC", "$ref": "#/components/schemas/LacNumber" }, "dateFrom": { "description": "The oldest date of the required time range\n\n **Validation Rule(s)** dateFrom can be at maximum D-2 Calendar days\n(errorCode DT01)\nIt must be equal or lesser than dateTo\n(errorCode DT01)", "$ref": "#/components/schemas/Date" }, "dateTo": { "description": "The latest date of the required time range\n\n **Validation Rule(s)** It must be equal or greater than dateFrom\n(errorCode DT01)", "$ref": "#/components/schemas/Date" } }, "required": [ "dateTime", "fileType", "fileStatus", "lacNumber", "dateFrom", "dateTo" ] }, "ResendAllResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "commandRef": { "description": "The command reference", "$ref": "#/components/schemas/CommandReference" }, "commandStatus": { "description": "The command status", "$ref": "#/components/schemas/CommandStatus" } }, "required": [ "dateTime", "commandRef", "commandStatus" ] }, "RetransmitOutFileDetails": { "type": "object", "properties": { "settlementBIC": { "description": "The STEP2 Settlement BIC owning a liquidity position in CGS", "$ref": "#/components/schemas/Bic11Only" }, "preferredAgentBIC": { "description": "The BIC of the relevant Step2 Preferred Agent BIC", "$ref": "#/components/schemas/BIC8" }, "fileType": { "description": "The file type", "$ref": "#/components/schemas/FileType" }, "fileReference": { "description": "The reference of the relevant LMR/LNR/DLR.", "$ref": "#/components/schemas/FileReference" }, "fileStatus": { "description": "The status of LMR/LNR/DLR", "$ref": "#/components/schemas/FileStatus" }, "lac": { "description": "The LAC running on CGS when the LMR/LNR/DLR was created", "$ref": "#/components/schemas/LacNumber" }, "businessDate": { "description": "The relevant Business Date", "$ref": "#/components/schemas/Date" } }, "required": [ "settlementBIC", "preferredAgentBIC", "fileType", "fileReference", "fileStatus", "lac", "businessDate" ] }, "RetransmitOutFilesRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "networkFileName": { "description": "The network file name", "$ref": "#/components/schemas/NetworkFileName" } }, "required": [ "dateTime", "networkFileName" ] }, "RetransmitOutFilesResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "commandRef": { "description": "The command reference", "$ref": "#/components/schemas/CommandReference" }, "commandStatus": { "description": "The command status", "$ref": "#/components/schemas/CommandStatus" } }, "required": [ "dateTime", "commandRef", "commandStatus" ] }, "RevokeAllLcrDetails": { "type": "object", "properties": { "businessDate": { "description": "The relevant Business Date", "$ref": "#/components/schemas/Date" }, "settlementBIC": { "description": "The STEP2 Settlement BIC owning a liquidity position in CGS", "$ref": "#/components/schemas/Bic11Only" } }, "required": [ "businessDate", "settlementBIC" ] }, "RevokeChangeSettlementBICRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "settlementBIC": { "description": "The Settlement BIC for which the operation must be revoked\n\n **Validation Rule(s)** It must correspond to the Settlement BIC of the Preferred Agent sending the request\n(errorCode PY01)\nIt must be present in the system and it must not have ‘disabled’ status compared to the effectiveDate (errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "initParticipantValidity": { "description": "The Initial Parameter Validity Date set in the original command to be revoked\n\n **Validation Rule(s)** It must be present in routing repositories for the settlementBIC.\nIt must be set according to “Critical” constraints if related to a Critical operation.\n(errorCode DT01)", "$ref": "#/components/schemas/Date" }, "endParticipantValidity": { "description": "The End Parameter Validity Date set in the original command to be revoked\n\n **Validation Rule(s)** It must be present in routing repositories for the settlementBIC\n(errorCode DT01)", "$ref": "#/components/schemas/Date" } }, "required": [ "dateTime", "settlementBIC", "initParticipantValidity", "endParticipantValidity" ] }, "RevokeChangeSettlementBICResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "commandRef": { "description": "The command reference", "$ref": "#/components/schemas/CommandReference" } }, "required": [ "dateTime", "commandRef" ] }, "RevokeLcrDetails": { "type": "object", "properties": { "instgAgt": { "description": "The STEP2 DP Instructing Agent", "$ref": "#/components/schemas/BIC8" }, "instdAgt": { "description": "The STEP2 DP Instructed Agent", "$ref": "#/components/schemas/BIC8" }, "lcrReference": { "description": "The reference of the relevant LCR", "$ref": "#/components/schemas/OperationReference" }, "lcrStatus": { "description": "The status of LCR", "$ref": "#/components/schemas/LcrStatus" }, "instgSttlmBIC": { "description": "The Settlement BIC configured for the Instructing Agent", "$ref": "#/components/schemas/Bic11Only" }, "instdSttlmBIC": { "description": "The Settlement BIC configured for the Instructed Agent", "$ref": "#/components/schemas/Bic11Only" }, "s2Service": { "description": "The relevant Step2 Service", "$ref": "#/components/schemas/Service" }, "businessDate": { "description": "The relevant Business Date.", "$ref": "#/components/schemas/Date" } }, "required": [ "instgAgt", "instdAgt", "lcrReference", "lcrStatus", "instgSttlmBIC", "instdSttlmBIC", "s2Service", "businessDate" ] }, "RevokeLcrRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria6" } }, "required": [ "dateTime", "searchCriteria" ] }, "RevokeLcrResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "commandRef": { "description": "The reference of the command", "$ref": "#/components/schemas/CommandReference" }, "commandStatus": { "description": "The status of the command", "$ref": "#/components/schemas/CommandStatus" } }, "required": [ "dateTime", "commandRef", "commandStatus" ] }, "SearchCriteria": { "type": "object", "properties": { "settlementBIC": { "description": "The CGS Settlement BIC\n\n **Validation Rule(s)** It must be present in Routing Repositories (errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "preferredAgentBIC": { "description": "The STEP2 DP BIC allowed to manage the CGS Settlement BIC Participant’s liquidity and receive Output files from the CGS\n\n **Validation Rule(s)** It must be present in Routing Repositories (errorCode PY01)", "$ref": "#/components/schemas/BIC8" }, "status": { "description": "Status of Settlement BIC\n\n **Validation Rule(s)** It must be a valid code\n(errorCode SC01)", "$ref": "#/components/schemas/ParticipantStatus" }, "initialValidityDate": { "description": "The first business date starting from which the Settlement BIC is active (ENABLED) for the module, meaning that the Settlement BIC is allowed to settle LCRs and to receive output files. If InitialValidityDate is not yet live, then the status is INSERTED.\n\n **Validation Rule(s)** It must be previous or equal to endValidityDate (errorCode DT01)", "$ref": "#/components/schemas/Date" }, "endValidityDate": { "description": "The last business date at which the Settlement BIC is active (ENABLED). At EndValidityDate+1 the status of the Settlement BIC is DISABLED, meaning that it is not allowed to settle any LCRs in CGS module.\n\n **Validation Rule(s)** It must be greater than or equal to initialValidityDate (errorCode DT01)", "$ref": "#/components/schemas/Date" }, "preferredS2Service": { "description": "The STEP2 Service configured for the Preferred Agent BIC.\nAllowed values:\n- SCT\n- COR\n- B2B\n\n **Validation Rule(s)** It must be a valid code\n(errorCode SC01)", "$ref": "#/components/schemas/Service" } } }, "SearchCriteria1": { "type": "object", "properties": { "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS\n\n **Validation Rule(s)** If present, it must be equal to the settlement BIC of the Preferred Agent (errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "instructionTp": { "description": "The instruction type\n\n **Validation Rule(s)** It must be a valid code\n(errorCode SC01)", "$ref": "#/components/schemas/InstructionTypeRequest" }, "instructionReference": { "description": "The instruction’s unique reference created by the system", "$ref": "#/components/schemas/InstructionReference" }, "instructionStatus": { "description": "The instruction status\n\n **Validation Rule(s)** It must be a valid value\n(errorCode SC01)", "$ref": "#/components/schemas/InstructionStatus" }, "businessDateFrom": { "description": "Business Date interval in which the instruction has been sent or received to / from T2I\n\n **Validation Rule(s)** It must be a valid code\n(errorCode SC01)", "$ref": "#/components/schemas/Date" }, "businessDateTo": { "description": "Business Date interval in which the instruction has been sent or received to / from T2I\n\n **Validation Rule(s)** It must be greater than or equal to the businessDtFrom (errorCode DT01)", "$ref": "#/components/schemas/Date" }, "amountFrom": { "description": "Amount range of the instruction\n\n **Validation Rule(s)** If present it must be lesser than AmountRangeTo (errorCode XA05)\nThe amount cannot be greater than 999999999999.99 (errorCode XA05)\nOnly decimal notation is allowed\n(errorCode XA05)", "$ref": "#/components/schemas/Amount1" }, "amountTo": { "description": "Amount range of the instruction\n\n **Validation Rule(s)** If present it must be greater than AmountRangeFrom (errorCode XA05)\nThe amount cannot be greater than 999999999999.99 (errorCode XA05)\nOnly decimal notation is allowed\n(errorCode XA05)", "$ref": "#/components/schemas/Amount1" }, "debitSttlmBIC": { "description": "Settlement BIC to be debited", "$ref": "#/components/schemas/BIC11" }, "creditSttlmBIC": { "description": "Settlement BIC to be credited", "$ref": "#/components/schemas/BIC11" } }, "required": [ "instructionTp", "businessDateFrom", "businessDateTo" ] }, "SearchCriteria10": { "type": "object", "properties": { "commandType": { "description": "The command type\n\n **Validation Rule(s)** It can be set with one of the allowed values\n(errorCode SC01)", "$ref": "#/components/schemas/CommandType" }, "commandStatus": { "description": "The command status", "$ref": "#/components/schemas/CommandStatus" }, "requestDateTimeFrom": { "description": "The date and time in which the command has been issued - From\n\n **Validation Rule(s)** It must be previous or equal to the current date (errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "requestDateTimeTo": { "description": "The date and time in which the command has been issued - To\n\n **Validation Rule(s)** It must be greater than or equal to the dateFrom\n(errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "authRejectDateTimeFrom": { "description": "The date and time at which the command has been executed or rejected - From\n\n **Validation Rule(s)** It must be previous or equal to the current date (errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "authRejectDateTimeTo": { "description": "The date and time at which the command has been executed or rejected - To\n\n **Validation Rule(s)** It must be greater than or equal to the dateFrom\n(errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "userIssuer": { "description": "The UserID of the user that has issued the command", "$ref": "#/components/schemas/User" }, "userAuthReject": { "description": "The UserID of the user that has authorized or rejected the command", "$ref": "#/components/schemas/User" } } }, "SearchCriteria11": { "type": "object", "properties": { "userIssuer": { "description": "The UserID of the user that has issued the command", "$ref": "#/components/schemas/User" }, "userAuthReject": { "description": "The UserID of the user that has authorized or rejected the command", "$ref": "#/components/schemas/User" }, "settlementBIC": { "description": "The Settlement BIC related to the request", "$ref": "#/components/schemas/Bic11Only" }, "operationType": { "description": "The type of inquired operation\n\n **Validation Rule(s)** It must be set with one of the allowed values\n(errorCode SC01)", "$ref": "#/components/schemas/OperationType" }, "operationStatus": { "description": "The status of the inquired operation\n\n **Validation Rule(s)** It must be set with one of the allowed values\n(errorCode SC01)", "$ref": "#/components/schemas/OperationStatus" }, "commandRef": { "description": "The reference of the operation", "$ref": "#/components/schemas/CommandReference" }, "requestDate": { "description": "The date in which the operation has been issued", "$ref": "#/components/schemas/Date" }, "authRejectExecDateTime": { "description": "The date when the request is executed or rejected by the system", "$ref": "#/components/schemas/DateTime" }, "effectiveDate": { "description": "The business date starting from which the required operation is effective", "$ref": "#/components/schemas/Date" }, "critical": { "description": "Whether the relevant operations are critical or non-critical\n\n **Validation Rule(s)** It can be set only as\n- true, or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/Boolean" } } }, "SearchCriteria12": { "type": "object", "properties": { "defaultValues": { "description": "The flag used to show the requested parameters:\ntrue=default parameters are displayed\nfalse=current parameters (potentially resulting from an override) are displayed\nIf the field is not set, current parameters are retrieved", "$ref": "#/components/schemas/Boolean" } } }, "SearchCriteria2": { "type": "object", "properties": { "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS\n\n **Validation Rule(s)** It must correspond to one of the settlement BIC configured for the senderBIC, corresponding to the Preferred Agent (errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "monthFrom": { "description": "The lower range of the month to be considered for searching\n\n **Validation Rule(s)** It must be minor or equal to the monthTo and the year can be between the current and the last one\n(errorCode DT01)\nThe “Interest Calculation” status must be equal to “calculated” or “completed”\n(errorCode XA19)", "$ref": "#/components/schemas/YearMonth" }, "monthTo": { "description": "The higher range of the month to be considered for searching\n\n **Validation Rule(s)** It must be major or equal to the monthFrom and the year can be between the current and the last one\n(errorCode DT01)\nThe “Interest Calculation” status must be equal to “calculated” or “completed”\n(errorCode XA19)", "$ref": "#/components/schemas/YearMonth" } }, "required": [ "settlementBIC", "monthFrom", "monthTo" ] }, "SearchCriteria3": { "type": "object", "properties": { "settlementBIC": { "description": "The Generic BIC of participant\n\n **Validation Rule(s)** If present, it must be equal to the settlement BIC of the Preferred Agent sending the request\n(errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "month": { "description": "Numeric Year Month in YYYYMM format\n\n **Validation Rule(s)** It must be a valid date\n(errorCode SC01)\nThe year can be between the current and the last one\n(errorCode DT01)\nThe “Interest Calculation” status must be equal to “calculated” or “completed”\n(errorCode XA19)", "$ref": "#/components/schemas/YearMonth" } }, "required": [ "month" ] }, "SearchCriteria4": { "type": "object", "properties": { "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS\n\n **Validation Rule(s)** It must be equal to the settlement BIC of the Preferred Agent (errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "instgAgt": { "description": "The Instructing Agent BIC", "$ref": "#/components/schemas/BIC8" }, "instdAgt": { "description": "The Instructed Agent BIC", "$ref": "#/components/schemas/BIC8" }, "instgSttlmBIC": { "description": "The Settlement BIC configured for the Instructing Agent\n\n **Validation Rule(s)** If set together with the Instructed Settlement BIC, either the Instructing Agent Settlement BIC or the Instructed Agent Settlement BIC must be the CGS Settlement BIC of the Preferred Agent.", "$ref": "#/components/schemas/Bic11Only" }, "instdSttlmBIC": { "description": "The Settlement BIC configured for the Instructed Agent\n\n **Validation Rule(s)** If set together with the Instructing Settlement BIC, either the Instructing Agent Settlement BIC or the Instructed Agent Settlement BIC must be the CGS Settlement BIC of the Preferred Agent", "$ref": "#/components/schemas/Bic11Only" }, "settlementDateFrom": { "description": "The LCR settlement date.\nThe lowest value of date and time range for searching LCRs.\nIt corresponds to the date when the LCR closed its life-cycle\n\n **Validation Rule(s)** Maximum range allowed five target days (errorCode DT01)", "$ref": "#/components/schemas/Date" }, "settlementDateTo": { "description": "The LCR settlement date.\nThe highest value of date and time range for searching LCRs.\nIt corresponds to the date when the LCR closed its life-cycle.\n\n **Validation Rule(s)** Maximum range allowed five target days (errorCode DT01)", "$ref": "#/components/schemas/Date" }, "dateTimeFrom": { "description": "The lowest value of date and time range for searching LCRs.\nIt corresponds to the date and time when the LCR closed its life-cycle.\n\n **Validation Rule(s)** Maximum range allowed five target days (errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "dateTimeTo": { "description": "The highest value of date and time range for searching LCRs.\nIt corresponds to the date and time when the LCR closed its life-cycle.\n\n **Validation Rule(s)** Maximum range allowed five target days (errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "lcrReference": { "description": "The LCR Reference\n\n **Validation Rule(s)** It must be a valid value\n(errorCode SC01)", "$ref": "#/components/schemas/OperationReference" }, "lacNumber": { "description": "The LAC in which the lifecycle of the relevant LCR closed\n\n **Validation Rule(s)** It must be a valid LAC\n(errorCode SC01)", "$ref": "#/components/schemas/LacNumber" }, "lcrStatus": { "description": "The LCR status\n\n **Validation Rule(s)** It must be a valid code\n(errorCode SC01)", "$ref": "#/components/schemas/LcrStatus" }, "service": { "description": "The identifier of the STEP2 Service\n\n **Validation Rule(s)** It must be a valid code\n(errorCode SC01)", "$ref": "#/components/schemas/Service" } }, "required": [ "settlementDateFrom", "settlementDateTo" ] }, "SearchCriteria5": { "type": "object", "properties": { "settlementBIC": { "description": "The relevant Settlement BIC\n\n **Validation Rule(s)** It must correspond to one of the settlement BIC configured for the senderBIC, corresponding to the Preferred Agent (errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "settlementDate": { "description": "The relevant business date\n\n **Validation Rule(s)** It must be previous or equal to the current date (errorCode DT01)", "$ref": "#/components/schemas/Date" }, "lcrReference": { "description": "The LCR Reference\n\n **Validation Rule(s)** It must be a valid reference\n(errorCode SC01)", "$ref": "#/components/schemas/OperationReference" } }, "required": [ "lcrReference" ] }, "SearchCriteria6": { "type": "object", "properties": { "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS\n\n **Validation Rule(s)** It must correspond to one of the settlement BIC configured for the senderBIC, corresponding to the Preferred Agent (errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "businessDate": { "description": "The business date to which the LCR refers\n\n **Validation Rule(s)** It must be equal to the current date\n(errorCode DT01)", "$ref": "#/components/schemas/Date" }, "lcrReference": { "description": "The LCR reference\nAllowed values:\n• “ALL”; Or\n• LCR unique reference\n\n **Validation Rule(s)** The status of LCR that can be revoked must be “Queued”:\nIf filled with “ALL”, then all of queued LCRs must be revoked.\nIf filled with a valid LCR unique reference, then only this LCR must be revoked.\nIt will be available during Non-Target days only for LCRs whose counterparties (Instructing Agent and Instructed Agent) are configured for the new AOS (errorCode XA25)", "$ref": "#/components/schemas/OperationReference" } }, "required": [ "settlementBIC", "businessDate", "lcrReference" ] }, "SearchCriteria7": { "type": "object", "properties": { "preferredAgentBIC": { "description": "The Step2 Preferred Agent BIC linked to the Settlement BIC\n\n **Validation Rule(s)** If present it must be equal to the senderBIC\n(errorCode XA02)", "$ref": "#/components/schemas/BIC8" }, "fileType": { "description": "The file type\n\n **Validation Rule(s)** It must be a valid code\n(errorCode SC01)", "$ref": "#/components/schemas/FileType" }, "fileStatus": { "description": "The file status\n\n **Validation Rule(s)** It must be a valid code\n(errorCode SC01)", "$ref": "#/components/schemas/FileStatus" }, "dateTimeFrom": { "description": "The lowest value of file creation date and time range for searching.\n\n **Validation Rule(s)** It must be previous or equal to the current date (errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "dateTimeTo": { "description": "The highest value of file creation date and time range for searching\n\n **Validation Rule(s)** It must be greater than or equal to the DateFrom (errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "dateType": { "description": "The Type of Date. The possible values are:\n- Business Date\n- Calendar Date\n\n **Validation Rule(s)** Either “Business Date” or “Calendar Date” is mandatory.", "$ref": "#/components/schemas/DateType" }, "fileReference": { "description": "The Sender’s File Reference for the file created by the module.", "$ref": "#/components/schemas/FileReference" }, "lacNumber": { "description": "The LAC running when the file was created\n\n **Validation Rule(s)** It must be a valid LAC\n(errorCode SC01)", "$ref": "#/components/schemas/LacNumber" } }, "required": [ "fileType", "dateTimeFrom", "dateType" ] }, "SearchCriteria8": { "type": "object", "properties": { "businessDate": { "description": "The business date in which the file has been generated\n\n **Validation Rule(s)** It must be previous or equal to the current date (errorCode DT01)", "$ref": "#/components/schemas/Date" }, "fileType": { "description": "The file type\n\n **Validation Rule(s)** It must be a valid code\n(errorCode SC01)", "$ref": "#/components/schemas/FileType" }, "networkFileName": { "description": "The network file name\n\n **Validation Rule(s)** It must be a valid value\n(errorCode SC01)\nit must be generated for the senderBIC", "$ref": "#/components/schemas/NetworkFileName" } }, "required": [ "networkFileName" ] }, "SearchCriteria9": { "type": "object", "properties": { "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS\n\n **Validation Rule(s)** If present, it must be equal to the settlement BIC of the Preferred Agent sending the request\n(errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "dateTimeFrom": { "description": "The lowest value of date and time at which the alert was issued\n\n **Validation Rule(s)** It must be previous or equal to the current date\n(errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "dateTimeTo": { "description": "The highest value of date and time at which the alert was issued\n\n **Validation Rule(s)** It must be greater than or equal to the dateFrom\n(errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "eventDescription": { "description": "The description of the alert", "$ref": "#/components/schemas/EventDescription" } } }, "SenderBIC": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}", "examples": [ "BICAIT1X" ] }, "Service": { "description": "The identifier of the STEP2 Service", "type": "string", "enum": [ "B2B", "COR", "SCT" ], "examples": [ "SCT" ] }, "SetCalendarRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "settlementBIC": { "description": "The relevant Settlement BIC\n\n **Validation Rule(s)** It must correspond to one of the settlement BIC configured for the senderBIC, corresponding to the Preferred Agent (errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "businessDate": { "description": "The relevant business date\n\n **Validation Rule(s)** The date can be the current date (if it is a TARGET date) or a future target date no further than one year from the current one\n(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.", "type": "array", "items": { "$ref": "#/components/schemas/ExceptionLacValues" } } }, "required": [ "dateTime", "settlementBIC", "businessDate", "exceptionLacValues" ] }, "SetCalendarResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "effectiveDate": { "description": "The date from which the system applies the requested change", "$ref": "#/components/schemas/Date" } }, "required": [ "dateTime", "effectiveDate" ] }, "SetDefaultAgendaRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS\n\n **Validation Rule(s)** It must correspond to one of the settlement BIC configured for the senderBIC, corresponding to the Preferred Agent (errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "defaultDailyThresholds": { "description": " **Validation Rule(s)** It must be present 5 times: 1 occurrence/day.", "type": "array", "maxItems": 5, "items": { "$ref": "#/components/schemas/DefaultDailyThresholds" } } }, "required": [ "dateTime", "settlementBIC", "defaultDailyThresholds" ] }, "SetDefaultAgendaResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "effectiveDate": { "description": "First business date from which the system applies the requested values", "$ref": "#/components/schemas/Date" } }, "required": [ "dateTime", "effectiveDate" ] }, "SettlementBIC": { "type": "object", "properties": { "settlementBICCode": { "description": "The Settlement BIC adhering to CGS. This is the settlement BIC of the STEP2 DP Preferred Agent in the relevant Step2 service.\n\n **Validation Rule(s)** It must correspond to the Settlement BIC of the Preferred Agent sending the request\n(errorCode PY01)\nIt must be present in the system and it must not have ‘disabled’ status compared to the effectiveDate (errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "initialSettBICValidityDate": { "description": "The Initial Parameter Validity Date set in the original command to be amended.\n\n **Validation Rule(s)** It must be present in routing repositories for the settlementBIC (errorCode DT01).", "$ref": "#/components/schemas/Date" }, "endSettBICValidityDate": { "description": "The End Parameter Validity Date set in the original command to be amended.\n\n **Validation Rule(s)** It must be present in routing repositories for the settlementBIC (errorCode DT01).", "$ref": "#/components/schemas/Date" } }, "required": [ "settlementBICCode", "initialSettBICValidityDate", "endSettBICValidityDate" ] }, "SettlementBICAmend": { "type": "object", "properties": { "settlBICName": { "description": "The name of the Settlement BIC", "$ref": "#/components/schemas/ParticipantName" }, "automaticAdjustment": { "description": "This parameter indicates if the Settlement BIC opts out of the automatic liquidity adjustments performed by the module at the EOL. In this case, thresholds are configured only to trigger alerts\n\n **Validation Rule(s)** Possible values\ntrue= automatic adjustment required\nfalse= automatic adjustment not required\n(errorCode SC01)", "$ref": "#/components/schemas/Boolean" }, "eodFulDefund": { "description": "This parameter indicates if the Settlement BIC opts for the CGS to perform an automatic full defunding of the Settlement BIC position on the last LAC of the business day in order to avoid remuneration of outstanding liquidity\n\n **Validation Rule(s)** Possible values\ntrue= EOD Full Defunding required\n false= EOD Full Defunding not required\n(errorCode SC01)", "$ref": "#/components/schemas/Boolean" }, "lmrFileRequired": { "description": "This parameter indicates whether the Settlement BIC must be configured to receive the LMR output file\n\n **Validation Rule(s)** Possible values\ntrue= LMR required\n false= LMR not required\n(errorCode SC01)", "$ref": "#/components/schemas/Boolean" }, "lnrFileRequired": { "description": "This parameter indicates whether the Settlement BIC must be configured to receive the LNR output file\n\n **Validation Rule(s)** Possible values\ntrue= LNR required\n false= LNR not required\n(errorCode SC01)", "$ref": "#/components/schemas/Boolean" }, "dlrFileRequired": { "description": "This parameter indicates whether the Settlement BIC must be configured to receive daily liquidity reconciliation report\n\n **Validation Rule(s)** Possible values\ntrue= daily liquidity reconciliation report required\nfalse= daily liquidity reconciliation report not required\n(errorCode SC01)", "$ref": "#/components/schemas/Boolean" }, "maxRcvgFileSize": { "description": "The maximum size of an output file generated and sent by the CGS to the Settlement BIC\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/Number" } }, "required": [ "settlBICName", "automaticAdjustment", "eodFulDefund", "lmrFileRequired", "lnrFileRequired", "dlrFileRequired", "maxRcvgFileSize" ] }, "SettlementBICDetails": { "type": "object", "properties": { "settlementBIC": { "description": "The STEP2 Settlement BIC owning a liquidity position in CGS", "$ref": "#/components/schemas/Bic11Only" }, "status": { "description": "The Settlement BIC status", "$ref": "#/components/schemas/ParticipantStatus" }, "initialValidityDate": { "description": "The first business date starting from which the Settlement BIC is active (ENABLED) for the module, meaning that the Settlement BIC is allowed to settle LCRs and to receive output files. If InitialValidityDate is not yet live, then the status is INSERTED.", "$ref": "#/components/schemas/Date" }, "endValidityDate": { "description": "The last business date at which the Settlement BIC is active (ENABLED). At EndValidityDate+1 the status of the Settlement BIC is DISABLED, meaning that it is not allowed to settle any LCRs in CGS module", "$ref": "#/components/schemas/Date" }, "preferredAgentBIC": { "description": "The STEP2 DP BIC allowed to manage the Participant’s liquidity", "$ref": "#/components/schemas/BIC8" }, "preferredS2Service": { "description": "The STEP2 Service configured for the Preferred Agent BIC. Allowed values:\n- SCT\n- COR\n- B2B", "$ref": "#/components/schemas/Service" }, "parModhistory": { "description": "This section is available only if the Preferred Agent inquires details for its own Settlement BIC", "type": "array", "items": { "$ref": "#/components/schemas/ParModhistory" } } }, "required": [ "settlementBIC", "status", "initialValidityDate", "endValidityDate", "preferredAgentBIC", "preferredS2Service" ] }, "SettlementBICDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "settlementBIC": { "description": "The STEP2 Settlement BIC owning liquidity position in CGS\n\n **Validation Rule(s)** It must correspond to one of the settlement BIC configured for the senderBIC, corresponding to the Preferred Agent\n(errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" } }, "required": [ "dateTime", "settlementBIC" ] }, "SettlementBICDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "settlementBICDetails": { "$ref": "#/components/schemas/SettlementBICDetails" } }, "required": [ "dateTime", "settlementBICDetails" ] }, "SettlementBICParameters": { "type": "object", "properties": { "settlBICName": { "description": "The name of the Settlement BIC", "$ref": "#/components/schemas/ParticipantName" }, "automaticAdjustment": { "description": "This parameter indicates if the Settlement BIC opts out of the automatic liquidity adjustments performed by the module at the EOL. In this case, thresholds are configured only to trigger alerts\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/Boolean" }, "eodFulDefund": { "description": "This parameter indicates if the Settlement BIC opts for the CGS to perform an automatic full defunding of the Settlement BIC position on the last LAC of the business day in order to avoid remuneration of outstanding liquidity\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/Boolean" }, "lmrFileRequired": { "description": "This parameter indicates whether the Settlement BIC must be configured to receive the LMR output file\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/Boolean" }, "lnrFileRequired": { "description": "This parameter indicates whether the Settlement BIC must be configured to receive the LNR output file\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/Boolean" }, "dlrFileRequired": { "description": "Whether the Settlement BIC is configured to receive daily liquidity reconciliation report\n\n **Validation Rule(s)** It must be set as either:\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/Boolean" }, "maxRcvgFileSize": { "description": "The maximum size of an output file generated and sent by the CGS to this Settlement BIC\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/StandardInteger" } } }, "SettlementBICs": { "type": "object", "properties": { "name": { "description": "The name of the settlement BIC", "$ref": "#/components/schemas/ParticipantName" }, "preferredAgentBIC": { "description": "The BIC of the relevant Step2 Preferred Agent BIC", "$ref": "#/components/schemas/BIC8" }, "settlementBIC": { "description": "The STEP2 Settlement BIC owning a liquidity position in CGS", "$ref": "#/components/schemas/Bic11Only" }, "preferredS2Service": { "description": "The STEP2 Service configured for the Preferred Agent BIC.\nAllowed values:\n- SCT\n- COR\n- B2B", "$ref": "#/components/schemas/Service" }, "initialValidityDate": { "description": "The first business date starting from which the Settlement BIC is active (ENABLED) for the module, meaning that the Settlement BIC is allowed to settle LCRs and to receive output files.\nIf InitialValidityDate is not yet live, then the status is INSERTED.", "$ref": "#/components/schemas/Date" }, "endValidityDate": { "description": "The last business date at which the Settlement BIC is active (ENABLED).\nAt EndValidityDate+1 the status of the Settlement BIC is DISABLED, meaning that it is not allowed to settle any LCRs in CGS module.", "$ref": "#/components/schemas/Date" }, "status": { "description": "The status of the Settlement BIC", "$ref": "#/components/schemas/ParticipantStatus" } }, "required": [ "preferredAgentBIC", "settlementBIC", "preferredS2Service", "name", "initialValidityDate", "endValidityDate", "status" ] }, "Sign": { "type": "string", "enum": [ "C", "D" ], "examples": [ "C" ] }, "StandardInteger": { "description": "Standard integer", "type": "integer", "format": "int32", "examples": [ 1000 ] }, "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" ] }, "TransferType": { "type": "string", "enum": [ "F", "D" ], "examples": [ "F" ] }, "UpdateSettlementBICRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "settlementBICCode": { "description": "The Settlement BIC adhering to CGS. This is the settlement BIC of the STEP2 DP Preferred Agent sending the request\n\n **Validation Rule(s)** It must correspond to the Settlement BIC of the Preferred Agent sending the request\n(errorCode PY01)\nIt must be present in the system and it must not have ‘disabled’ status compared to the effectiveDate (errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "effectiveDate": { "description": "The effective date of the change\n\n **Validation Rule(s)** For critical parameters, the first available effective date must be set as follows:\n- the effective date must be equal to one of the effective date stored within \"Change Dates Calendar\" functionality\n- the business date when the operation is confirmed, must precede or must be equal to \"Submission Date\" relevant to the chosen “Effective Date”\nFor Non-Critical parameters, the first available effective date corresponds to the first available TARGET day according to warehousing constraints set for the parameter, if any\n(errorCode DT01)\nAnother configuration with the same effective date is already existing\n(errorCode XA22)", "$ref": "#/components/schemas/Date" }, "settlementBICParameters": { "$ref": "#/components/schemas/SettlementBICParameters" } }, "required": [ "dateTime", "settlementBICCode", "effectiveDate", "settlementBICParameters" ] }, "UpdateSettlementBICResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "commandRef": { "description": "The reference of the operation, logged in the system in TBA status", "$ref": "#/components/schemas/CommandReference" } }, "required": [ "dateTime", "commandRef" ] }, "User": { "type": "string", "maxLength": 8, "examples": [ "APIUSER1" ] }, "YearMonth": { "description": "Numeric Year Month in YYYYMM format", "type": "number", "minimum": 201001, "maximum": 299912, "examples": [ 202411 ] }, "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" } } } } } }