{ "openapi": "3.1.0", "info": { "version": "1.4", "title": "EBACL STEP2-DKK DCT REST API - DPWS", "description": "DPWS RESTful API for interacting with STEP2-DKK DCT service", "contact": { "name": "EBA CLEARING", "url": "https://www.ebaclearing.eu" }, "x-info-creation-date": "2026-07-17", "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-dct/v1", "description": "Live Environment" }, { "url": "https://api-test.swiftnet.sipn.swift.com/ebacl-step2-dct/v1", "description": "Test Environment" }, { "url": "https://api.common.swiftnet.sipn.swift.com/ebacl-step2-dct/v1", "description": "Extended availability Live environment" }, { "url": "https://api-pilot.common.swiftnet.sipn.swift.com/ebacl-step2-dct/v1", "description": "Extended availability Test environment" } ], "tags": [ { "name": "Commands", "description": "Commands" }, { "name": "LCR", "description": "LCR" }, { "name": "Liquidity Position", "description": "Liquidity Position" }, { "name": "Message Inquiry", "description": "Message Inquiry" }, { "name": "Participant Management", "description": "Participant Management" }, { "name": "Transaction Inquiry", "description": "Transaction Inquiry" } ], "security": [ { "oauthBearerToken": [] } ], "paths": { "/listParticipants/{senderBIC}": { "post": { "tags": [ "Participant Management" ], "operationId": "listParticipants", "summary": "It allows the Participant to inquire the Direct Participants list.", "description": "The listParticipants request allows participants to retrieve the Direct Participants list.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListParticipantsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "BICCode": "TESTIT88", "name": "Merrill Lynch", "initParticipantValidity": "2019-06-21", "endParticipantValidity": "2024-11-08", "status": "ENB", "AOSParam": "AO1", "nightTimeSettlement": false, "network": "SWF" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListParticipantsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "participants": [ { "BICCode": "TESTIT88", "name": "Merrill Lynch", "initValidity": "2019-06-21", "endValidity": "2024-11-08", "status": "ENB", "settlementBIC": "IPSDID21XXX", "newBIC": "BICDPA23", "newRole": true }, { "BICCode": "BICDPA23", "name": "ExampleBank01", "initValidity": "2024-11-08", "endValidity": "9999-12-31", "status": "DIS", "settlementBIC": "TESBIC11XXX", "newBIC": "DPBICA88", "newRole": 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" } } } }, "/participantDetails/{senderBIC}": { "post": { "tags": [ "Participant Management" ], "operationId": "participantDetails", "summary": "It allows the Participant to inquire the details of a Direct Participants.", "description": "The participantDetails request allows participants to retrieve details of their Direct Participant.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParticipantDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "participantRef": { "BICCode": "TESTIT88" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParticipantDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "participant": { "BICCode": "TESTIT88", "name": "Merrill Lynch", "initParticipantValidity": "2019-06-21", "endParticipantValidity": "2024-11-08", "currentStatus": "ENB", "settlementBIC": "IPSDID21XXX", "parModHistory": [ { "initParameterValidity": "2019-06-21", "endParameterValidity": "2024-11-08", "BICName": "Merrill Lynch", "settlementBIC": "IPSDID21XXX", "settlementFiles": 1, "technicalBIC": false }, { "initParameterValidity": "2024-11-08", "endParameterValidity": "9999-12-31", "BICName": "ExampleBank01", "settlementBIC": "TESBIC11XXX", "settlementFiles": 10, "separateReturnFile": false } ], "detailsHistory": [ { "BICCode": "TESTIT88", "newDPBICCode": "BICDPA23", "name": "Merrill Lynch", "initParticipantValidity": "2019-06-21", "endParticipantValidity": "2024-11-08", "status": "ENB", "initParameterValidity": "9999-12-31", "endParameterValidity": "2019-06-21", "DPSettlementBIC": "IPSDID21XXX", "routingInfoChanged": false, "settlementFiles": 1, "extendedPSR": false, "remittanceInformationERI": false, "allowedPCF": false, "maxReceivingFileSize": 1000, "defaultThresholdValue": 10000.01, "swiftNetOutputFileCompression": false, "technicalBIC": false, "activeOutputNetwork": "PRI", "priNetworkIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secNetworkIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "priReceivingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secReceivingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "priSendingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secSendingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "T2RTGSAuthorisedAccountUserAAUForAS-D": "TESBIC11XXX", "T2RTGSAuthorisedAccountUserAAUForAS-E": "TESBIC99XXX", "T2RTGSDedicatedCashAccountDCAForAS-D": "11123422244678888888887677800000005", "T2RTGSDedicatedCashAccountDCAForAS-E": "11123433344671111188887677800000023" }, { "BICCode": "BICDPA23", "newDPBICCode": "DPBICA88", "name": "ExampleBank01", "newRole": false, "initParticipantValidity": "2024-11-08", "endParticipantValidity": "9999-12-31", "status": "DIS", "initParameterValidity": "2019-06-21", "endParameterValidity": "2024-11-08", "DPSettlementBIC": "TESBIC11XXX", "settlementFiles": 10, "RSFRequired": false, "acceptanceDateAO1": false, "nonTargetDaySettlement": false, "separateReturnsFile": false, "maxReceivingFileSize": 10000, "defaultThresholdValue": 1234567.99, "nightTimeSettlement": false, "activeOutputNetwork": "SEC", "priNetworkIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secNetworkIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "priReceivingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secReceivingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "priSendingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secSendingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "T2RTGSAuthorisedAccountUserAAUForAS-D": "TESBIC99XXX", "T2RTGSAuthorisedAccountUserAAUForAS-E": "IPSDID21XXX", "T2RTGSDedicatedCashAccountDCAForAS-D": "11123433344671111188887677800000023", "T2RTGSDedicatedCashAccountDCAForAS-E": "19923422244678888882227677800000333", "txThresholdForOutput": 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" } } } }, "/listReachableBICs/{senderBIC}": { "post": { "tags": [ "Participant Management" ], "operationId": "listReachableBICs", "summary": "It allows the Participant to inquire the Reachable BICs list.", "description": "The listReachableBICs request allows participants to retrieve the list of Reachable BICs in the routing table.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListReachableBICsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "BICCode": "IPSDID21XXX", "name": "Merrill Lynch", "initParticipantValidity": "2019-06-21", "endParticipantValidity": "2024-11-08", "status": "ENB", "DPBICCode": "TESTIT88", "AOS": "AO1" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListReachableBICsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "indParticipants": [ { "BICCode": "IPSDID21XXX", "name": "Merrill Lynch", "initValidity": "2019-06-21", "endValidity": "2024-11-08", "status": "ENB", "newBIC": "TESBIC11XXX", "newRole": true, "DPBICCode": "TESTIT88", "DPSettlementBIC": "TESBIC99XXX", "DPName": "ExampleBank01" }, { "BICCode": "TESBIC11XXX", "name": "ExampleBank01", "initValidity": "2024-11-08", "endValidity": "9999-12-31", "status": "DIS", "newBIC": "TESBIC99XXX", "newRole": false, "DPBICCode": "BICDPA23", "DPSettlementBIC": "IPSDID21XXX", "DPName": "ExampleBank02" } ] } } } } }, "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" } } } }, "/RBDetails/{senderBIC}": { "post": { "tags": [ "Participant Management" ], "operationId": "RBDetails", "summary": "It allows the Participant to inquire the details of a Reachable BIC.", "description": "The RBDetails request allows a participant to retrieve details of its Reachable BIC in the routing table.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RBDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "indParticipantRef": { "BICCode": "IPSDID21XXX" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RBDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "indParticipant": { "BICCode": "IPSDID21XXX", "name": "Merrill Lynch", "initParticipantValidity": "2019-06-21", "endParticipantValidity": "2024-11-08", "DPBICCode": "TESTIT88", "DPName": "ExampleBank01", "DPInitParticipantValidity": "9999-12-31", "DPEndParticipantValidity": "2019-06-21", "currentStatus": "ENB", "parModHistory": [ { "initParameterValidity": "2019-06-21", "endParameterValidity": "2024-11-08", "BICName": "Merrill Lynch", "DPBICCode": "TESTIT88", "status": "ENB" }, { "initParameterValidity": "2024-11-08", "endParameterValidity": "9999-12-31", "BICName": "ExampleBank01", "DPBICCode": "BICDPA23", "status": "DIS" } ], "detailsHistory": [ { "BICCode": "IPSDID21XXX", "newBICCode": "TESBIC11XXX", "name": "Merrill Lynch", "initParticipantValidity": "2019-06-21", "endParticipantValidity": "2024-11-08", "status": "ENB", "initParameterValidity": "9999-12-31", "endParameterValidity": "2019-06-21", "routingInfoChanged": false, "DPBICCode": "TESTIT88", "remittanceInformationERI": false }, { "BICCode": "TESBIC11XXX", "newBICCode": "TESBIC99XXX", "name": "ExampleBank01", "newRole": false, "initParticipantValidity": "2024-11-08", "endParticipantValidity": "9999-12-31", "status": "DIS", "initParameterValidity": "2019-06-21", "endParameterValidity": "2024-11-08", "DPBICCode": "BICDPA23", "acceptanceDateAO1": false, "sameBankingGroupAsDP": 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" } } } }, "/changeStatusReachableBIC/{senderBIC}": { "put": { "tags": [ "Participant Management" ], "operationId": "changeStatusReachableBIC", "summary": "It allows the Participant to remove its Reachable BICs.", "description": "The changeStatusReachableBIC request allows the participant to change the status of its RBs to DIS.\nThis function is managed under BCWS dual control and it generates a “Remove RB” operation logged as “TO BE 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” (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeStatusReachableBICRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "changeStatusRB": { "RBBICCode": "IPSDID21XXX", "newStatus": "ENB", "effectiveDate": "2019-06-21" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeStatusReachableBICResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "operationRef": "REF0123456789111" } } } } }, "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" } } } }, "/insertReachableBIC/{senderBIC}": { "put": { "tags": [ "Participant Management" ], "operationId": "insertReachableBIC", "summary": "It allows the Participant to insert a new Reachable BIC linked to its same BIC.", "description": "The insertReachableBIC request allows the participant to insert a new RB in DCT Routing Table.\nThis function is managed under BCWS dual control and it generates an “Insert RB” operation logged as “TO BE 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” (errorCode PY01)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertReachableBICRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "RBBICCode": "IPSDID21XXX", "initParticipantValidity": "2019-06-21", "endParticipantValidity": "2024-11-08", "parameters": { "name": "Merrill Lynch", "acceptanceDateAO1": true, "remittanceInformationERI": false, "sameBankingGroupAsDP": true } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertReachableBICResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "operationRef": "REF0123456789111" } } } } }, "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" } } } }, "/updateDirectParticipant/{senderBIC}": { "put": { "tags": [ "Participant Management" ], "operationId": "updateDirectParticipant", "summary": "It allows the Participant to update its BIC.", "description": "The updateDirectParticipant request allows the participant to update its own DP in DCT Routing Table.\nThis function is managed under BCWS dual control and it generates an “Update DP” 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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDirectParticipantRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "effectiveDate": "2019-06-21", "parameters": { "name": "Merrill Lynch", "settlementFiles": 1, "technicalBIC": false, "extendedPSR": false, "remittanceInformationERI": false, "nonTargetDaySettlement": false, "maxReceivingFileSize": 1000, "defaultThresholdValue": 10000.01, "nightTimeSettlement": false, "priNetworkIdentification": "SWF", "secNetworkIdentification": "FXS", "priReceivingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secReceivingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "priSendingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secSendingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "T2RTGSAuthorisedAccountUserAAUForAS-D": "IPSDID21XXX", "T2RTGSAuthorisedAccountUserAAUForAS-E": "TESBIC11XXX", "T2RTGSDedicatedCashAccountDCAForAS-D": "11123422244678888888887677800000005", "T2RTGSDedicatedCashAccountDCAForAS-E": "11123433344671111188887677800000023", "txThresholdForOutput": 10000 } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDirectParticipantResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "operationRef": "REF0123456789111" } } } } }, "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" } } } }, "/updateReachableBIC/{senderBIC}": { "put": { "tags": [ "Participant Management" ], "operationId": "updateReachableBIC", "summary": "It allows the Participant to update a Reachable BIC linked to its same BIC.", "description": "The updateReachableBIC request allows the participant to update its RBs in DCT Routing Table.\nThis function is managed under BCWS dual control and it generates an \"Update RB” 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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReachableBICRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "RBBICCode": "IPSDID21XXX", "effectiveDate": "2019-06-21", "parameters": { "name": "Merrill Lynch", "remittanceInformationERI": false } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReachableBICResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "operationRef": "REF0123456789111" } } } } }, "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": [ "Participant Management" ], "operationId": "rejectParticipantOperation", "summary": "It allows the Participant to reject one of its provisioning operation previously inserted via API.", "description": "The rejectParticipantOperation request allows the participant 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” (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", "operationRef": "REF0123456789111" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectParticipantOperationResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "operationRef": "REF0123456789111" } } } } }, "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" } } } }, "/listOperations/{senderBIC}": { "post": { "tags": [ "Participant Management" ], "operationId": "listOperations", "summary": "It allows the Participant to enquire the list of its operations.", "description": "The listOperations request allows the participant to retrieve its routing table operations, based on a 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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOperationsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "DPRBOperation": "DIR", "DPBICCode": "TESTIT88", "RBBICCode": "IPSDID21XXX", "operationType": "INS", "operationRef": "REF0123456789111", "effectiveDate": "2019-06-21", "operationStatus": "AUT", "requestDate": "2024-11-08", "confirmDate": "9999-12-31", "authRejectDate": "2019-06-21", "userIssuer": "APIUSER1", "confirmer": "APIUSER2", "userAuthReject": "APIUSER3" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOperationsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "operations": [ { "DPRBOperation": "DIR", "DPBICCode": "TESTIT88", "RBBICCode": "IPSDID21XXX", "operationType": "INS", "operationStatus": "AUT", "effectiveDate": "2019-06-21", "requestDateTime": "2019-06-21T23:20:50.000001", "confirmDateTime": "2024-11-08T14:29:00.012345", "authRejectDateTime": "9999-12-31T12:55:45.000001", "userIssuer": "APIUSER1", "confirmer": "APIUSER2", "userAuthReject": "APIUSER3", "operationRef": "REF0123456789111", "critical": true }, { "DPRBOperation": "IND", "DPBICCode": "BICDPA23", "RBBICCode": "TESBIC11XXX", "operationType": "REM", "operationStatus": "TBA", "effectiveDate": "2024-11-08", "requestDateTime": "2024-11-08T14:29:00.012345", "confirmDateTime": "9999-12-31T12:55:45.000001", "authRejectDateTime": "2019-06-21T23:20:50.000001", "userIssuer": "APIUSER2", "confirmer": "APIUSER3", "userAuthReject": "APIUSER1", "operationRef": "REF0123456789000", "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": [ "Participant Management" ], "operationId": "operationsDetails", "summary": "It allows the Participant to retrieve the details of a specific operation.", "description": "The operationDetails request allows the participant to retrieve details of specific routing table operations 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)", "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", "operationRef": "REF0123456789111" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "operationDetails": { "DPRBOperation": "DIR", "operationType": "INS", "operationStatus": "AUT", "operationRef": "REF0123456789111", "effectiveDate": "2019-06-21", "requestDateTime": "2019-06-21T23:20:50.000001", "confirmDateTime": "2024-11-08T14:29:00.012345", "authRejectDateTime": "9999-12-31T12:55:45.000001", "userIssuer": "APIUSER1", "confirmer": "APIUSER2", "userAuthReject": "APIUSER3", "critical": true, "directParticipant": { "DPBICCode": "TESTIT88", "name": "Merrill Lynch", "settlementFiles": 1, "technicalBIC": false, "txThresholdForOutput": 1000, "extendedPSR": false, "remittanceInformationERI": false, "allowedPCF": false, "maxReceivingFileSize": 10000, "defaultThresholdValue": 10000.01, "priNetworkIdentification": "SWF", "secNetworkIdentification": "FXS", "priReceivingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "secReceivingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "priSendingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "SecSendingNetIdentification": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift", "T2RTGSAuthorisedAccountUserAAUForAS-D": "IPSDID21XXX", "T2RTGSAuthorisedAccountUserAAUForAS-E": "TESBIC11XXX", "T2RTGSDedicatedCashAccountDCAForAS-D": "11123422244678888888887677800000005", "T2RTGSDedicatedCashAccountDCAForAS-E": "11123433344671111188887677800000023" }, "reachableBIC": { "name": "Merrill Lynch", "RBBICCode": "IPSDID21XXX", "oldDPBICCode": "TESTIT88", "newDPBICCode": "BICDPA23", "remittanceInformationERI": false }, "insertBRT": { "counterpartBIC": "TESTIT88" }, "removeBRT": { "counterpartBIC": "TESTIT88" } } } } } } }, "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" } } } }, "/listDefaultThresholds/{senderBIC}": { "post": { "tags": [ "Liquidity Position" ], "operationId": "listDefaultThresholds", "summary": "It allows the Participant to inquire the Default Thresholds list.", "description": "The listDefaultThresholds request allows participants to retrieve the list of their Default Thresholds.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDefaultThresholdsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "creditPartyBIC": "TESTIT88" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDefaultThresholdsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "endOfList": true, "defaultThresholds": [ { "debitPartyBIC": "TESTIT88", "creditPartyBIC": "BICDPA23", "thresholdAmount": 10000.01, "lastUserUpdate": "2019-06-21T23:20:50.000001" }, { "debitPartyBIC": "BICDPA23", "creditPartyBIC": "DPBICA88", "thresholdAmount": 1234567.99, "lastUserUpdate": "2024-11-08T14:29:00.012345" } ], "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" } } } }, "/updateDefaultThreshold/{senderBIC}": { "put": { "tags": [ "Liquidity Position" ], "operationId": "updateDefaultThreshold", "summary": "It allows the Participant to update a specific Default Threshold.", "description": "The updateDefaultThresholds request allows participants to update a specific Default Threshold.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDefaultThresholdRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "defaultThreshold": { "creditPartyBIC": "TESTIT88", "thresholdAmount": 10000.01 } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDefaultThresholdResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/debitPositionCGS/{senderBIC}": { "post": { "tags": [ "Liquidity Position" ], "operationId": "debitPositionCGS", "summary": "It allows the Participant to inquire its debit position against a specific Counterpary BIC configured for settling in CGS. ", "description": "The debitPositionCGS request allows participants to retrieve details on their debit position to be settled in CGS against the System or a specific Counterparty BIC configured for CGS.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.\nNOTE: LCRs in CANCELLED, REVOKED and REJECTED status are not counted for neither sender nor for receiver counterpart.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DebitPositionCGSRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "interbankSettlementDate": "2019-06-21", "lac": "01", "counterpartyBIC": "TESTIT88" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DebitPositionCGSResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "header": { "interbankSettlementDate": "2019-06-21", "lac": "01", "DPBICCode": "TESTIT88", "totalPosition": 10000.01 }, "debtorPosition": [ { "counterpartyBIC": "TESTIT88", "sumAmountCredTranSent": 10000.01, "sumAmountReturnSent": 1234567.99, "totalDebitPosition": 9999999.12, "tresholdAmount": 10000.01, "sumAmountCredTranReceived": 1234567.99, "sumAmountReturnReceived": 9999999.12, "totalCreditPosition": 10000.01, "totalPosition": 1234567.99 }, { "counterpartyBIC": "BICDPA23", "sumAmountCredTranSent": 1234567.99, "sumAmountReturnSent": 9999999.12, "totalDebitPosition": 10000.01, "tresholdAmount": 1234567.99, "sumAmountCredTranReceived": 9999999.12, "sumAmountReturnReceived": 10000.01, "totalCreditPosition": 1234567.99, "totalPosition": 9999999.12 } ], "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" } } } }, "/listTransactions/{senderBIC}": { "post": { "tags": [ "Transaction Inquiry" ], "operationId": "listTransactions", "summary": "It allows to inquire the Transactions sent or received by the Participant.", "description": "The listTransactions request allows a participant to retrieve the list of transactions for which its BIC is sender or receiver.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "type": "SNT", "DPInstructingBIC": "TESTIT88", "DPInstructedBIC": "BICDPA23", "transactionType": "Pacs.008", "transactionStatus": "STG", "transactionId": "TESTTRANSEF135000000000000000000123", "processingDate": "2019-06-21", "interbankSettlDate": "2024-11-08", "lac": "01", "creditorBankBIC": "TESBIC22XXX", "debtorBankBIC": "TESBIC33XXX", "ICFReference": "TESTFILEREF01234", "IQFReference": "DCTTFILEREF01234", "bulkReference": "TESTBULKREF135000000000000000000123", "CVFReference": "TESTFILEREF09999", "QVFReference": "TESTFILEREF01234", "SCFReference": "DCTTFILEREF01234", "OQFReference": "TESTFILEREF09999", "RSFReference": "TESTFILEREF01234", "LCRReference": "LCRREF1111111111", "routingType": "DIR", "amountRangeFrom": 10000.01, "amountRangeTo": 1234567.99, "originalTransactionId": "TESTDCT1234F135000000000000000000123", "originalSettlementDate": "9999-12-31", "originalAmount": 9999999.12, "creditPartyBIC": "DPBICA88", "debitPartyBIC": "TESTIT88" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactionsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "endOfList": true, "transactions": [ { "transactionType": "Pacs.008", "processingDate": "2019-06-21", "lac": "01", "transactionId": "TESTTRANSEF135000000000000000000123", "DPInstructingBIC": "TESTIT88", "DPInstructedBIC": "BICDPA23", "transactionStatus": "STG", "interbankSettlementAmount": 10000.01, "interbankSettlementDate": "2024-11-08", "originalSettlementDate": "9999-12-31", "type": "SNT", "debtorBankBIC": "TESBIC22XXX", "creditorBankBIC": "TESBIC33XXX" }, { "transactionType": "Camt.027", "processingDate": "2024-11-08", "lac": "02", "transactionId": "TESTDCT1234F135000000000000000000123", "DPInstructingBIC": "BICDPA23", "DPInstructedBIC": "DPBICA88", "transactionStatus": "VAL", "interbankSettlementAmount": 1234567.99, "interbankSettlementDate": "9999-12-31", "originalSettlementDate": "2019-06-21", "type": "RCV", "debtorBankBIC": "TESBIC33XXX", "creditorBankBIC": "TESBIC99XXX" } ], "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/transactionDetails/{senderBIC}": { "post": { "tags": [ "Transaction Inquiry" ], "operationId": "transactions", "summary": "It allows to get the details of a specific transaction sent or received by the Participant.", "description": "The transactionDetails request allows participants to get the details of a specific transaction for which they are sender or receiver.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "transactionRef": { "transactionType": "Pacs.008", "interbankSettlementDate": "2019-06-21", "transactionId": "TESTTRANSEF135000000000000000000123", "type": "SNT", "transactionStatus": "STG", "debtorBankBIC": "TESBIC22XXX", "creditorBankBIC": "TESBIC33XXX", "lac": "01" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "transaction": { "transactionType": "Pacs.008", "lac": "01", "processingDate": "2019-06-21", "interbankSettlementDate": "2024-11-08", "orderingDate": "9999-12-31", "routingType": "DIR", "DPInstructingBIC": "TESTIT88", "DPInstructedBIC": "BICDPA23", "debtorBankBIC": "TESBIC22XXX", "creditorBankBIC": "TESBIC33XXX", "orderingCustomer": "Airport parking", "beneficiaryCustomer": "Test bank", "orderingAccountNumber": "IT60X0542811101000000123456", "beneficiaryAccountNumber": "IT60X0542894401000000123454", "debitPartyBIC": "TESBIC99XXX", "creditPartyBIC": "TESBIC22XXX", "ICFReference": "TESTFILEREF01234", "bulkReference": "TESTBULKREF135000000000000000000123", "IQFReference": "DCTTFILEREF01234", "CVFReference": "TESTFILEREF09999", "QVFReference": "TESTFILEREF01234", "SCFReference": "DCTTFILEREF01234", "OQFReference": "TESTFILEREF09999", "RSFReference": "TESTFILEREF01234", "transactionId": "TESTTRANSEF135000000000000000000123", "transactionStatus": "STG", "amountValue": 10000.01, "LCRReference": "LCRREF1111111111", "settlementReference": "TESTBULKREF135000000000000000999999", "originalAmount": 1234567.99, "reasonCode": "CNOR", "originalTransactionId": "TESTDCT1234F135000000000000000000123", "originalSettlementDate": "2019-06-21", "endToEndId": "20180501183030100000774727992319111" } } } } } }, "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" } } } }, "/listBulks/{senderBIC}": { "post": { "tags": [ "Transaction Inquiry" ], "operationId": "listBulks", "summary": "It allows to inquire the bulks contained in a file sent or received by the Participant.", "description": "The listBulks request allows participants to retrieve the list of bulks contained in files for which they are sender or receiver.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBulksRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "fileType": "ICF", "messageType": "Pacs.008", "fileReference": "TESTFILEREF01234", "bulkStatus": "ACCP", "bulkReference": "TESTBULKREF135000000000000000000123", "date": "2019-06-21", "dateType": "Business Date", "lac": "01" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBulksResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "endOfList": true, "bulks": [ { "messageType": "Pacs.008", "senderReceiverBIC": "TESTIT88", "fileReference": "TESTFILEREF01234", "bulkReference": "TESTBULKREF135000000000000000000123", "date": "2019-06-21", "dateTime": "2019-06-21T23:20:50.000001", "lac": "01", "bulkStatus": "ACCP", "reasonCode": "A01", "fileType": "ICF" }, { "messageType": "Camt.027", "senderReceiverBIC": "BICDPA23", "fileReference": "DCTTFILEREF01234", "bulkReference": "TESTBULKREF135000000000000000999999", "date": "2024-11-08", "dateTime": "2024-11-08T14:29:00.012345", "lac": "02", "bulkStatus": "PART", "reasonCode": "R01", "fileType": "CVF" } ], "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" } } } }, "/bulkDetails/{senderBIC}": { "post": { "tags": [ "Transaction Inquiry" ], "operationId": "bulks", "summary": "It allows to get the details of a specific bulk contained in a file sent or received by the Participant.", "description": "The bulkDetails request allows participants to get the details of a specific bulk contained in files for which they are sender or receiver.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "bulkRef": { "fileType": "ICF", "messageType": "Pacs.008", "fileReference": "TESTFILEREF01234", "bulkReference": "TESTBULKREF135000000000000000000123", "dateTime": "2019-06-21T23:20:50.000001" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "bulk": { "bulkType": "Pacs.008", "bulkReference": "TESTBULKREF135000000000000000000123", "fileReference": "TESTFILEREF01234", "fileType": "ICF", "ICFFileReference": "DCTTFILEREF01234", "IQFFileReference": "TESTFILEREF09999", "CVFFileReference": "TESTFILEREF01234", "CVFBulkReference": "TESTBULKREF135000000000000000999999", "QVFFileReference": "DCTTFILEREF01234", "QVFBulkReference": "TESTBULKREF135123400000000000000567", "SCFBulkReference": "TESTBULKREF135000000000000000000123", "OQFBulkReference": "TESTBULKREF135000000000000000999999", "RSFBulkReference": "TESTBULKREF135123400000000000000567", "numOfTransaction": 1000, "valueOfTransaction": 10000.01, "numOfRejectedTransaction": 10000, "valueOfRejectedTransaction": 1234567.99, "bulkRejectionCode": "A01", "senderReceiverDPBICCode": "TESTIT88", "CPUCreationDateTime": "2019-06-21T23:20:50.000001", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "settlementDate": "9999-12-31" } } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/listFiles/{senderBIC}": { "post": { "tags": [ "Transaction Inquiry" ], "operationId": "listFiles", "summary": "It allows to enquire the list of the files sent or received by the Participant.", "description": "The listFiles request allows participants to retrieve the list of files for which they are sender or receiver.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "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": { "fileType": "ICF", "dateTimeFrom": "2019-06-21T23:20:50.000001", "dateTimeTo": "2024-11-08T14:29:00.012345", "dateType": "Business Date", "fileReference": "TESTFILEREF01234", "lac": "01", "originalFileRef": "DCTTFILEREF01234", "fileStatus": "RCV", "reasonCode": "A01" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFilesResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "endOfList": true, "files": [ { "fileType": "ICF", "fileReference": "TESTFILEREF01234", "lac": "01", "timeIndicator": "16:00", "dateTime": "2019-06-21T23:20:50.000001", "date": "2019-06-21", "fileStatus": "RCV", "reasonCode": "A01", "lastStatusUpdate": "2024-11-08T14:29:00.012345", "originalFileReference": "DCTTFILEREF01234", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "numBulks": 1000, "numTransactions": 10000, "numMessages": 99999999 }, { "fileType": "CVF", "fileReference": "DCTTFILEREF01234", "lac": "02", "lacIndicator": false, "timeIndicator": "00:00", "dateTime": "2024-11-08T14:29:00.012345", "date": "2024-11-08", "fileStatus": "TSD", "reasonCode": "R01", "lastStatusUpdate": "9999-12-31T12:55:45.000001", "originalFileReference": "TESTFILEREF09999", "networkFileName": "S202DCTTESTITMM_F123ABC.I", "network": "FXS", "numBulks": 10000, "numTransactions": 99999999, "numMessages": 1000 } ], "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/fileDetails/{senderBIC}": { "post": { "tags": [ "Transaction Inquiry" ], "operationId": "files", "summary": "It allows to get the details of a specific file sent or received by the Participant.", "description": "The fileDetails request allows participants to get the details of a specific file for which they are sender or receiver.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "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", "fileRef": { "fileType": "ICF", "fileStatus": "RCV", "fileReference": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202DCTTESTITMM_F800AAA.I" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "fileCVF": { "fileType": "ICF", "receiverBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "fileReference": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "TSD", "reasonCode": "A01", "lastStatusUpdate": "2024-11-08T14:29:00.012345", "ICFFileReference": "DCTTFILEREF01234", "ICFNetworkFileName": "S202DCTTESTITMM_F123ABC.I", "numAcceptedBulks": 1000, "numRejectedBulks": 10000, "numAcceptedPayments": 99999999, "valAcceptedPayments": 10000.01, "numRejectedPayments": 1000, "valRejectedPayments": 1234567.99, "numAcceptedReturns": 10000, "valAcceptedReturns": 9999999.12, "numRejectedReturns": 99999999, "valRejectedReturns": 10000.01, "numAcceptedPCR": 1000, "valAcceptedPCR": 1234567.99, "numRejectedPCR": 10000, "valRejectedPCR": 9999999.12, "numAcceptedROI": 99999999, "numRejectedROI": 1000, "numRSUValidated": 10000, "numRSURejected": 99999999 }, "fileDRR": { "fileType": "ICF", "receiverBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "fileReference": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "TSD", "lastStatusUpdate": "2024-11-08T14:29:00.012345", "recordType": "HCRR", "totalNumberRecords": 1000, "numFilesSent": 10000, "numBulksSent": 99999999, "numFilesReject": 1000, "numBulksRejected": 10000, "numBulksCRTSent": 99999999, "numBulksCRTRejected": 1000, "numBulksReturnSent": 10000, "numBulksReturnRejected": 99999999, "numBulksPCRSent": 1000, "numBulksPCRRejected": 10000, "numBulksROISent": 99999999, "numBulksROIRejected": 1000, "numBulksRSUSent": 10000, "numBulksRSURejected": 99999999, "numCreditTransfersSent": 1000, "valCreditTransfersSent": 10000.01, "numCreditTransfersRejected": 10000, "valCreditTransfersRejected": 1234567.99, "numCreditTransfersHeld": 99999999, "valCreditTransfersHeld": 9999999.12, "numCreditTransfersCancelled": 1000, "valCreditTransfersCancelled": 10000.01, "numCreditTransfersSettled": 10000, "valCreditTransfersSettled": 1234567.99, "numReturnsSent": 99999999, "valReturnsSent": 9999999.12, "numReturnsRejected": 1000, "valReturnsRejected": 10000.01, "numReturnsHeld": 10000, "valReturnsHeld": 1234567.99, "numReturnsCancelled": 99999999, "valReturnsCancelled": 9999999.12, "numReturnsSettled": 1000, "valReturnsSettled": 10000.01, "numPCRSent": 10000, "valPCRSent": 1234567.99, "numROISent": 99999999, "numRSUSent": 1000, "numPCRRejected": 10000, "valPCRRejected": 9999999.12, "numROIRejected": 99999999, "numRSURejected": 1000 }, "fileICF": { "fileType": "ICF", "senderBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "fileReference": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "RCV", "reasonCode": "A01", "processingTime": "2024-11-08T14:29:00.012345", "CVFFileReference": "DCTTFILEREF01234", "CVFNetworkfilename": "S202DCTTESTITMM_F123ABC.I", "numBulksValidated": 1000, "numBulksRejected": 10000, "numPaymentsValidated": 99999999, "valPaymentsValidated": 10000.01, "numPaymentsRejected": 1000, "valPaymentsRejected": 1234567.99, "numReturnsValidated": 10000, "valReturnsValidated": 9999999.12, "numReturnsRejected": 99999999, "valReturnsRejected": 10000.01, "numPCRValidated": 1000, "valPCRValidated": 1234567.99, "numPCRRejected": 10000, "valPCRRejected": 9999999.12, "numROIValidated": 99999999, "numROIRejected": 1000, "numRSUValidated": 10000, "numRSURejected": 99999999 }, "fileIQF": { "fileType": "ICF", "senderBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "fileReference": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "RCV", "reasonCode": "A01", "processingTime": "2024-11-08T14:29:00.012345", "QVFFileReference": "DCTTFILEREF01234", "QVFNetworkfilename": "S202DCTTESTITMM_F123ABC.I", "numBulksValidated": 1000, "numBulksRejected": 10000, "numCNRValidated": 99999999, "numCNRRejected": 1000, "numRMPValidated": 10000, "numRMPRejected": 99999999, "numROIValidated": 1000, "numROIRejected": 10000, "numRSUValidated": 99999999, "numRSURejected": 1000 }, "fileMSR": { "fileType": "ICF", "receiverBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "fileReference": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "TSD", "lastStatusUpdate": "2024-11-08T14:29:00.012345", "recordType": "HCRR", "totalNumberRecords": 1000, "numCreditTransfersSent": 10000, "numCreditTransfersRejected": 99999999, "numCreditTransfersCancelled": 1000, "numCreditTransfersSettled": 10000, "numReturnsSent": 99999999, "numReturnsRejected": 1000, "numReturnsCancelled": 10000, "numReturnsSettled": 99999999, "numPCRSent": 1000, "numPCRRejected": 10000, "numROISent": 99999999, "numROIRejected": 1000, "numRSUSent": 10000, "numRSURejected": 99999999, "valCreditTransfersSent": 10000.01, "valCreditTransfersRejected": 1234567.99, "valCreditTransfersCancelled": 9999999.12, "valCreditTransfersSettled": 10000.01, "valReturnsSent": 1234567.99, "valReturnsRejected": 9999999.12, "valReturnsCancelled": 10000.01, "valReturnsSettled": 1234567.99, "valPCRSent": 9999999.12, "valPCRRejected": 10000.01 }, "fileNRR": { "fileType": "ICF", "receiverBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "fileReference": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "TSD", "lastStatusUpdate": "2024-11-08T14:29:00.012345", "recordType": "HCRR", "totalNumberRecords": 1000, "numCNRSent": 10000, "numCNRRejected": 99999999, "numRMPSent": 1000, "numRMPRejected": 10000, "numROISent": 99999999, "numROIRejected": 1000, "numRSUSent": 10000, "numRSURejected": 99999999 }, "fileOQF": { "fileType": "ICF", "receiverBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "lac": "01", "fileReference": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "TSD", "lastStatusUpdate": "2024-11-08T14:29:00.012345", "numBulksContained": 1000, "numCNR": 10000, "numRMP": 99999999, "numROI": 1000, "numRSU": 10000 }, "filePCF": { "fileType": "ICF", "receiverBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "lac": "01", "fileReference": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "TSD", "lastStatusUpdate": "2024-11-08T14:29:00.012345" }, "filePSR": { "fileType": "ICF", "receiverBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "lac": "01", "fileReference": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "TSD", "lastStatusUpdate": "2024-11-08T14:29:00.012345" }, "fileQVF": { "fileType": "ICF", "receiverBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "fileReference": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "TSD", "reasonCode": "A01", "lastStatusUpdate": "2024-11-08T14:29:00.012345", "IQFFileReference": "DCTTFILEREF01234", "IQFNetworkfilename": "S202DCTTESTITMM_F123ABC.I", "numBulksAccepted": 1000, "numBulksRejected": 10000, "numCNRValidated": 99999999, "numCNRRejected": 1000, "numRMPValidated": 10000, "numRMPRejected": 99999999, "numROIValidated": 1000, "numROIRejected": 10000, "numRSUValidated": 99999999, "numRSURejected": 1000 }, "fileRTF": { "fileType": "ICF", "receiverBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "fileReference": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "TSD", "lastStatusUpdate": "2024-11-08T14:29:00.012345" }, "fileSCF": { "fileType": "ICF", "receiverBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "lac": "01", "timeIndicator": "16:00", "fileReference": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "TSD", "lastStatusUpdate": "2024-11-08T14:29:00.012345", "numBulksContained": 1000, "numPaymentsSettled": 10000, "valPaymentsSettled": 10000.01, "numReturnsSettled": 99999999, "valReturnsSettled": 1234567.99, "numPCR": 1000, "valPCR": 9999999.12, "numROI": 10000, "numRSU": 99999999 }, "fileIGF": { "fileType": "ICF", "senderBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "IGFFileRef": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "IGFNetworkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "RCV", "reasonCode": "A01", "processingTime": "2024-11-08T14:29:00.012345", "OGFFileRef": "DCTTFILEREF01234", "OGFNetworkFileName": "S202DCTTESTITMM_F123ABC.I", "numGetAccountValidated": 1000, "numGetAccountRejected": 10000, "numGetTransactionValidated": 99999999, "numGetTransactionRejected": 1000 }, "fileOGF": { "fileType": "ICF", "receiverBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "OGFFileRef": "TESTFILEREF01234", "dateTime": "2019-06-21T23:20:50.000001", "OGFNetworkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "TSD", "reasonCode": "A01", "lastStatusUpdated": "2024-11-08T14:29:00.012345", "IGFFileRef": "DCTTFILEREF01234", "IGFNetworkFileName": "S202DCTTESTITMM_F123ABC.I", "numGetAccountValidated": 1000, "numGetAccountRejected": 10000, "numGetTransactionValidated": 99999999, "numGetTransactionRejected": 1000 }, "fileRSF": { "fileType": "ICF", "receiverBIC": "TESTIT88", "businessDate": "2019-06-21", "calendarDate": "2024-11-08", "lac": "01", "fileReference": "TESTFILEREF01234", "timeIndicator": "16:00", "dateTime": "2019-06-21T23:20:50.000001", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "network": "SWT", "fileStatus": "TSD", "lastStatusUpdate": "2024-11-08T14:29:00.012345", "numBulksContained": 1000, "numPaymentsSettled": 10000, "valPaymentsSettled": 10000.01, "numReturnsSettled": 99999999, "valReturnsSettled": 1234567.99, "numPaymentsCancelledQueued": 1000, "valPaymentsCancelledQueued": 9999999.12, "numReturnsCancelledQueued": 10000, "valReturnsCancelledQueued": 10000.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" } } } }, "/listMessages/{senderBIC}": { "post": { "tags": [ "Message Inquiry" ], "operationId": "listMessages", "summary": "It allows to enquire the list of the messages sent or received by the Participant.", "description": "The listMessagesrequest allows participants to retrieve the list of messages for which they are sender or receiver.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMessagesRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "fileType": "ICF", "messageType": "Camt.003", "senderReceiverBIC": "TESTIT88", "dateTimeFrom": "2019-06-21T23:20:50.000001", "dateTimeTo": "2024-11-08T14:29:00.012345", "messageRef": "MSGREF0000011111", "originalMessageRef": "DCTREF0000011234", "messageStatus": "VAL", "reasonCode": "GMRC", "IGFFileRef": "TESTFILEREF01234", "OGFFileRef": "DCTTFILEREF01234", "network": "SWF" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMessagesResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "endOfList": true, "messages": [ { "senderReceiverBIC": "TESTIT88", "messageType": "Camt.003", "messageRef": "MSGREF0000011111", "dateTime": "2019-06-21T23:20:50.000001", "lastStatusUpdate": "2024-11-08T14:29:00.012345", "messageStatus": "VAL", "reasonCode": "GMRC", "originalMessageRef": "DCTREF0000011234", "network": "SWF", "IGFFileRef": "TESTFILEREF01234", "OGFFileRef": "DCTTFILEREF01234" }, { "senderReceiverBIC": "BICDPA23", "messageType": "Camt.004", "messageRef": "DCTREF0000011234", "dateTime": "2024-11-08T14:29:00.012345", "lastStatusUpdate": "9999-12-31T12:55:45.000001", "messageStatus": "RCV", "reasonCode": "EX01", "originalMessageRef": "MSGREF0000011999", "network": "SWA", "IGFFileRef": "DCTTFILEREF01234", "OGFFileRef": "TESTFILEREF09999" } ], "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/messageDetails/{senderBIC}": { "post": { "tags": [ "Message Inquiry" ], "operationId": "messageDetails", "summary": "It allows to get the details of a specific message sent or received by the Participant.", "description": "The messageDetails request allows participants to get the details of a specific message for which they are sender or receiver.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageDetailsRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "message": { "messageType": "Camt.003", "messageStatus": "VAL", "messageRef": "MSGREF0000011111", "dateTime": "2019-06-21T23:20:50.000001", "senderReceiverBIC": "TESTIT88" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "messageDetails": { "messageType": "Camt.003", "messageStatus": "VAL", "messageRef": "MSGREF0000011111", "dateTime": "2019-06-21T23:20:50.000001", "validationDateTime": "2024-11-08T14:29:00.012345", "lastStatusUpdate": "9999-12-31T12:55:45.000001", "senderReceiverBIC": "TESTIT88", "IGFFileRef": "TESTFILEREF01234", "OGFFileRef": "DCTTFILEREF01234", "network": "SWF", "counter": 1000, "getAccountDetails": { "settlementBIC": "IPSDID21XXX" }, "returnAccountDetails": { "settlementBIC": "IPSDID21XXX", "position": 1000, "positionTimestamp": "2019-06-21T23:20:50.000001" }, "returnAccountQueryResponseError": { "reasonCode": "GMRC" }, "getTransaction": { "referenceLCR": "TESTFILEREF01234" }, "returnTransaction": { "instructingSettlementBIC": "IPSDID21XXX", "instructingDPBIC": "TESTIT88", "instructedSettlementBIC": "TESBIC11XXX", "instructedDPBIC": "BICDPA23", "lcrStatusUpdate": [ { "lcrStatus": "WTG", "lastStatusUpdate": "2019-06-21T23:20:50.000001" }, { "lcrStatus": "STTLD", "lastStatusUpdate": "2024-11-08T14:29:00.012345" } ], "totalLCRNumber": 1000, "totalLCRAmount": 10000.01 }, "returnTransactionQueryResponseError": { "reasonCode": "GMRC" } } } } } } }, "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": [ "Commands" ], "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 participants to ask for the resending of a single file in ERR (error) – TSD (transmitted) – TSG (transmitting) status and for which the participant was the receiver.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "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", "fileRef": { "fileType": "ICF", "networkFileName": "S202DCTTESTITMM_F800AAA.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" } } } } }, "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": [ "Commands" ], "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 allows a participant to ask the comprehensive re-transmission of all the output files in TSG (transmitting) or ERR (error) status and for which such participant was the receiver.\nIf no record is found for the selected criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "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", "resendCriteria": { "fileType": "ICF", "dateFrom": "2019-06-21", "dateTo": "2024-11-08", "fileReference": "TESTFILEREF01234", "lac": "01", "originalFileRef": "DCTTFILEREF01234", "fileStatus": "ERR", "reasonCode": "A01" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResendAllResponse" }, "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" } } } }, "/retransmitOutMessages/{senderBIC}": { "post": { "tags": [ "Commands" ], "operationId": "retransmitOutMessages", "summary": "It allows to ask for the resending of a single message for which the Participant was the receiver.", "description": "The retransmitOutMessages request allows participants to ask for the resending of a single message in ERR (error) – TSD (transmitted) – TSG (transmitting) status and for which the participant was the receiver.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetransmitOutMessagesRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "message": { "messageType": "Camt.003", "messageRef": "MSGREF0000011111" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetransmitOutMessagesResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandRef": "F010190208113908", "counter": 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" } } } }, "/bulkCancellation/{senderBIC}": { "put": { "tags": [ "Commands" ], "operationId": "bulkCancellation", "summary": "It allows the Participant to ask the cancellation of a bulk processed in Bulk Processing mode before the settlement takes place. ", "description": "The bulkCancellation request allows participants to ask the cancellation of a bulk processed in Bulk Processing mode before the settlement of the included CT transactions takes place. Only bulks of pacs.008 (CT bulk messages) can be cancelled. The cancellation of a bulk is accepted only in case the included transactions are in suitable status (either“Positively Validated” or “Rejected” (from validation)). If there is at least one transaction of the bulk that is in a different status, the bulk cannot be cancelled.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCancellationRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "bulkRef": { "fileReference": "TESTFILEREF01234", "bulkReference": "TESTBULKREF135000000000000000000123" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCancellationResponse" }, "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" } } } }, "/reportRequest/{senderBIC}": { "post": { "tags": [ "Commands" ], "operationId": "reportRequest", "summary": "It allows to ask for the creation of an offline report (valid only for the transactions processed in bulk processing mode).", "description": "The reportRequest allows participants to ask for the creation of an offline report (valid only for the transactions processed in bulk processing mode).\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)\nIt will not be available during Non-Target days for any participants regardless their adherence to NTD AOS (errorCode XA25)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "reportCriteria": { "fileType": "ICF", "fileReference": "TESTFILEREF01234", "lac": "01", "bulkType": "Pacs.008", "settlementDateFrom": "2019-06-21", "settlementDateTo": "2024-11-08", "debtorAgent": "TESBIC22XXX", "instructingAgent": "TESTIT88", "transactionId": "TESTTRANSEF135000000000000000000123" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "reportRef": "UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN" } } } } }, "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" } } } }, "/listReport/{senderBIC}": { "post": { "tags": [ "Commands" ], "operationId": "listReport", "summary": "It allows to enquire the list of the offline report generated after the “ReportRequest” API (valid only for the transactions processed in bulk processing mode).", "description": "The listReport allows participants to retrieve the list of the offline report generated after the “ReportRequest” API (valid only for the transactions processed in bulk processing mode).\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListReportRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "reportRef": "UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN", "creationDateTimeFrom": "2019-06-21T23:20:50.000001", "creationDateTimeTo": "2024-11-08T14:29:00.012345", "reportStatus": "WTG" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListReportResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "reports": [ { "reportRef": "UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN", "creationDateTime": "2019-06-21T23:20:50.000001", "reportType": "BRE", "reportStatus": "WTG" }, { "reportRef": "UUUUUUUU_YYDDD_11115678901234567890123456789012345_NNN", "creationDateTime": "2024-11-08T14:29:00.012345", "reportType": "TOF", "reportStatus": "RDY" } ] } } } } }, "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" } } } }, "/reportReceivingRequest/{senderBIC}": { "post": { "tags": [ "Commands" ], "operationId": "reportReceivingRequest", "summary": "It allows to ask for the receiving of an offline report generated after the “ReportRequest” API (valid only for the transactions processed in bulk processing mode).", "description": "The reportReceivingRequest allows participants to request the reception of an offline report generated after the “ReportRequest” API (valid only for the transactions processed in bulk processing mode).\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportReceivingRequestRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "reportRef": "UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportReceivingRequestResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "report": { "reportRef": "UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN", "creationDateTime": "2019-06-21T23:20:50.000001", "reportType": "BRE", "reportStatus": "WTG", "data": "U3dhZ2dlciByb2Nrcw" } } } } } }, "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" } } } }, "/thirdPoleReportRequest/{senderBIC}": { "post": { "tags": [ "Commands" ], "operationId": "thirdPoleReportRequest", "summary": "It allows to ask for the creation of the Third Pole Reconciliation report.", "description": "The thirdPoleReportRequest allows participants to request the creation of the Third Pole Reconciliation report.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThirdPoleReportRequestRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "reportCriteria": { "processCycle": "01", "bulkType": "Pacs.008" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThirdPoleReportRequestResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001" } } } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "204": { "description": "No Content", "$ref": "#/components/responses/ErrorResponse_204" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/Errors" } ] } } }, "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } } }, "401": { "description": "Unauthorized", "$ref": "#/components/responses/ErrorResponse_401" }, "403": { "description": "Forbidden", "$ref": "#/components/responses/ErrorResponse_403" }, "404": { "description": "Not Found", "$ref": "#/components/responses/ErrorResponse_404" }, "429": { "description": "Too many requests", "$ref": "#/components/responses/ErrorResponse_429" }, "500": { "description": "Internal Server Error", "$ref": "#/components/responses/ErrorResponse_500" } } } }, "/listThirdPoleReport/{senderBIC}": { "post": { "tags": [ "Commands" ], "operationId": "listThirdPoleReport", "summary": "It allows to ask for the list of the Third Pole Reconciliation report generated after the “ThirdPoleReportRequest” API.", "description": "The listThirdPoleReport allows participants to ask for the list of the Third Pole Reconciliation report generated after the “ThirdPoleReportRequest” API.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListThirdPoleReportRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "reportRef": "UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN", "creationDateTimeFrom": "2019-06-21T23:20:50.000001", "creationDateTimeTo": "2024-11-08T14:29:00.012345", "reportStatus": "WTG" }, "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListThirdPoleReportResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "reports": [ { "reportRef": "UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN", "creationDateTime": "2019-06-21T23:20:50.000001", "reportType": "BRE", "reportStatus": "WTG" }, { "reportRef": "UUUUUUUU_YYDDD_11115678901234567890123456789012345_NNN", "creationDateTime": "2024-11-08T14:29:00.012345", "reportType": "TOF", "reportStatus": "RDY" } ], "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" } } } }, "/thirdPoleReportReceivingRequest/{senderBIC}": { "post": { "tags": [ "Commands" ], "operationId": "thirdPoleReportReceivingRequest", "summary": "It allows to ask for the receiving of the Third Pole Reconciliation report generated after the “ThirdPoleReportRequest” API.", "description": "The thirdPoleReportReceivingRequest allows participants to request the reception of the Third Pole Reconciliation report generated after the “thirdPoleReportRequest” API.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThirdPoleReportReceivingRequestRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "reportRef": "UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThirdPoleReportReceivingRequestResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "report": { "reportRef": "UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN", "creationDateTime": "2019-06-21T23:20:50.000001", "reportType": "BRE", "reportStatus": "WTG", "data": "U3dhZ2dlciByb2Nrcw" } } } } } }, "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" } } } }, "/originalXML/{senderBIC}": { "post": { "tags": [ "Transaction Inquiry" ], "operationId": "originalXML", "summary": "It allows to ask for the creation of the original xml of the message (valid only for the transactions processed in bulk processing mode).", "description": "The originalXML allows participants to retrieve of the original xml of the message (valid only for the transactions processed in bulk processing mode).\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OriginalXMLRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "transactionRef": { "transactionType": "Pacs.008", "interbankSettlementDate": "2019-06-21", "transactionId": "TESTTRANSEF135000000000000000000123", "type": "SNT", "transactionStatus": "STG", "debtorBankBIC": "TESBIC22XXX", "creditorBankBIC": "TESBIC33XXX", "lac": "01" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OriginalXMLResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "originalXml": "......" } } } } }, "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 Participant to enquire the status of Commands that were submitted by the Participant.", "description": "The listCommands request allows participants to retrieve the list of their submitted commands.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "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": "001", "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": "001", "requestDateTime": "2019-06-21T23:20:50.000001", "authRejectDateTime": "2024-11-08T14:29:00.012345", "userIssuer": "APIUSER1", "userAuthReject": "APIUSER2", "commandRef": "F010190208113908" }, { "commandType": "F02", "commandStatus": "002", "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" } } } }, "/commandDetail/{senderBIC}": { "post": { "tags": [ "Commands" ], "operationId": "commandDetails", "summary": "It allows the Participant to retrieve the details of a single command submitted by the Participant.", "description": "The commandDetail request allows participants to retrieve the details of a single command submitted in DPWS.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommandDetailRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "commandRef": "F010190208113908" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommandDetailResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "retransmitOutFiles": { "commandRef": "F010190208113908", "commandType": "F01", "commandStatus": "001", "requestDateTime": "2019-06-21T23:20:50.000001", "authRejectDateTime": "2024-11-08T14:29:00.012345", "userIssuer": "APIUSER1", "userAuthReject": "APIUSER2", "fileType": "ICF", "networkFileName": "S202DCTTESTITMM_F800AAA.I", "settlementDate": "9999-12-31T12:55:45.000001", "dateTime": "2019-06-21T23:20:50.000001" }, "resendAll": { "commandRef": "F010190208113908", "commandType": "F01", "commandStatus": "001", "requestDateTime": "2019-06-21T23:20:50.000001", "authRejectDateTime": "2024-11-08T14:29:00.012345", "userIssuer": "APIUSER1", "userAuthReject": "APIUSER2", "fileType": "ICF", "dateTime": "9999-12-31T12:55:45.000001" }, "bulkCancellation": { "commandRef": "F010190208113908", "commandType": "F01", "commandStatus": "001", "requestDateTime": "2019-06-21T23:20:50.000001", "authRejectDateTime": "2024-11-08T14:29:00.012345", "userIssuer": "APIUSER1", "userAuthReject": "APIUSER2", "cancellationRef": "DCTSDTDITA22018534DCTDCTDITA2201853" }, "retransmitOutMessage": { "commandRef": "F010190208113908", "commandType": "F01", "commandStatus": "001", "requestDateTime": "2019-06-21T23:20:50.000001", "authRejectDateTime": "2024-11-08T14:29:00.012345", "userIssuer": "APIUSER1", "userAuthReject": "APIUSER2", "messageType": "Camt.003", "messageRef": "MSGREF0000011111", "dateTime": "9999-12-31T12:55:45.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" } } } }, "/listAlerts/{senderBIC}": { "post": { "tags": [ "Commands" ], "operationId": "listAlerts", "summary": "It allows the Participant to inquire the list of alerts produced by the System for its BIC.", "description": "The listAlerts request allows participant to retrieve the list of alerts produced by the System for their BIC.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "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": { "dateTimeFrom": "2019-06-21T23:20:50.000001", "dateTimeTo": "2024-11-08T14:29:00.012345", "eventDescription": "INDIRECT PARTICIPANT INPART001 IS NOT PRESENT", "issuer": "APIUSER1", "authorizer": "APIUSER2" }, "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": "INDIRECT PARTICIPANT INPART001 IS NOT PRESENT", "issuer": "APIUSER1", "authorizer": "APIUSER2", "DPBICCode": "Alert001" }, { "dateTime": "2024-11-08T14:29:00.012345", "eventType": "SEC", "eventDescription": "OPERATION NOT ALLOWED", "issuer": "APIUSER2", "authorizer": "APIUSER3", "DPBICCode": "Alert012" } ], "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" } } } }, "/listLCR/{senderBIC}": { "post": { "tags": [ "LCR" ], "operationId": "listLCR", "summary": "It allows to enquire the list of LCRs generated for the Participant by DCT Service. ", "description": "The listLCR request allows participants to retrieve the list of their LCRs.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/SenderBIC" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLCRRequest" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "searchCriteria": { "instructingDPBIC": "TESTIT88", "instructedDPBIC": "BICDPA23", "instgSttlmBIC": "IPSDID21XXX", "instdSttlmBIC": "TESBIC11XXX", "settlementDateFrom": "2019-06-21", "settlementDateTo": "2024-11-08", "dateTimeFrom": "2019-06-21T23:20:50.000001", "dateTimeTo": "2024-11-08T14:29:00.012345", "referenceLCR": "TESTFILEREF01234", "bulkType": "pacs.008", "lac": "01", "lcrStatus": "WTG", "offset": "AAaa88ss2345fggGGDDaaaHH" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLCRResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "endOfList": true, "LCRs": [ { "instructingDPBIC": "TESTIT88", "instructedDPBIC": "BICDPA23", "instgSttlmBIC": "IPSDID21XXX", "instdSttlmBIC": "TESBIC11XXX", "settlementDate": "2019-06-21", "businessDateTime": "2019-06-21T23:20:50.000001", "bulkType": "pacs.008", "referenceLCR": "TESTFILEREF01234", "lac": "01", "lcrStatus": "WTG", "originalBulkReferenceId": "TESTBULKREF135000000000000000000123", "originalInputFileReferenceId": "DCTTFILEREF01234", "amount": 10000.01, "dbrCrdFlag": "C", "creationDateTime": "2024-11-08T14:29:00.012345" }, { "instructingDPBIC": "BICDPA23", "instructedDPBIC": "DPBICA88", "instgSttlmBIC": "TESBIC11XXX", "instdSttlmBIC": "TESBIC99XXX", "settlementDate": "2024-11-08", "businessDateTime": "2024-11-08T14:29:00.012345", "bulkType": "pacs.004", "referenceLCR": "DCTTFILEREF01234", "lac": "02", "lcrStatus": "STTLD", "originalBulkReferenceId": "TESTBULKREF135000000000000000999999", "originalInputFileReferenceId": "TESTFILEREF09999", "amount": 1234567.99, "dbrCrdFlag": "D", "creationDateTime": "9999-12-31T12:55:45.000001" } ], "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" ], "operationId": "lcrDetails", "summary": "It allows the Participant to inquire details of a specific LCR.", "description": "The lcrDetails request allows participants to retrieve the details of a specific LCR.\nIf no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.", "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)", "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": { "settlementDate": "2019-06-21", "referenceLCR": "TESTFILEREF01234", "lac": "01", "lcrStatus": "WTG" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LcrDetailsResponse" }, "examples": { "OK": { "value": { "dateTime": "2019-06-21T23:20:50.000001", "LCRDetails": { "referenceLCR": "TESTFILEREF01234", "settlementDate": "2019-06-21", "origBulkMsgId": "TESTBULKREF135000000000000000000123", "origInputFile": "DCTTFILEREF01234", "bulkType": "pacs.008", "instructingDPBIC": "TESTIT88", "instructedDPBIC": "BICDPA23", "instgSttlmBIC": "IPSDID21XXX", "instdSttlmBIC": "TESBIC11XXX", "credPartyBIC": "DPBICA88", "debPartyBIC": "TESTIT88", "lacInputS2": "01", "cgsLacInput": "02", "cgsLacOutput": "10", "amount": 10000.01, "numTransactions": 1000, "lcrStatus": "WTG", "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" } } } } }, "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": { "ActiveOutputNetwork": { "description": "Active Network.", "type": "string", "enum": [ "PRI", "SEC" ], "examples": [ "PRI" ] }, "Alerts": { "type": "object", "properties": { "dateTime": { "description": "The Date and Time of command", "$ref": "#/components/schemas/DateTime" }, "eventType": { "description": "The type of event", "$ref": "#/components/schemas/EventType" }, "eventDescription": { "description": "The description of command", "$ref": "#/components/schemas/EventDescription" }, "issuer": { "description": "The issuer of the alert", "$ref": "#/components/schemas/UserId" }, "authorizer": { "description": "The authorizer of the alert", "$ref": "#/components/schemas/UserId" }, "DPBICCode": { "description": "This field contains the SYSTEM value for STEP2 SCT CS generated alert. For alert issued by a user, it contains the related Direct Participant BIC of the alert issuer.", "$ref": "#/components/schemas/String8" } }, "required": [ "dateTime", "eventType", "eventDescription", "issuer", "authorizer", "DPBICCode" ] }, "Amount": { "description": "Position Amount", "type": "number", "format": "double", "minimum": 0, "maximum": 1000000000000000, "examples": [ 1000 ] }, "AOSParam": { "description": "AOS enum.", "type": "string", "enum": [ "AO1", "ERI", "CAI", "NTD" ], "examples": [ "AO1" ] }, "AOSParam1": { "description": "AOS enum.", "type": "string", "enum": [ "AO1", "ERI" ], "examples": [ "AO1" ] }, "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": { "description": "BIC11 Only", "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3})", "examples": [ "IPSDID21XXX" ] }, "Bic11Only": { "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3})", "minLength": 11, "maxLength": 11, "examples": [ "IPSDID21XXX" ] }, "BIC8": { "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" ] }, "Bulk": { "type": "object", "properties": { "bulkType": { "description": "The message type", "$ref": "#/components/schemas/MessageType" }, "bulkReference": { "description": "The bulk reference", "$ref": "#/components/schemas/BulkReference" }, "fileReference": { "description": "The file reference", "$ref": "#/components/schemas/FileReference" }, "fileType": { "description": "The file type", "$ref": "#/components/schemas/FileType" }, "ICFFileReference": { "description": "The ICF file reference", "$ref": "#/components/schemas/FileReference" }, "IQFFileReference": { "description": "The IQF file reference", "$ref": "#/components/schemas/FileReference" }, "CVFFileReference": { "description": "The CVF file reference", "$ref": "#/components/schemas/FileReference" }, "CVFBulkReference": { "description": "The CVF bulk reference", "$ref": "#/components/schemas/BulkReference" }, "QVFFileReference": { "description": "The QVF file reference", "$ref": "#/components/schemas/FileReference" }, "QVFBulkReference": { "description": "The QVF bulk reference", "$ref": "#/components/schemas/BulkReference" }, "SCFBulkReference": { "description": "The SCF bulk reference", "$ref": "#/components/schemas/BulkReference" }, "OQFBulkReference": { "description": "The OQF bulk reference", "$ref": "#/components/schemas/BulkReference" }, "RSFBulkReference": { "description": "The RSF bulk reference", "$ref": "#/components/schemas/BulkReference" }, "numOfTransaction": { "description": "The number of transactions included in the bulk", "$ref": "#/components/schemas/StandardInteger" }, "valueOfTransaction": { "description": "The total amount of transactions included in the bulk", "$ref": "#/components/schemas/StandardAmount1" }, "numOfRejectedTransaction": { "description": "The number of rejected transactions included in the bulk", "$ref": "#/components/schemas/StandardInteger" }, "valueOfRejectedTransaction": { "description": "The total amount of rejected transactions included in the bulk", "$ref": "#/components/schemas/StandardAmount1" }, "bulkRejectionCode": { "description": "The rejection code of the bulk", "$ref": "#/components/schemas/ReasonCode" }, "senderReceiverDPBICCode": { "description": "The BIC sending/receiving the bulk", "$ref": "#/components/schemas/BIC8" }, "CPUCreationDateTime": { "description": "The date and time of the bulk generation", "$ref": "#/components/schemas/DateTime" }, "businessDate": { "description": "The business date of the bulk generation", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The calendar date of the bulk generation", "$ref": "#/components/schemas/Date" }, "settlementDate": { "description": "The settlement date of the bulk generation", "$ref": "#/components/schemas/Date" } }, "required": [ "bulkType", "bulkReference", "fileReference", "fileType", "numOfTransaction", "valueOfTransaction", "numOfRejectedTransaction", "valueOfRejectedTransaction", "senderReceiverDPBICCode", "CPUCreationDateTime", "businessDate", "calendarDate", "settlementDate" ] }, "BulkCancellation": { "type": "object", "properties": { "commandRef": { "description": "The command reference", "$ref": "#/components/schemas/CommandRef" }, "commandType": { "description": "The command type (F02 for Bulk Cancellation)", "$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/UserId" }, "userAuthReject": { "description": "The UserID of the user that has authorized or rejected the command", "$ref": "#/components/schemas/UserId" }, "cancellationRef": { "description": "Reference for bulk cancellation", "$ref": "#/components/schemas/CancellationRef" } }, "required": [ "commandRef", "commandType", "commandStatus", "requestDateTime", "authRejectDateTime", "userIssuer", "userAuthReject", "cancellationRef" ] }, "BulkCancellationRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "bulkRef": { "$ref": "#/components/schemas/BulkRef1" } }, "required": [ "dateTime", "bulkRef" ] }, "BulkCancellationResponse": { "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/CommandRef" } }, "required": [ "dateTime", "commandRef" ] }, "BulkDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "bulkRef": { "$ref": "#/components/schemas/BulkRef" } }, "required": [ "dateTime", "bulkRef" ] }, "BulkDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "bulk": { "$ref": "#/components/schemas/Bulk" } }, "required": [ "dateTime" ] }, "BulkRef": { "type": "object", "properties": { "fileType": { "description": "The file type\n\n **Validation Rule(s)** It must be set with one allowed value\n(errorCode SC01)", "$ref": "#/components/schemas/FileType" }, "messageType": { "description": "The message type\n\n **Validation Rule(s)** It must be set with one allowed value\n(errorCode SC01)", "$ref": "#/components/schemas/MessageType" }, "fileReference": { "description": "The file reference", "$ref": "#/components/schemas/FileReference" }, "bulkReference": { "description": "The bulk reference", "$ref": "#/components/schemas/BulkReference" }, "dateTime": { "description": "The date and time when the bulk was received by the Central System or created", "$ref": "#/components/schemas/DateTime" } }, "required": [ "bulkReference" ] }, "BulkRef1": { "type": "object", "properties": { "fileReference": { "description": "The file reference", "$ref": "#/components/schemas/FileReference" }, "bulkReference": { "description": "The bulk reference of the bulk to be cancelled", "$ref": "#/components/schemas/BulkReference" } }, "required": [ "fileReference", "bulkReference" ] }, "BulkReference": { "description": "The bulk reference of the file.", "type": "string", "pattern": "([A-Za-z0-9]|[+|\\?|/|\\-|:|\\(|\\)|\\.|,|']){1,35}", "examples": [ "TESTBULKREF135000000000000000000123" ] }, "Bulks": { "type": "object", "properties": { "messageType": { "description": "The type of message", "$ref": "#/components/schemas/MessageType" }, "senderReceiverBIC": { "description": "The DP BIC of the receiver/sender", "$ref": "#/components/schemas/BIC8" }, "fileReference": { "description": "The file reference", "$ref": "#/components/schemas/FileReference" }, "bulkReference": { "description": "The bulk reference", "$ref": "#/components/schemas/BulkReference" }, "date": { "description": "The date of STEP2 CS of the bulk header", "$ref": "#/components/schemas/Date" }, "dateTime": { "description": "The date and time when the bulk was received by the Central System or created", "$ref": "#/components/schemas/DateTime" }, "lac": { "description": "The LAC in which the bulk was generated in CGS", "$ref": "#/components/schemas/Lac" }, "bulkStatus": { "description": "The bulk status", "$ref": "#/components/schemas/BulkStatus" }, "reasonCode": { "description": "The reason code", "$ref": "#/components/schemas/ReasonCode" }, "fileType": { "description": "The file type", "$ref": "#/components/schemas/FileType1" } }, "required": [ "messageType", "senderReceiverBIC", "fileReference", "bulkReference", "date", "dateTime", "bulkStatus", "reasonCode", "fileType" ] }, "BulkStatus": { "description": "The status of Bulk.", "type": "string", "enum": [ "PART", "ACCP", "RJCT" ], "examples": [ "ACCP" ] }, "BulkType": { "type": "string", "enum": [ "pacs.004", "pacs.008" ], "examples": [ "pacs.008" ] }, "CancellationRef": { "description": "Reference for bulk and batch cancellation.", "type": "string", "pattern": "[A-Z0-9]{35,35}", "examples": [ "DCTSDTDITA22018534DCTDCTDITA2201853" ] }, "ChangeStatusRB": { "type": "object", "properties": { "RBBICCode": { "description": "The relevant RB BIC\n\n **Validation Rule(s)** Must have status “Enabled” or “Suspended”\n(errorCode PY01)\nMust be listed in Routing Table under the senderBIC\n(errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "newStatus": { "description": "The new status of the RB\n\n **Validation Rule(s)** It can contain DIS if the RB has \"ENB\" status and\n1. the RB is going to become disabled [no end validity date has been previously set]\n2. the RB has an end date already set in the future and the user wishes to postpone or bring it forward (i.e. \"Amend Remove\")\n- \"ENB\" if the RB has “ENB” (enabled) status, an End date already set in the future and the user wishes to cancel the previous Remove operation and keep the BIC in ENB status (i.e. ”Revoke Remove” – effectiveDate must be set to 9999-12-31).\n(errorCode SC01)", "$ref": "#/components/schemas/ParticipantStatus1" }, "effectiveDate": { "description": "The effective date of the change\n\n **Validation Rule(s)** 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”\n- the effective date must be equal to 9999-12-31 if the operation corresponds to a “Revoke Remove” (newStatus must be set to ENB”)\n(errorCode DT01)", "$ref": "#/components/schemas/Date" } }, "required": [ "RBBICCode", "newStatus", "effectiveDate" ] }, "ChangeStatusReachableBICRequest": { "type": "object", "properties": { "dateTime": { "description": "The date time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "changeStatusRB": { "$ref": "#/components/schemas/ChangeStatusRB" } }, "required": [ "dateTime", "changeStatusRB" ] }, "ChangeStatusReachableBICResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "operationRef": { "description": "The reference assigned by the system to the \"Change Status (Remove)\" operation, logged in the system in TBA status", "$ref": "#/components/schemas/OperationReference" } }, "required": [ "dateTime", "operationRef" ] }, "CommandDetailRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "commandRef": { "description": "The command reference", "$ref": "#/components/schemas/CommandRef" } }, "required": [ "dateTime", "commandRef" ] }, "CommandDetailResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "retransmitOutFiles": { "$ref": "#/components/schemas/RetransmitOutFiles" }, "resendAll": { "$ref": "#/components/schemas/ResendAll" }, "bulkCancellation": { "$ref": "#/components/schemas/BulkCancellation" }, "retransmitOutMessage": { "$ref": "#/components/schemas/RetransmitOutMessage" } }, "required": [ "dateTime" ] }, "CommandRef": { "description": "Command reference.", "type": "string", "maxLength": 16, "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 of the request", "$ref": "#/components/schemas/DateTime" }, "authRejectDateTime": { "description": "The date and time of the authorization/rejection", "$ref": "#/components/schemas/DateTime" }, "userIssuer": { "description": "The user who issued the command", "$ref": "#/components/schemas/UserId" }, "userAuthReject": { "description": "The user who authorized/rejected the command", "$ref": "#/components/schemas/UserId" }, "commandRef": { "description": "The command reference", "$ref": "#/components/schemas/CommandRef" } }, "required": [ "commandType", "commandStatus", "requestDateTime", "userIssuer", "commandRef" ] }, "CommandStatus": { "description": "Command status.", "type": "string", "enum": [ "001", "002", "003" ], "examples": [ "001" ] }, "CommandType": { "description": "Command type.", "type": "string", "enum": [ "F01", "F02", "F04", "F05" ], "examples": [ "F01" ] }, "CustomerName": { "description": "Name of Customer.", "type": "string", "pattern": "(^\\S+.*){1,70}", "examples": [ "Airport parking" ] }, "Cycle": { "description": "The cycle of service.", "type": "string", "pattern": "[0-9]{2,2}", "examples": [ "01" ] }, "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": [ "Business Date", "Calendar Date", "Settlement Date" ], "examples": [ "Business Date" ] }, "DateType1": { "type": "string", "enum": [ "Business Date", "Calendar Date" ], "examples": [ "Business Date" ] }, "DebitPositionCGSRequest": { "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": "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" ] }, "DebitPositionCGSResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "header": { "$ref": "#/components/schemas/Header" }, "debtorPosition": { "type": "array", "items": { "$ref": "#/components/schemas/DebtorPosition" } }, "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", "header", "endOfList" ] }, "DebtorPosition": { "type": "object", "properties": { "counterpartyBIC": { "description": "The BIC of the counterparty (Credit BIC)", "$ref": "#/components/schemas/BIC8" }, "sumAmountCredTranSent": { "description": "Sum of Amount of Credit Transfert sent by the counterparty from this DP", "$ref": "#/components/schemas/StandardAmount1" }, "sumAmountReturnSent": { "description": "Sum of Amount of Returns sent by the counterparty from this DP", "$ref": "#/components/schemas/StandardAmount1" }, "totalDebitPosition": { "description": "Total Debit Position against this counterparty", "$ref": "#/components/schemas/StandardAmount1" }, "tresholdAmount": { "description": "The threshold amount against its counterparties", "$ref": "#/components/schemas/StandardAmount1" }, "sumAmountCredTranReceived": { "description": "Sum of Amount of Credit Transfert received by the counterparty from this DP\nLCRs in status\n- Waiting;\n- Transmitted:\n- Queued:\n- Rejected-due-to SWITCH\nare not counted", "$ref": "#/components/schemas/StandardAmount1" }, "sumAmountReturnReceived": { "description": "Sum of Amount of Returns received by the counterparty from this DP\nLCRs in status\n- Waiting;\n- Transmitted:\n- Queued:\n- Rejected-due-to SWITCH\nare not counted", "$ref": "#/components/schemas/StandardAmount1" }, "totalCreditPosition": { "description": "Total Credit Position against this counterparty.\nLCRs in status\n- Waiting;\n- Transmitted:\n- Queued:\n- Rejected-due-to SWITCH\nare not counted", "$ref": "#/components/schemas/StandardAmount1" }, "totalPosition": { "description": "Total Position computed as Total Credit Position minus of Total Debit Position (It could be negative)", "$ref": "#/components/schemas/StandardAmount1" } }, "required": [ "counterpartyBIC", "sumAmountCredTranSent", "sumAmountReturnSent", "totalDebitPosition", "tresholdAmount", "sumAmountCredTranReceived", "sumAmountReturnReceived", "totalCreditPosition", "totalPosition" ] }, "DedicatedCashAccount": { "description": "DCA number", "type": "string", "maxLength": 35, "examples": [ "11123422244678888888887677800000005" ] }, "DefaultThreshold": { "type": "object", "properties": { "creditPartyBIC": { "description": "The credit party BIC\n\n **Validation Rule(s)** It must be a credit party BIC of the sender BIC\n(errorCode XA07)", "$ref": "#/components/schemas/BIC8" }, "thresholdAmount": { "description": "The new threshold amount\n\n **Validation Rule(s)** Only decimal notation is allowed\n(errorCode XA05)", "$ref": "#/components/schemas/StandardAmount" } }, "required": [ "creditPartyBIC", "thresholdAmount" ] }, "DefaultThresholds": { "type": "object", "properties": { "debitPartyBIC": { "description": "The BIC of the debtor party (senderBIC)", "$ref": "#/components/schemas/BIC8" }, "creditPartyBIC": { "description": "The BIC of the creditor party", "$ref": "#/components/schemas/BIC8" }, "thresholdAmount": { "description": "The threshold amount", "$ref": "#/components/schemas/StandardAmount1" }, "lastUserUpdate": { "description": "The date and time of the last update", "$ref": "#/components/schemas/DateTime" } }, "required": [ "creditPartyBIC", "thresholdAmount", "lastUserUpdate" ] }, "DetailsHistory": { "type": "object", "properties": { "name": { "description": "The name of the participant", "$ref": "#/components/schemas/ParticipantName" }, "BICCode": { "description": "The BIC of the DP", "$ref": "#/components/schemas/BIC8" }, "newDPBICCode": { "description": "The new BIC of the DP, following a “Change BIC” operation", "$ref": "#/components/schemas/BIC8" }, "newRole": { "description": "The new role of the DP\ntrue= Role changed\nfalse= Role unchanged", "$ref": "#/components/schemas/GenericBoolean" }, "initParticipantValidity": { "description": "The first date starting from which the DP is active", "$ref": "#/components/schemas/Date" }, "endParticipantValidity": { "description": "The last date until which this DP is active", "$ref": "#/components/schemas/Date" }, "status": { "description": "The status of the DP", "$ref": "#/components/schemas/ParticipantStatus" }, "initParameterValidity": { "description": "The first date starting from which the set of parameters is valid", "$ref": "#/components/schemas/Date" }, "endParameterValidity": { "description": "The last date until this set of parameters is valid", "$ref": "#/components/schemas/Date" }, "DPSettlementBIC": { "description": "The BIC by which this DP is known to the External Settlement Mechanism", "$ref": "#/components/schemas/Bic11Only" }, "routingInfoChanged": { "description": "The flag used to show if this DP was subject to a Routing Change operation\ntrue= Routing changed\nfalse= No routing changed", "$ref": "#/components/schemas/GenericBoolean" }, "settlementFiles": { "description": "The number of settlement files the DP is configured to receive", "$ref": "#/components/schemas/SettlementFile" }, "RSFRequired": { "description": "The DP require to receive the RSF file\ntrue= RSF enabled\nfalse= RSF not enabled", "$ref": "#/components/schemas/GenericBoolean" }, "extendedPSR": { "description": "The DP require to receive the liquidity information in the extended PSR file\ntrue= PSR enabled\nfalse= PSR not enabled", "$ref": "#/components/schemas/GenericBoolean" }, "acceptanceDateAO1": { "description": "The DP adheres to the AOS1\ntrue= AOS1 enabled\nfalse= AOS1 not enabled", "$ref": "#/components/schemas/GenericBoolean" }, "remittanceInformationERI": { "description": "The DP adheres to the AOS ERI\ntrue= AOS ERI enabled\nfalse= AOS ERI not enabled", "$ref": "#/components/schemas/GenericBoolean" }, "nonTargetDaySettlement": { "description": "The DP is configured for NTD\ntrue= NTD enabled\nfalse= NTD not enabled", "$ref": "#/components/schemas/GenericBoolean" }, "allowedPCF": { "description": "The DP is configured to receive PCF files\ntrue= PCF enabled\nfalse= PCF not enabled", "$ref": "#/components/schemas/GenericBoolean" }, "separateReturnsFile": { "description": "The DP is configured to receive a dedicated SCF files containing only Return payments\ntrue= Separate Returns File enabled\nfalse= Separate Returns File not enabled", "$ref": "#/components/schemas/GenericBoolean" }, "maxReceivingFileSize": { "description": "The maximum number of bytes that a DP will accept for the size of each file received from STEP2 CS", "$ref": "#/components/schemas/StandardInteger" }, "defaultThresholdValue": { "description": "The Default Threshold Value between the DP and each other enabled DP", "$ref": "#/components/schemas/StandardAmount1" }, "swiftNetOutputFileCompression": { "description": "The DP is allowed to send/receive compressed files\ntrue= Compression enabled\nfalse= Compression not enabled", "$ref": "#/components/schemas/GenericBoolean" }, "nightTimeSettlement": { "description": "The DP is configured to settle in CGS Night-Time Settlement\ntrue= CGS Night-Time Settlement enabled\nfalse= CGS Night-Time Settlement not enabled", "$ref": "#/components/schemas/GenericBoolean" }, "technicalBIC": { "description": "The technical BIC indicator\ntrue= Technical BIC\nfalse=No technical BIC", "$ref": "#/components/schemas/GenericBoolean" }, "activeOutputNetwork": { "description": "The currently active output network where the output files are sent by STEP2 to DP", "$ref": "#/components/schemas/ActiveOutputNetwork" }, "priNetworkIdentification": { "description": "The primary network through which the DP connects to STEP2", "$ref": "#/components/schemas/NetworkIdentification" }, "secNetworkIdentification": { "description": "The type of network used by the DP as “Secondary Network”", "$ref": "#/components/schemas/NetworkIdentification" }, "priReceivingNetIdentification": { "description": "The identifier by which the DP is known on the primary network when receiving files from STEP2 CS", "$ref": "#/components/schemas/NetworkIdentification" }, "secReceivingNetIdentification": { "description": "The identifier by which the DP is known on the secondary network, when receiving files from STEP2 CS", "$ref": "#/components/schemas/NetworkIdentification" }, "priSendingNetIdentification": { "description": "The identifier by which this DP is known on the primary network when sending files to STEP2 CS", "$ref": "#/components/schemas/NetworkIdentification" }, "secSendingNetIdentification": { "description": "The identifier by which the DP is known on the secondary network, when sending files from STEP2 CS", "$ref": "#/components/schemas/NetworkIdentification" }, "T2RTGSAuthorisedAccountUserAAUForAS-D": { "description": "The BIC11 of the T2-RTGS DCA for settlement of STEP2 transactions. It must be declared at TARGET Level as Authorized Account User BIC of the T2-RTGS DCA used for AS-D", "$ref": "#/components/schemas/Bic11Only" }, "T2RTGSAuthorisedAccountUserAAUForAS-E": { "description": "The BIC11 of the T2-RTGS Dedicated Cash Account (DCA) for remuneration process.", "$ref": "#/components/schemas/Bic11Only" }, "T2RTGSDedicatedCashAccountDCAForAS-D": { "description": "The T2-RTGS Dedicated Cash Account (DCA) used by a Participant for funding/defunding CGS position (with Ancillary System AS-D). It is the Account registered with STEP2 Settlement Bank Account Group (as registered in T2 CRDM Registration form).", "$ref": "#/components/schemas/DedicatedCashAccount" }, "T2RTGSDedicatedCashAccountDCAForAS-E": { "description": "T2-RTGS Dedicated Cash Account (DCA) used by a Participant for remuneration process (with Ancillary System AS-E).", "$ref": "#/components/schemas/DedicatedCashAccount" }, "txThresholdForOutput": { "description": "Minimum number of settled pacs.008 /pacs.004 and valid camt.056/camt.029 transactions which trigger the generation of output files at relevant intervals. The parameter is applicable to SCF and RSF files.", "$ref": "#/components/schemas/GenericBoolean" } }, "required": [ "T2RTGSAuthorisedAccountUserAAUForAS-D", "T2RTGSDedicatedCashAccountDCAForAS-D" ] }, "DetailsHistory1": { "type": "object", "properties": { "name": { "description": "The name of the RB", "$ref": "#/components/schemas/ParticipantName" }, "BICCode": { "description": "The BIC of the RB", "$ref": "#/components/schemas/Bic11Only" }, "newBICCode": { "description": "The new BIC of the RB, following a “Change BIC” operation", "$ref": "#/components/schemas/Bic11Only" }, "newRole": { "description": "The new role of the RB\ntrue= Role changed\nfalse= Role unchanged", "$ref": "#/components/schemas/GenericBoolean" }, "initParticipantValidity": { "description": "The initial validity of the RB", "$ref": "#/components/schemas/Date" }, "endParticipantValidity": { "description": "The end validity of the RB", "$ref": "#/components/schemas/Date" }, "status": { "description": "The current status of the participant", "$ref": "#/components/schemas/ParticipantStatus" }, "initParameterValidity": { "description": "The first date starting from which the set of parameters is valid", "$ref": "#/components/schemas/Date" }, "endParameterValidity": { "description": "The first date starting from which the set of parameters is valid", "$ref": "#/components/schemas/Date" }, "routingInfoChanged": { "description": "The flag used to show if this RB was subject to a Routing Change operation\ntrue= Role changed\nfalse= Role unchanged", "$ref": "#/components/schemas/GenericBoolean" }, "DPBICCode": { "description": "The BIC of the DP to which the RB is linked", "$ref": "#/components/schemas/BIC8" }, "acceptanceDateAO1": { "description": "The RB adheres to the AOS1\ntrue= AOS1 enabled\nfalse= AOS1 not enabled", "$ref": "#/components/schemas/GenericBoolean" }, "remittanceInformationERI": { "description": "The RB adheres to the AOS ERI\ntrue= AOS ERI enabled\nfalse= AOS ERI not enabled", "$ref": "#/components/schemas/GenericBoolean" }, "sameBankingGroupAsDP": { "description": "RB part of the same banking group as its DP\ntrue= RB part of the same banking group as its DP\nfalse= RB not part of the same banking group as its DP", "$ref": "#/components/schemas/GenericBoolean" } } }, "DirectParticipant": { "type": "object", "properties": { "name": { "description": "The name of the participant", "$ref": "#/components/schemas/ParticipantName" }, "DPBICCode": { "description": "The DP to which the operation refers", "$ref": "#/components/schemas/BIC8" }, "settlementFiles": { "description": "The value set for settlement files", "$ref": "#/components/schemas/SettlementFile" }, "separateReturnFile": { "description": "The value set for separate file", "$ref": "#/components/schemas/GenericBoolean" }, "technicalBIC": { "description": "The value set for technical BIC parameter", "$ref": "#/components/schemas/GenericBoolean" }, "RSFRequired": { "description": "The value set for RSF Required parameter", "$ref": "#/components/schemas/GenericBoolean" }, "txThresholdForOutput": { "description": "Minimum number of settled pacs.008 /pacs.004 and valid camt.056/camt.029 transactions which trigger the generation of output files at relevant intervals. The parameter is applicable to SCF and RSF files.", "$ref": "#/components/schemas/StandardInteger" }, "extendedPSR": { "description": "The value set for Extended PSR parameter", "$ref": "#/components/schemas/GenericBoolean" }, "acceptanceDateAO1": { "description": "The value set for AO1 parameter", "$ref": "#/components/schemas/GenericBoolean" }, "remittanceInformationERI": { "description": "The value set for ERI parameter", "$ref": "#/components/schemas/GenericBoolean" }, "nonTargetDaySettlement": { "description": "The value set for NTD parameter", "$ref": "#/components/schemas/GenericBoolean" }, "allowedPCF": { "description": "The value set for Allowed PCF parameter", "$ref": "#/components/schemas/GenericBoolean" }, "maxReceivingFileSize": { "description": "The value set for Max Receiving File Size", "$ref": "#/components/schemas/StandardInteger" }, "defaultThresholdValue": { "description": "The value set for Default Threshold Value", "$ref": "#/components/schemas/StandardAmount1" }, "swiftNetOutputFileCompression": { "description": "The value set for Swiftnet Output File Compression", "$ref": "#/components/schemas/GenericBoolean" }, "priNetworkIdentification": { "description": "The value set for Primary Network Identification", "$ref": "#/components/schemas/NetworkIdentification1" }, "secNetworkIdentification": { "description": "The value set for Secondary Network Identification", "$ref": "#/components/schemas/NetworkIdentification1" }, "priReceivingNetIdentification": { "description": "The value set for Primary Receiving Network Identification", "$ref": "#/components/schemas/NetworkIdentificationSendingReceiving" }, "secReceivingNetIdentification": { "description": "The value set for Secondary Receiving Network Identification", "$ref": "#/components/schemas/NetworkIdentificationSendingReceiving" }, "priSendingNetIdentification": { "description": "The value set for Primary Sending Network Identification", "$ref": "#/components/schemas/NetworkIdentificationSendingReceiving" }, "SecSendingNetIdentification": { "description": "The value set for Secondary Sending Network Identification", "$ref": "#/components/schemas/NetworkIdentificationSendingReceiving" }, "T2RTGSAuthorisedAccountUserAAUForAS-D": { "description": "The BIC11 of the T2-RTGS DCA for settlement of STEP2 transactions. It must be declared at TARGET Level as Authorized Account User BIC of the T2-RTGS DCA used for AS-D", "$ref": "#/components/schemas/Bic11Only" }, "T2RTGSAuthorisedAccountUserAAUForAS-E": { "description": "The BIC11 of the T2-RTGS Dedicated Cash Account (DCA) for remuneration process.", "$ref": "#/components/schemas/Bic11Only" }, "T2RTGSDedicatedCashAccountDCAForAS-D": { "description": "The T2-RTGS Dedicated Cash Account (DCA) used by a Participant for funding/defunding CGS position (with Ancillary System AS-D). It is the Account registered with STEP2 Settlement Bank Account Group (as registered in T2 CRDM Registration form).", "$ref": "#/components/schemas/DedicatedCashAccount" }, "T2RTGSDedicatedCashAccountDCAForAS-E": { "description": "T2-RTGS Dedicated Cash Account (DCA) used by a Participant for remuneration process (with Ancillary System AS-E).", "$ref": "#/components/schemas/DedicatedCashAccount" } }, "required": [ "T2RTGSAuthorisedAccountUserAAUForAS-D", "T2RTGSDedicatedCashAccountDCAForAS-D" ] }, "DPRBOperation": { "type": "string", "enum": [ "DIR", "IND" ], "examples": [ "DIR" ] }, "DPRBOperation1": { "type": "string", "enum": [ "DIR", "IND" ], "maxLength": 3, "examples": [ "DIR" ] }, "EndOfList": { "description": "End of list indicator.", "type": "boolean", "examples": [ true ] }, "EndToEndId": { "description": "End-to-end identifications.", "type": "string", "maxLength": 35, "examples": [ "20180501183030100000774727992319111" ] }, "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" ] }, "EventDescription": { "description": "Event description.", "type": "string", "maxLength": 150, "examples": [ "INDIRECT PARTICIPANT INPART001 IS NOT PRESENT" ] }, "EventType": { "description": "Event type.", "type": "string", "enum": [ "SEC", "FTL", "ERR", "WRN", "NOR" ], "examples": [ "WRN" ] }, "FileCVF": { "type": "object", "properties": { "fileType": { "description": "The file type=CVF", "$ref": "#/components/schemas/FileType" }, "receiverBIC": { "description": "The BIC of the receiving DP", "$ref": "#/components/schemas/BIC8" }, "businessDate": { "description": "The business date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The calendar date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "fileReference": { "description": "The relevant file reference", "$ref": "#/components/schemas/FileReference" }, "dateTime": { "description": "The date and time of the creation of the file", "$ref": "#/components/schemas/DateTime" }, "networkFileName": { "description": "The relevant network file name", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The network from which the file is received", "$ref": "#/components/schemas/Network1" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatusOUT" }, "reasonCode": { "description": "The error code associated to the file", "$ref": "#/components/schemas/ReasonCode" }, "lastStatusUpdate": { "description": "The last status update date and time", "$ref": "#/components/schemas/DateTime" }, "ICFFileReference": { "description": "The File Reference of the ICF", "$ref": "#/components/schemas/FileReference" }, "ICFNetworkFileName": { "description": "The network file name of the ICF", "$ref": "#/components/schemas/NetworkFileName" }, "numAcceptedBulks": { "description": "The number of bulk accepted", "$ref": "#/components/schemas/StandardInteger" }, "numRejectedBulks": { "description": "The number of bulk rejected", "$ref": "#/components/schemas/StandardInteger" }, "numAcceptedPayments": { "description": "The number of Payments accepted", "$ref": "#/components/schemas/StandardInteger" }, "valAcceptedPayments": { "description": "The value of Payments accepted", "$ref": "#/components/schemas/StandardAmount1" }, "numRejectedPayments": { "description": "The number of Payments rejected", "$ref": "#/components/schemas/StandardInteger" }, "valRejectedPayments": { "description": "The value of Payments rejected", "$ref": "#/components/schemas/StandardAmount1" }, "numAcceptedReturns": { "description": "The number of Returns accepted", "$ref": "#/components/schemas/StandardInteger" }, "valAcceptedReturns": { "description": "The value of Returns accepted", "$ref": "#/components/schemas/StandardAmount1" }, "numRejectedReturns": { "description": "The number of Returns rejected", "$ref": "#/components/schemas/StandardInteger" }, "valRejectedReturns": { "description": "The value of Returns rejected", "$ref": "#/components/schemas/StandardAmount1" }, "numAcceptedPCR": { "description": "The number of PCR accepted", "$ref": "#/components/schemas/StandardInteger" }, "valAcceptedPCR": { "description": "The value of PCR accepted", "$ref": "#/components/schemas/StandardAmount1" }, "numRejectedPCR": { "description": "The number of PCR rejected", "$ref": "#/components/schemas/StandardInteger" }, "valRejectedPCR": { "description": "The value of PCR rejected", "$ref": "#/components/schemas/StandardAmount1" }, "numAcceptedROI": { "description": "The number of ROI accepted", "$ref": "#/components/schemas/StandardInteger" }, "numRejectedROI": { "description": "The number ROI rejected", "$ref": "#/components/schemas/StandardInteger" }, "numRSUValidated": { "description": "The number of RSU validated", "$ref": "#/components/schemas/StandardInteger" }, "numRSURejected": { "description": "The number RSU rejected", "$ref": "#/components/schemas/StandardInteger" } }, "required": [ "fileType", "receiverBIC", "businessDate", "calendarDate", "fileReference", "dateTime", "networkFileName", "network", "fileStatus", "reasonCode", "lastStatusUpdate", "ICFNetworkFileName", "numAcceptedBulks", "numRejectedBulks", "numAcceptedPayments", "valAcceptedPayments", "numRejectedPayments", "valRejectedPayments", "numAcceptedReturns", "valAcceptedReturns", "numRejectedReturns", "valRejectedReturns", "numAcceptedPCR", "valAcceptedPCR", "numRejectedPCR", "valRejectedPCR", "numAcceptedROI", "numRejectedROI", "numRSUValidated", "numRSURejected" ] }, "FileDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "fileRef": { "$ref": "#/components/schemas/FileRef" } }, "required": [ "dateTime", "fileRef" ] }, "FileDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "fileCVF": { "description": "The information related to the Credit Validation File", "$ref": "#/components/schemas/FileCVF" }, "fileDRR": { "description": "The information related to the Daily Reconciliation Report", "$ref": "#/components/schemas/FileDRR" }, "fileICF": { "description": "The information related to the Input Credit Transfer File", "$ref": "#/components/schemas/FileICF" }, "fileIQF": { "description": "The information related to the Input Inquiry File", "$ref": "#/components/schemas/FileIQF" }, "fileMSR": { "description": "The information related to the Monthly Statistical Report", "$ref": "#/components/schemas/FileMSR" }, "fileNRR": { "description": "The information related to the Monthly Reconciliation Report", "$ref": "#/components/schemas/FileNRR" }, "fileOQF": { "description": "The information related to the Output Inquiry File", "$ref": "#/components/schemas/FileOQF" }, "filePCF": { "description": "The information related to the Payment Cancellation File", "$ref": "#/components/schemas/FilePCF" }, "filePSR": { "description": "The information related to the Pre-Settlement Report File", "$ref": "#/components/schemas/FilePCF" }, "fileQVF": { "description": "The information related to the Inquiry Validation File", "$ref": "#/components/schemas/FileQVF" }, "fileRTF": { "description": "The information related to the Routing Table File", "$ref": "#/components/schemas/FileRTF" }, "fileSCF": { "description": "The information related to the Settled Credit File", "$ref": "#/components/schemas/FileSCF" }, "fileIGF": { "description": "The information related to Input Get File", "$ref": "#/components/schemas/FileIGF" }, "fileOGF": { "$ref": "#/components/schemas/FileOGF" }, "fileRSF": { "$ref": "#/components/schemas/FileRSF" } }, "required": [ "dateTime" ] }, "FileDRR": { "type": "object", "properties": { "fileType": { "description": "The file type=DRR", "$ref": "#/components/schemas/FileType" }, "receiverBIC": { "description": "The BIC of the receiving DP", "$ref": "#/components/schemas/BIC8" }, "businessDate": { "description": "The business date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The calendar date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "fileReference": { "description": "The file reference", "$ref": "#/components/schemas/FileReference" }, "dateTime": { "description": "The date and time of the creation of the file", "$ref": "#/components/schemas/DateTime" }, "networkFileName": { "description": "The relevant network file name", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The network from which the file is received", "$ref": "#/components/schemas/Network1" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatusOUT" }, "lastStatusUpdate": { "description": "The last status update date and time", "$ref": "#/components/schemas/DateTime" }, "recordType": { "description": "The record type", "$ref": "#/components/schemas/RecordType" }, "totalNumberRecords": { "description": "The total number of records", "$ref": "#/components/schemas/StandardInteger" }, "numFilesSent": { "description": "The number of files sent", "$ref": "#/components/schemas/StandardInteger" }, "numBulksSent": { "description": "The number of bulks sent", "$ref": "#/components/schemas/StandardInteger" }, "numFilesReject": { "description": "The number of files rejected", "$ref": "#/components/schemas/StandardInteger" }, "numBulksRejected": { "description": "The number of bulks rejected", "$ref": "#/components/schemas/StandardInteger" }, "numBulksCRTSent": { "description": "The number of CRT bulks sent", "$ref": "#/components/schemas/StandardInteger" }, "numBulksCRTRejected": { "description": "The number of CRT bulks rejected", "$ref": "#/components/schemas/StandardInteger" }, "numBulksReturnSent": { "description": "The number of Return bulks sent", "$ref": "#/components/schemas/StandardInteger" }, "numBulksReturnRejected": { "description": "The number of Return bulks rejected", "$ref": "#/components/schemas/StandardInteger" }, "numBulksPCRSent": { "description": "The number of PCR bulks sent", "$ref": "#/components/schemas/StandardInteger" }, "numBulksPCRRejected": { "description": "The number of PCR bulks rejected", "$ref": "#/components/schemas/StandardInteger" }, "numBulksROISent": { "description": "The number of ROI bulks sent", "$ref": "#/components/schemas/StandardInteger" }, "numBulksROIRejected": { "description": "The number of ROI bulks rejected", "$ref": "#/components/schemas/StandardInteger" }, "numBulksRSUSent": { "description": "The number of RSU bulks sent", "$ref": "#/components/schemas/StandardInteger" }, "numBulksRSURejected": { "description": "The number of RSU bulks rejected", "$ref": "#/components/schemas/StandardInteger" }, "numCreditTransfersSent": { "description": "The number of Credit Transfers sent", "$ref": "#/components/schemas/StandardInteger" }, "valCreditTransfersSent": { "description": "The value of Credit Transfers sent", "$ref": "#/components/schemas/StandardAmount1" }, "numCreditTransfersRejected": { "description": "The number of Credit Transfers rejected", "$ref": "#/components/schemas/StandardInteger" }, "valCreditTransfersRejected": { "description": "The value of Credit Transfers rejected", "$ref": "#/components/schemas/StandardAmount1" }, "numCreditTransfersHeld": { "description": "The number of Credit Transfers held", "$ref": "#/components/schemas/StandardInteger" }, "valCreditTransfersHeld": { "description": "The value of Credit Transfers held", "$ref": "#/components/schemas/StandardAmount1" }, "numCreditTransfersCancelled": { "description": "The number of Credit Transfers cancelled", "$ref": "#/components/schemas/StandardInteger" }, "valCreditTransfersCancelled": { "description": "The value of Credit Transfers cancelled", "$ref": "#/components/schemas/StandardAmount1" }, "numCreditTransfersSettled": { "description": "The number of Credit Transfers settled", "$ref": "#/components/schemas/StandardInteger" }, "valCreditTransfersSettled": { "description": "The value of Credit Transfers settled", "$ref": "#/components/schemas/StandardAmount1" }, "numReturnsSent": { "description": "The number of Returns sent", "$ref": "#/components/schemas/StandardInteger" }, "valReturnsSent": { "description": "The value of Returns sent", "$ref": "#/components/schemas/StandardAmount1" }, "numReturnsRejected": { "description": "The number of Returns rejected", "$ref": "#/components/schemas/StandardInteger" }, "valReturnsRejected": { "description": "The value of Returns rejected", "$ref": "#/components/schemas/StandardAmount1" }, "numReturnsHeld": { "description": "The number of Returns held", "$ref": "#/components/schemas/StandardInteger" }, "valReturnsHeld": { "description": "The value of Returns held", "$ref": "#/components/schemas/StandardAmount1" }, "numReturnsCancelled": { "description": "The number of Returns cancelled", "$ref": "#/components/schemas/StandardInteger" }, "valReturnsCancelled": { "description": "The value of Returns cancelled", "$ref": "#/components/schemas/StandardAmount1" }, "numReturnsSettled": { "description": "The number of Returns settled", "$ref": "#/components/schemas/StandardInteger" }, "valReturnsSettled": { "description": "The value of Returns settled", "$ref": "#/components/schemas/StandardAmount1" }, "numPCRSent": { "description": "The number of PCR sent", "$ref": "#/components/schemas/StandardInteger" }, "valPCRSent": { "description": "The value of PCR sent", "$ref": "#/components/schemas/StandardAmount1" }, "numROISent": { "description": "The number of ROI sent", "$ref": "#/components/schemas/StandardInteger" }, "numRSUSent": { "description": "The number of RSU sent", "$ref": "#/components/schemas/StandardInteger" }, "numPCRRejected": { "description": "The number of PCR rejected", "$ref": "#/components/schemas/StandardInteger" }, "valPCRRejected": { "description": "The value of PCR rejected", "$ref": "#/components/schemas/StandardAmount1" }, "numROIRejected": { "description": "The number of ROI rejected", "$ref": "#/components/schemas/StandardInteger" }, "numRSURejected": { "description": "The number of RSU rejected", "$ref": "#/components/schemas/StandardInteger" } }, "required": [ "fileType", "receiverBIC", "businessDate", "calendarDate", "fileReference", "dateTime", "networkFileName", "network", "fileStatus", "lastStatusUpdate", "recordType", "totalNumberRecords", "numFilesSent", "numBulksSent", "numFilesReject", "numBulksRejected", "numBulksCRTSent", "numBulksCRTRejected", "numBulksReturnSent", "numBulksReturnRejected", "numBulksPCRSent", "numBulksPCRRejected", "numBulksROISent", "numBulksROIRejected", "numBulksRSUSent", "numBulksRSURejected", "numCreditTransfersSent", "valCreditTransfersSent", "numCreditTransfersRejected", "valCreditTransfersRejected", "numCreditTransfersHeld", "valCreditTransfersHeld", "numCreditTransfersCancelled", "valCreditTransfersCancelled", "numCreditTransfersSettled", "valCreditTransfersSettled", "numReturnsSent", "valReturnsSent", "numReturnsRejected", "valReturnsRejected", "numReturnsHeld", "valReturnsHeld", "numReturnsCancelled", "valReturnsCancelled", "numReturnsSettled", "valReturnsSettled", "numPCRSent", "valPCRSent", "numROISent", "numRSUSent", "numPCRRejected", "valPCRRejected", "numROIRejected", "numRSURejected" ] }, "FileICF": { "type": "object", "properties": { "fileType": { "description": "The file type=ICF", "$ref": "#/components/schemas/FileType" }, "senderBIC": { "description": "The BIC of the sending DP", "$ref": "#/components/schemas/BIC8" }, "businessDate": { "description": "The business date when the file was received by the Central System", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The calendar date when the file was received by the Central System", "$ref": "#/components/schemas/Date" }, "fileReference": { "description": "The file reference\nNot present in case of ICF rejected with error code “R10”", "$ref": "#/components/schemas/FileReference" }, "dateTime": { "description": "The date and time of the reception of the file", "$ref": "#/components/schemas/DateTime" }, "networkFileName": { "description": "The relevant network file name", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The network from which the file is received or sent", "$ref": "#/components/schemas/Network1" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatusINP" }, "reasonCode": { "description": "The validation reason code", "$ref": "#/components/schemas/ReasonCode" }, "processingTime": { "description": "The processing date and time of the file", "$ref": "#/components/schemas/DateTime" }, "CVFFileReference": { "description": "The file reference of the relevant CVF", "$ref": "#/components/schemas/FileReference" }, "CVFNetworkfilename": { "description": "The network file name of the relevant CVF", "$ref": "#/components/schemas/NetworkFileName" }, "numBulksValidated": { "description": "The number of bulk validated", "$ref": "#/components/schemas/StandardInteger" }, "numBulksRejected": { "description": "The number of bulk rejected", "$ref": "#/components/schemas/StandardInteger" }, "numPaymentsValidated": { "description": "The number of Payments validated", "$ref": "#/components/schemas/StandardInteger" }, "valPaymentsValidated": { "description": "The value of Payments validated", "$ref": "#/components/schemas/StandardAmount1" }, "numPaymentsRejected": { "description": "The number of Payments rejected", "$ref": "#/components/schemas/StandardInteger" }, "valPaymentsRejected": { "description": "The value of Payments rejected", "$ref": "#/components/schemas/StandardAmount1" }, "numReturnsValidated": { "description": "The number of Returns validated", "$ref": "#/components/schemas/StandardInteger" }, "valReturnsValidated": { "description": "The value of Returns validated", "$ref": "#/components/schemas/StandardAmount1" }, "numReturnsRejected": { "description": "The number of Returns rejected", "$ref": "#/components/schemas/StandardInteger" }, "valReturnsRejected": { "description": "The value of Returns rejected", "$ref": "#/components/schemas/StandardAmount1" }, "numPCRValidated": { "description": "The number of PCR validated", "$ref": "#/components/schemas/StandardInteger" }, "valPCRValidated": { "description": "The value of PCR validated", "$ref": "#/components/schemas/StandardAmount1" }, "numPCRRejected": { "description": "The number of PCR rejected", "$ref": "#/components/schemas/StandardInteger" }, "valPCRRejected": { "description": "The value of PCR rejected", "$ref": "#/components/schemas/StandardAmount1" }, "numROIValidated": { "description": "The number of ROI validated", "$ref": "#/components/schemas/StandardInteger" }, "numROIRejected": { "description": "The number ROI rejected", "$ref": "#/components/schemas/StandardInteger" }, "numRSUValidated": { "description": "The number of RSU validated", "$ref": "#/components/schemas/StandardInteger" }, "numRSURejected": { "description": "The number RSU rejected", "$ref": "#/components/schemas/StandardInteger" } }, "required": [ "fileType", "senderBIC", "businessDate", "calendarDate", "dateTime", "networkFileName", "network", "fileStatus", "processingTime", "CVFFileReference", "CVFNetworkfilename", "numBulksValidated", "numBulksRejected", "numPaymentsValidated", "valPaymentsValidated", "numPaymentsRejected", "valPaymentsRejected", "numReturnsValidated", "valReturnsValidated", "numReturnsRejected", "valReturnsRejected", "numPCRValidated", "valPCRValidated", "numPCRRejected", "valPCRRejected", "numROIValidated", "numROIRejected", "numRSUValidated", "numRSURejected" ] }, "FileIGF": { "type": "object", "properties": { "fileType": { "description": "The relevant file type - set to IGF", "$ref": "#/components/schemas/FileType" }, "senderBIC": { "description": "The BIC of the DP sending the file", "$ref": "#/components/schemas/BIC8" }, "businessDate": { "description": "The business date of file’s processing", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The calendar date of file’s processing", "$ref": "#/components/schemas/Date" }, "IGFFileRef": { "description": "The DP-generated Sender’s File Reference for this file", "$ref": "#/components/schemas/FileReference" }, "dateTime": { "description": "The date & time when the file was received by STEP2 Central System", "$ref": "#/components/schemas/DateTime" }, "IGFNetworkFileName": { "description": "The name of this file as it crossed the network", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The Network from which the file IGF is received by STEP2", "$ref": "#/components/schemas/Network1" }, "fileStatus": { "description": "The Status of the IGF. Possible values are:\nRCV - Received; the file was received from the network;\nVAL - Accepted: the file has been validated and at least one transaction was accepted; or\nRJT – Rejected: the file was entirely rejected.", "$ref": "#/components/schemas/FileStatusINP" }, "reasonCode": { "description": "The Reason Code associated to file, resulting from the validation process", "$ref": "#/components/schemas/ReasonCode" }, "processingTime": { "description": "The date and time at which the file was processed", "$ref": "#/components/schemas/DateTime" }, "OGFFileRef": { "description": "The File Reference of the related OGF for this file", "$ref": "#/components/schemas/FileReference" }, "OGFNetworkFileName": { "description": "The name of the related OGF of this file as it crossed the network", "$ref": "#/components/schemas/NetworkFileName" }, "numGetAccountValidated": { "description": "The total number of Get Account validated in this file", "$ref": "#/components/schemas/StandardInteger" }, "numGetAccountRejected": { "description": "The total number of Get Account rejected in this file", "$ref": "#/components/schemas/StandardInteger" }, "numGetTransactionValidated": { "description": "The total number of Get Transaction validated in this file", "$ref": "#/components/schemas/StandardInteger" }, "numGetTransactionRejected": { "description": "The total number of Get Transaction rejected in this file", "$ref": "#/components/schemas/StandardInteger" } }, "required": [ "fileType", "senderBIC", "businessDate", "calendarDate", "IGFFileRef", "dateTime", "IGFNetworkFileName", "network", "fileStatus", "reasonCode", "processingTime", "OGFFileRef", "OGFNetworkFileName" ] }, "FileIQF": { "type": "object", "properties": { "fileType": { "description": "The file type=IQF", "$ref": "#/components/schemas/FileType" }, "senderBIC": { "description": "The BIC of the sending DP", "$ref": "#/components/schemas/BIC8" }, "businessDate": { "description": "The business date when the file was received by the Central System", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The calendar date when the file was received by the Central System", "$ref": "#/components/schemas/Date" }, "fileReference": { "description": "The file reference\nNot present in case of IQF rejected with error code “R10”", "$ref": "#/components/schemas/FileReference" }, "dateTime": { "description": "The Date and Time of the reception of the file", "$ref": "#/components/schemas/DateTime" }, "networkFileName": { "description": "The relevant network file name", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The network from which the file is received or sent", "$ref": "#/components/schemas/Network1" }, "fileStatus": { "description": "The status of the file.", "$ref": "#/components/schemas/FileStatusINP" }, "reasonCode": { "description": "The validation reason code", "$ref": "#/components/schemas/ReasonCode" }, "processingTime": { "description": "The processing date and time", "$ref": "#/components/schemas/DateTime" }, "QVFFileReference": { "description": "The file reference of the relevant QVF", "$ref": "#/components/schemas/FileReference" }, "QVFNetworkfilename": { "description": "The network file name of the relevant QVF", "$ref": "#/components/schemas/NetworkFileName" }, "numBulksValidated": { "description": "The number of bulk validated", "$ref": "#/components/schemas/StandardInteger" }, "numBulksRejected": { "description": "The number of bulk rejected", "$ref": "#/components/schemas/StandardInteger" }, "numCNRValidated": { "description": "The number of CNR validated", "$ref": "#/components/schemas/StandardInteger" }, "numCNRRejected": { "description": "The number of CNR rejected", "$ref": "#/components/schemas/StandardInteger" }, "numRMPValidated": { "description": "The number of RMP validated", "$ref": "#/components/schemas/StandardInteger" }, "numRMPRejected": { "description": "The number RMP rejected", "$ref": "#/components/schemas/StandardInteger" }, "numROIValidated": { "description": "The number of ROI validated", "$ref": "#/components/schemas/StandardInteger" }, "numROIRejected": { "description": "The number of ROI rejected", "$ref": "#/components/schemas/StandardInteger" }, "numRSUValidated": { "description": "The number of RSU validated", "$ref": "#/components/schemas/StandardInteger" }, "numRSURejected": { "description": "The number of RSU rejected", "$ref": "#/components/schemas/StandardInteger" } }, "required": [ "fileType", "senderBIC", "businessDate", "calendarDate", "dateTime", "networkFileName", "network", "fileStatus", "processingTime", "QVFFileReference", "QVFNetworkfilename", "numBulksValidated", "numBulksRejected", "numCNRValidated", "numCNRRejected", "numRMPValidated", "numRMPRejected", "numROIValidated", "numROIRejected", "numRSUValidated", "numRSURejected" ] }, "FileMSR": { "type": "object", "properties": { "fileType": { "description": "The file type=MSR", "$ref": "#/components/schemas/FileType" }, "receiverBIC": { "description": "The BIC of the receiving DP", "$ref": "#/components/schemas/BIC8" }, "businessDate": { "description": "The business date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The calendar date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "fileReference": { "description": "The file reference", "$ref": "#/components/schemas/FileReference" }, "dateTime": { "description": "The Date and Time of the reception of the file", "$ref": "#/components/schemas/DateTime" }, "networkFileName": { "description": "The relevant network file name", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The network from which the file is received or sent", "$ref": "#/components/schemas/Network1" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatusOUT" }, "lastStatusUpdate": { "description": "The last status update date and time", "$ref": "#/components/schemas/DateTime" }, "recordType": { "description": "The record type", "$ref": "#/components/schemas/RecordType" }, "totalNumberRecords": { "description": "The total number of records", "$ref": "#/components/schemas/StandardInteger" }, "numCreditTransfersSent": { "description": "The number of Credit Transfers sent", "$ref": "#/components/schemas/StandardInteger" }, "numCreditTransfersRejected": { "description": "The number of Credit Transfers rejected", "$ref": "#/components/schemas/StandardInteger" }, "numCreditTransfersCancelled": { "description": "The number of Credit Transfers cancelled", "$ref": "#/components/schemas/StandardInteger" }, "numCreditTransfersSettled": { "description": "The number of Credit Transfers settled", "$ref": "#/components/schemas/StandardInteger" }, "numReturnsSent": { "description": "The number of Returns sent", "$ref": "#/components/schemas/StandardInteger" }, "numReturnsRejected": { "description": "The number of Returns rejected", "$ref": "#/components/schemas/StandardInteger" }, "numReturnsCancelled": { "description": "The number of Returns cancelled", "$ref": "#/components/schemas/StandardInteger" }, "numReturnsSettled": { "description": "The number of Returns settled", "$ref": "#/components/schemas/StandardInteger" }, "numPCRSent": { "description": "The number of PCR sent", "$ref": "#/components/schemas/StandardInteger" }, "numPCRRejected": { "description": "The number of PCR rejected", "$ref": "#/components/schemas/StandardInteger" }, "numROISent": { "description": "The number of ROI sent", "$ref": "#/components/schemas/StandardInteger" }, "numROIRejected": { "description": "The number of ROI rejected", "$ref": "#/components/schemas/StandardInteger" }, "numRSUSent": { "description": "The number of RSU sent", "$ref": "#/components/schemas/StandardInteger" }, "numRSURejected": { "description": "The number of RSU rejected", "$ref": "#/components/schemas/StandardInteger" }, "valCreditTransfersSent": { "description": "The value of Credit Transfers sent", "$ref": "#/components/schemas/StandardAmount1" }, "valCreditTransfersRejected": { "description": "The value of Credit Transfers rejected", "$ref": "#/components/schemas/StandardAmount1" }, "valCreditTransfersCancelled": { "description": "The value of Credit Transfers cancelled", "$ref": "#/components/schemas/StandardAmount1" }, "valCreditTransfersSettled": { "description": "The value of Credit Transfers settled", "$ref": "#/components/schemas/StandardAmount1" }, "valReturnsSent": { "description": "The value of Returns sent", "$ref": "#/components/schemas/StandardAmount1" }, "valReturnsRejected": { "description": "The value of Returns rejected", "$ref": "#/components/schemas/StandardAmount1" }, "valReturnsCancelled": { "description": "The value of Returns cancelled", "$ref": "#/components/schemas/StandardAmount1" }, "valReturnsSettled": { "description": "The value of Returns settled", "$ref": "#/components/schemas/StandardAmount1" }, "valPCRSent": { "description": "The value of PCR sent", "$ref": "#/components/schemas/StandardAmount1" }, "valPCRRejected": { "description": "The value of PCR rejected", "$ref": "#/components/schemas/StandardAmount1" } }, "required": [ "fileType", "receiverBIC", "businessDate", "calendarDate", "fileReference", "dateTime", "networkFileName", "network", "fileStatus", "lastStatusUpdate", "recordType", "totalNumberRecords", "numCreditTransfersSent", "numCreditTransfersRejected", "numCreditTransfersCancelled", "numCreditTransfersSettled", "numReturnsSent", "numReturnsRejected", "numReturnsCancelled", "numReturnsSettled", "numPCRSent", "numPCRRejected", "numROISent", "numROIRejected", "numRSUSent", "numRSURejected", "valCreditTransfersSent", "valCreditTransfersRejected", "valCreditTransfersCancelled", "valCreditTransfersSettled", "valReturnsSent", "valReturnsRejected", "valReturnsCancelled", "valReturnsSettled", "valPCRSent", "valPCRRejected" ] }, "FileNRR": { "type": "object", "properties": { "fileType": { "description": "The file type=NRR", "$ref": "#/components/schemas/FileType" }, "receiverBIC": { "description": "The BIC of the receiving DP", "$ref": "#/components/schemas/BIC8" }, "businessDate": { "description": "The business date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The calendar date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "fileReference": { "description": "The relevant file reference", "$ref": "#/components/schemas/FileReference" }, "dateTime": { "description": "The Date and Time of the creation of the file", "$ref": "#/components/schemas/DateTime" }, "networkFileName": { "description": "The relevant network file name", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The network from which the file is sent", "$ref": "#/components/schemas/Network1" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatusOUT" }, "lastStatusUpdate": { "description": "The last status update date and time", "$ref": "#/components/schemas/DateTime" }, "recordType": { "description": "The record type", "$ref": "#/components/schemas/RecordType" }, "totalNumberRecords": { "description": "The total number of records", "$ref": "#/components/schemas/StandardInteger" }, "numCNRSent": { "description": "The number of CNR sent", "$ref": "#/components/schemas/StandardInteger" }, "numCNRRejected": { "description": "The number of CNR rejected", "$ref": "#/components/schemas/StandardInteger" }, "numRMPSent": { "description": "The number of RMP sent", "$ref": "#/components/schemas/StandardInteger" }, "numRMPRejected": { "description": "The number of RMP rejected", "$ref": "#/components/schemas/StandardInteger" }, "numROISent": { "description": "The number of ROI sent", "$ref": "#/components/schemas/StandardInteger" }, "numROIRejected": { "description": "The number of ROI rejected", "$ref": "#/components/schemas/StandardInteger" }, "numRSUSent": { "description": "The number of RSU sent", "$ref": "#/components/schemas/StandardInteger" }, "numRSURejected": { "description": "The number of RSU rejected", "$ref": "#/components/schemas/StandardInteger" } }, "required": [ "fileType", "receiverBIC", "businessDate", "calendarDate", "fileReference", "dateTime", "networkFileName", "network", "fileStatus", "lastStatusUpdate", "recordType", "totalNumberRecords", "numCNRSent", "numCNRRejected", "numRMPSent", "numRMPRejected", "numROISent", "numROIRejected", "numRSUSent", "numRSURejected" ] }, "FileOGF": { "type": "object", "properties": { "fileType": { "description": "The relevant file type - set to OGF", "$ref": "#/components/schemas/FileType" }, "receiverBIC": { "description": "The BIC of the DP receiving this file", "$ref": "#/components/schemas/BIC8" }, "businessDate": { "description": "The Business Date related to File’s generation", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The Calendar Date related to File’s generation", "$ref": "#/components/schemas/Date" }, "OGFFileRef": { "description": "The reference of the file generated by STEP2", "$ref": "#/components/schemas/FileReference" }, "dateTime": { "description": "The date & time when the file was sent by STEP2 Central System", "$ref": "#/components/schemas/DateTime" }, "OGFNetworkFileName": { "description": "The name of this file as it crossed the network", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The network through which the file is sent to the DP by STEP2", "$ref": "#/components/schemas/Network1" }, "fileStatus": { "description": "The Status of the File. Possible values are:\nTSG - Transmitting: the file has been created and not yet sent, or it’s in the process of being transmitted\nTSD – Transmitted: the file has been sent; or\nERR - Error: the file has not been positively sent;\nRNS – Retransmitted: the file has been retransmitted", "$ref": "#/components/schemas/FileStatusOUT" }, "reasonCode": { "description": "The Reason code of the file resulting from the validation process", "$ref": "#/components/schemas/ReasonCode" }, "lastStatusUpdated": { "description": "The last update of the status of the file", "$ref": "#/components/schemas/DateTime" }, "IGFFileRef": { "description": "The reference of the IGF file related to this OGF", "$ref": "#/components/schemas/FileReference" }, "IGFNetworkFileName": { "description": "The network file name of IGF file related to this OGF", "$ref": "#/components/schemas/NetworkFileName" }, "numGetAccountValidated": { "description": "The total number of Get Account validated in this file", "$ref": "#/components/schemas/StandardInteger" }, "numGetAccountRejected": { "description": "The total number of Get Account rejected in this file", "$ref": "#/components/schemas/StandardInteger" }, "numGetTransactionValidated": { "description": "The total number of Get Transaction validated in this file", "$ref": "#/components/schemas/StandardInteger" }, "numGetTransactionRejected": { "description": "The total number of Get Transaction rejected in this file", "$ref": "#/components/schemas/StandardInteger" } }, "required": [ "fileType", "receiverBIC", "businessDate", "calendarDate", "OGFFileRef", "dateTime", "OGFNetworkFileName", "network", "fileStatus", "reasonCode", "lastStatusUpdated", "IGFNetworkFileName" ] }, "FileOQF": { "type": "object", "properties": { "fileType": { "description": "The file type=OQF", "$ref": "#/components/schemas/FileType" }, "receiverBIC": { "description": "The BIC of the receiving DP", "$ref": "#/components/schemas/BIC8" }, "businessDate": { "description": "The business date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The calendar date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "lac": { "description": "The LAC to which the file is related", "$ref": "#/components/schemas/Lac" }, "fileReference": { "description": "The reference of file", "$ref": "#/components/schemas/FileReference" }, "dateTime": { "description": "The Date and Time of the creation of the file", "$ref": "#/components/schemas/DateTime" }, "networkFileName": { "description": "The relevant network file name", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The network from which the file is sent", "$ref": "#/components/schemas/Network1" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatusOUT" }, "lastStatusUpdate": { "description": "The last status update date and time", "$ref": "#/components/schemas/DateTime" }, "numBulksContained": { "description": "The number of bulk contained", "$ref": "#/components/schemas/StandardInteger" }, "numCNR": { "description": "The number of CNR", "$ref": "#/components/schemas/StandardInteger" }, "numRMP": { "description": "The number of RMP", "$ref": "#/components/schemas/StandardInteger" }, "numROI": { "description": "The number of ROI", "$ref": "#/components/schemas/StandardInteger" }, "numRSU": { "description": "The number of RSU", "$ref": "#/components/schemas/StandardInteger" } }, "required": [ "fileType", "receiverBIC", "businessDate", "calendarDate", "fileReference", "dateTime", "networkFileName", "network", "fileStatus", "lastStatusUpdate", "numBulksContained", "numCNR", "numRMP", "numROI", "numRSU" ] }, "FilePCF": { "type": "object", "properties": { "fileType": { "description": "The file type=PCF", "$ref": "#/components/schemas/FileType" }, "receiverBIC": { "description": "The BIC of the receiving DP", "$ref": "#/components/schemas/BIC8" }, "businessDate": { "description": "The business date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The calendar date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "lac": { "description": "The LAC to which the file is related", "$ref": "#/components/schemas/Lac" }, "fileReference": { "description": "The reference of file", "$ref": "#/components/schemas/FileReference" }, "dateTime": { "description": "The Date and Time of the creation of the file", "$ref": "#/components/schemas/DateTime" }, "networkFileName": { "description": "The relevant network file name", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The network from which the file is sent", "$ref": "#/components/schemas/Network1" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatusOUT" }, "lastStatusUpdate": { "description": "The last status update date and time", "$ref": "#/components/schemas/DateTime" } }, "required": [ "fileType", "receiverBIC", "businessDate", "calendarDate", "fileReference", "dateTime", "networkFileName", "network", "fileStatus", "lastStatusUpdate" ] }, "FileQVF": { "type": "object", "properties": { "fileType": { "description": "The file type=QVF", "$ref": "#/components/schemas/FileType" }, "receiverBIC": { "description": "The BIC of the receiving DP", "$ref": "#/components/schemas/BIC8" }, "businessDate": { "description": "The business date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The calendar date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "fileReference": { "description": "The file reference", "$ref": "#/components/schemas/FileReference" }, "dateTime": { "description": "The Date and Time of the creation of the file", "$ref": "#/components/schemas/DateTime" }, "networkFileName": { "description": "The relevant network file name", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The network from which the file is sent", "$ref": "#/components/schemas/Network1" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatusOUT" }, "reasonCode": { "description": "The validation reason code", "$ref": "#/components/schemas/ReasonCode" }, "lastStatusUpdate": { "description": "The last status update date and time", "$ref": "#/components/schemas/DateTime" }, "IQFFileReference": { "description": "The File Reference of the IQF", "$ref": "#/components/schemas/FileReference" }, "IQFNetworkfilename": { "description": "The network file name of the IQF", "$ref": "#/components/schemas/NetworkFileName" }, "numBulksAccepted": { "description": "The number of bulk accepted", "$ref": "#/components/schemas/StandardInteger" }, "numBulksRejected": { "description": "The number of bulk rejected", "$ref": "#/components/schemas/StandardInteger" }, "numCNRValidated": { "description": "The number of CNR validated", "$ref": "#/components/schemas/StandardInteger" }, "numCNRRejected": { "description": "The number of CNR rejected", "$ref": "#/components/schemas/StandardInteger" }, "numRMPValidated": { "description": "The number of RMP validated", "$ref": "#/components/schemas/StandardInteger" }, "numRMPRejected": { "description": "The number of RMP rejected", "$ref": "#/components/schemas/StandardInteger" }, "numROIValidated": { "description": "The number of ROI validated", "$ref": "#/components/schemas/StandardInteger" }, "numROIRejected": { "description": "The number of ROI rejected", "$ref": "#/components/schemas/StandardInteger" }, "numRSUValidated": { "description": "The number of RSU validated", "$ref": "#/components/schemas/StandardInteger" }, "numRSURejected": { "description": "The number of RSU rejected", "$ref": "#/components/schemas/StandardInteger" } }, "required": [ "fileType", "receiverBIC", "businessDate", "calendarDate", "fileReference", "dateTime", "networkFileName", "network", "fileStatus", "reasonCode", "lastStatusUpdate", "IQFNetworkfilename", "numBulksAccepted", "numBulksRejected", "numCNRValidated", "numCNRRejected", "numRMPValidated", "numRMPRejected", "numROIValidated", "numROIRejected", "numRSUValidated", "numRSURejected" ] }, "FileRef": { "type": "object", "properties": { "fileType": { "description": "The file type\n\n **Validation Rule(s)** It must be set with one of the allowed values\n(errorCode SC01)", "$ref": "#/components/schemas/FileType" }, "fileStatus": { "description": "The file status\n\n **Validation Rule(s)** It must be set with one of the allowed values\n(errorCode SC01)", "$ref": "#/components/schemas/FileStatusALL" }, "fileReference": { "description": "The file reference", "$ref": "#/components/schemas/FileReference" }, "dateTime": { "description": "The date and time of reception/sending of the file", "$ref": "#/components/schemas/DateTime" }, "networkFileName": { "description": "The network file name", "$ref": "#/components/schemas/NetworkFileName" } }, "required": [ "fileReference", "networkFileName" ] }, "FileRef1": { "type": "object", "properties": { "fileType": { "description": "The type of the file to be retransmitted\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)\n“ICF”, “IQF” and \"IGF\" values cannot be used\n(error Code XA07)", "$ref": "#/components/schemas/FileType" }, "networkFileName": { "description": "The network file name of the file to be retransmitted", "$ref": "#/components/schemas/NetworkFileName" } }, "required": [ "fileType", "networkFileName" ] }, "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" ] }, "FileRSF": { "type": "object", "properties": { "fileType": { "description": "The file type", "$ref": "#/components/schemas/FileType" }, "receiverBIC": { "description": "The BIC of the receiving DP", "$ref": "#/components/schemas/BIC8" }, "businessDate": { "description": "The business date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The calendar date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "lac": { "description": "The LAC to which the file is related", "$ref": "#/components/schemas/Lac" }, "fileReference": { "description": "The file reference", "$ref": "#/components/schemas/FileReference" }, "lacIndicator": { "description": "Allowed values:\n• true = the output file has been generated at LAC sending Cut-Off\n• false = the output file has been generated intra-LAC", "$ref": "#/components/schemas/GenericBoolean" }, "timeIndicator": { "description": "The time of the scheduled cut-off triggering the generation of output files intra-LAC.\nOnly available for output files generated intra-LAC, thus having LAC indicator = false", "$ref": "#/components/schemas/TimeIndicator" }, "dateTime": { "description": "The date and time of the creation of the file", "$ref": "#/components/schemas/DateTime" }, "networkFileName": { "description": "The relevant network file name", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The network from which the file is received", "$ref": "#/components/schemas/Network1" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatusOUT" }, "lastStatusUpdate": { "description": "The last status update date and time", "$ref": "#/components/schemas/DateTime" }, "numBulksContained": { "description": "The number of bulk contained", "$ref": "#/components/schemas/StandardInteger" }, "numPaymentsSettled": { "description": "The number of Payments settled", "$ref": "#/components/schemas/StandardInteger" }, "valPaymentsSettled": { "description": "The value of Payments settled", "$ref": "#/components/schemas/StandardAmount1" }, "numReturnsSettled": { "description": "The number of Returns settled", "$ref": "#/components/schemas/StandardInteger" }, "valReturnsSettled": { "description": "The value of Returns settled", "$ref": "#/components/schemas/StandardAmount1" }, "numPaymentsCancelledQueued": { "description": "The number of Payments cancelled queued", "$ref": "#/components/schemas/StandardInteger" }, "valPaymentsCancelledQueued": { "description": "The value of Payments cancelled queued", "$ref": "#/components/schemas/StandardAmount1" }, "numReturnsCancelledQueued": { "description": "The number of Returns cancelled queued", "$ref": "#/components/schemas/StandardInteger" }, "valReturnsCancelledQueued": { "description": "The value of Returns cancelled queued", "$ref": "#/components/schemas/StandardAmount1" } }, "required": [ "fileType", "receiverBIC", "businessDate", "calendarDate", "fileReference", "dateTime", "networkFileName", "network", "fileStatus", "lastStatusUpdate", "numBulksContained", "numPaymentsSettled", "valPaymentsSettled", "numReturnsSettled", "valReturnsSettled", "numPaymentsCancelledQueued", "valPaymentsCancelledQueued", "numReturnsCancelledQueued", "valReturnsCancelledQueued" ] }, "FileRTF": { "type": "object", "properties": { "fileType": { "description": "The file type=RTF", "$ref": "#/components/schemas/FileType" }, "receiverBIC": { "description": "The BIC of the receiving DP", "$ref": "#/components/schemas/BIC8" }, "businessDate": { "description": "The business date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The calendar date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "fileReference": { "description": "The file reference", "$ref": "#/components/schemas/FileReference" }, "dateTime": { "description": "The Date and Time of the creation of the file", "$ref": "#/components/schemas/DateTime" }, "networkFileName": { "description": "The network file name", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The network from which the file is sent", "$ref": "#/components/schemas/Network1" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatusOUT" }, "lastStatusUpdate": { "description": "The last status update date and time", "$ref": "#/components/schemas/DateTime" } }, "required": [ "fileType", "receiverBIC", "businessDate", "calendarDate", "fileReference", "dateTime", "networkFileName", "network", "fileStatus", "lastStatusUpdate" ] }, "Files": { "type": "object", "properties": { "fileType": { "description": "The file type", "$ref": "#/components/schemas/FileType" }, "fileReference": { "description": "The file reference", "$ref": "#/components/schemas/FileReference" }, "lac": { "description": "The LAC to which file is related.\nAvailable for “OQF”, “PCF”, “SCF”, \"RSF\" and “PSR” Output files, if the DP is configured for settling in CGS-DKK", "$ref": "#/components/schemas/Lac" }, "lacIndicator": { "description": "Allowed values:\n• true = the output file has been generated at LAC sending Cut-Off\n• false = the output file has been generated intra-LAC", "$ref": "#/components/schemas/GenericBoolean" }, "timeIndicator": { "description": "The time of the scheduled cut-off triggering the generation of output files intra-LAC.\nOnly available for output files generated intra-LAC, thus having LAC indicator = false", "$ref": "#/components/schemas/TimeIndicator" }, "dateTime": { "description": "The date time in which the file was sent/received by the CS", "$ref": "#/components/schemas/DateTime" }, "date": { "description": "The calendar or business date type in which the file was created/received by the CS", "$ref": "#/components/schemas/Date" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatusALL" }, "reasonCode": { "description": "The validation reason code of the file", "$ref": "#/components/schemas/ReasonCode" }, "lastStatusUpdate": { "description": "The Date and Time of the last update of file status (not present for ICF,IQF or IGF files)", "$ref": "#/components/schemas/DateTime" }, "originalFileReference": { "description": "The original file reference. This criterion is only relevant for “ICF”/ “IQF”/\"IGF\" and “CVF/”QVF/\"OGF\" ” files.\nIf the retrieved fileType is equal to “ICF”, ”IQF” or \"IGF\" this field contains respectively the “CVF”, ”QVF” or \"OGF\" file reference which this file relates to.\nIf the fileType is equal to “CVF”, “QVF or \"OGF\", this field contains the Sender’s File Reference respectively of the “ICF”, “IQF” or \"IGF\" which this file relates to", "$ref": "#/components/schemas/FileReference" }, "networkFileName": { "description": "The relevant network file name", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "Network from which the file is received or sent.", "$ref": "#/components/schemas/Network1" }, "numBulks": { "description": "The number of bulks included in the file", "$ref": "#/components/schemas/StandardInteger" }, "numTransactions": { "description": "The number of transactions included in the file", "$ref": "#/components/schemas/StandardInteger" }, "numMessages": { "description": "The number of messages included in the file - available for IGF and OGF", "$ref": "#/components/schemas/StandardInteger" } }, "required": [ "fileType", "dateTime", "date", "fileStatus", "networkFileName", "network" ] }, "FileSCF": { "type": "object", "properties": { "fileType": { "description": "The file type=SCF", "$ref": "#/components/schemas/FileType" }, "receiverBIC": { "description": "The BIC of the receiving DP", "$ref": "#/components/schemas/BIC8" }, "businessDate": { "description": "The business date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "calendarDate": { "description": "The calendar date when the file was sent by the Central System", "$ref": "#/components/schemas/Date" }, "lac": { "description": "The LAC to which the file is related", "$ref": "#/components/schemas/Lac" }, "lacIndicator": { "description": "Allowed values:\n• true = the output file has been generated at LAC sending Cut-Off\n• false = the output file has been generated intra-LAC", "$ref": "#/components/schemas/GenericBoolean" }, "timeIndicator": { "description": "The time of the scheduled cut-off triggering the generation of output files intra-LAC.\nOnly available for output files generated intra-LAC, thus having LAC indicator = false", "$ref": "#/components/schemas/TimeIndicator" }, "fileReference": { "description": "The file reference", "$ref": "#/components/schemas/FileReference" }, "dateTime": { "description": "The Date and Time of the creation of the file", "$ref": "#/components/schemas/DateTime" }, "networkFileName": { "description": "The network file name of the file", "$ref": "#/components/schemas/NetworkFileName" }, "network": { "description": "The network from which the file is sent", "$ref": "#/components/schemas/Network1" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatusOUT" }, "lastStatusUpdate": { "description": "The last status update date and time", "$ref": "#/components/schemas/DateTime" }, "numBulksContained": { "description": "The number of bulks contained", "$ref": "#/components/schemas/StandardInteger" }, "numPaymentsSettled": { "description": "The number of Payments settled", "$ref": "#/components/schemas/StandardInteger" }, "valPaymentsSettled": { "description": "The value of Payments settled", "$ref": "#/components/schemas/StandardAmount1" }, "numReturnsSettled": { "description": "The number of Returns settled", "$ref": "#/components/schemas/StandardInteger" }, "valReturnsSettled": { "description": "The value of Returns settled", "$ref": "#/components/schemas/StandardAmount1" }, "numPCR": { "description": "The number of PCR", "$ref": "#/components/schemas/StandardInteger" }, "valPCR": { "description": "The value of PCR", "$ref": "#/components/schemas/StandardAmount1" }, "numROI": { "description": "The number of ROI", "$ref": "#/components/schemas/StandardInteger" }, "numRSU": { "description": "The number of RSU", "$ref": "#/components/schemas/StandardInteger" } }, "required": [ "fileType", "receiverBIC", "businessDate", "calendarDate", "fileReference", "dateTime", "networkFileName", "network", "fileStatus", "lastStatusUpdate", "numBulksContained", "numPaymentsSettled", "valPaymentsSettled", "numReturnsSettled", "valReturnsSettled", "numPCR", "valPCR", "numROI", "numRSU" ] }, "FileStatusALL": { "description": "Status of the file.", "type": "string", "enum": [ "DEF", "ERR", "RCV", "RJT", "RNS", "TSD", "TSG", "VAL" ], "examples": [ "RCV" ] }, "FileStatusINP": { "description": "Status of the file ICF.", "type": "string", "enum": [ "DEF", "RCV", "RJT", "VAL" ], "examples": [ "RCV" ] }, "FileStatusOUT": { "description": "Status of the file.", "type": "string", "enum": [ "ERR", "RNS", "TSD", "TSG" ], "examples": [ "TSD" ] }, "FileStatusResentAll": { "description": "Status of the file to be resend.", "type": "string", "enum": [ "TSG", "ERR" ], "examples": [ "ERR" ] }, "FileType": { "description": "The type of File.", "type": "string", "enum": [ "CVF", "DRR", "ICF", "IQF", "OQF", "PCF", "PSR", "QVF", "RSF", "RTF", "SCF", "IGF", "OGF" ], "examples": [ "ICF" ] }, "FileType1": { "description": "The type of File.", "type": "string", "enum": [ "ICF", "CVF", "SCF", "IQF", "QVF", "OQF", "RSF" ], "examples": [ "ICF" ] }, "GenericBoolean": { "description": "True or False indicator.", "type": "boolean", "examples": [ true ] }, "GetAccountDetails": { "type": "object", "properties": { "settlementBIC": { "description": "The settlement BIC for which the position is enquired", "$ref": "#/components/schemas/BIC11Only" } }, "required": [ "settlementBIC" ] }, "GetMessageReasonCode": { "description": "Get Message Reason Code", "type": "string", "maxLength": 4, "examples": [ "GMRC" ] }, "GetMessageRef": { "description": "Message reference", "type": "string", "examples": [ "MSGREF0000011111" ] }, "GetMessageStatus": { "description": "Get Message Status", "type": "string", "enum": [ "VAL", "RJS", "RCV", "TSD", "TSG", "ERR" ], "examples": [ "VAL" ] }, "GetMessageType": { "description": "Get Message Type", "type": "string", "enum": [ "Camt.003", "Camt.004", "Camt.005", "Camt.006" ], "examples": [ "Camt.003" ] }, "GetTransaction": { "type": "object", "properties": { "referenceLCR": { "description": "The reference of the relevant LCR", "$ref": "#/components/schemas/FileReference" } } }, "Header": { "type": "object", "properties": { "interbankSettlementDate": { "description": "The Interbank Settlement Date to which the information are related", "$ref": "#/components/schemas/Date" }, "lac": { "description": "The Liquidity Adjustment checkpoint to which the information are related.", "$ref": "#/components/schemas/Lac" }, "DPBICCode": { "description": "The Debit party BIC", "$ref": "#/components/schemas/BIC8" }, "totalPosition": { "description": "The total amount position against the system to be settled in CGS (It could be negative; if negative it will have the minus sign before the amount)", "$ref": "#/components/schemas/StandardAmount1" } }, "required": [ "interbankSettlementDate", "DPBICCode", "totalPosition" ] }, "IBAN": { "description": "IBAN of Customer.", "type": "string", "pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}", "examples": [ "IT60X0542811101000000123456" ] }, "IndParticipant": { "type": "object", "properties": { "name": { "description": "The name of the RB", "$ref": "#/components/schemas/ParticipantName" }, "BICCode": { "description": "The BIC of the RB", "$ref": "#/components/schemas/Bic11Only" }, "initParticipantValidity": { "description": "The initial validity date of the RB", "$ref": "#/components/schemas/Date" }, "endParticipantValidity": { "description": "The end validity date of the RB", "$ref": "#/components/schemas/Date" }, "DPBICCode": { "description": "The DP to which the RB is linked", "$ref": "#/components/schemas/BIC8" }, "DPName": { "description": "The name of the DP", "$ref": "#/components/schemas/ParticipantName" }, "DPInitParticipantValidity": { "description": "The initial validity date of the DP to which the RB is linked", "$ref": "#/components/schemas/Date" }, "DPEndParticipantValidity": { "description": "The end validity date of the DP to which the RB is linked", "$ref": "#/components/schemas/Date" }, "currentStatus": { "description": "The current status of the RB", "$ref": "#/components/schemas/ParticipantStatus" }, "parModHistory": { "description": "Present only in case the senderBIC inquires the details of its RB", "type": "array", "items": { "$ref": "#/components/schemas/ParModHistory1" } }, "detailsHistory": { "description": "Present only in case the senderBIC inquires the details of its RB", "type": "array", "items": { "$ref": "#/components/schemas/DetailsHistory1" } } }, "required": [ "BICCode", "name", "initParticipantValidity", "endParticipantValidity", "DPBICCode", "DPName", "DPInitParticipantValidity", "DPEndParticipantValidity", "currentStatus" ] }, "IndParticipantRef": { "type": "object", "properties": { "BICCode": { "description": "The RB to which the request refers\n\n **Validation Rule(s)** It must be a RB linked to the senderBIC\n(errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" } }, "required": [ "BICCode" ] }, "IndParticipants": { "type": "object", "properties": { "name": { "description": "The name of the RB", "$ref": "#/components/schemas/ParticipantName1" }, "BICCode": { "description": "The BIC of the RB", "$ref": "#/components/schemas/Bic11Only" }, "initValidity": { "description": "The initial validity of the RB", "$ref": "#/components/schemas/Date" }, "endValidity": { "description": "The end validity of the RB", "$ref": "#/components/schemas/Date" }, "status": { "description": "The status of the RB", "$ref": "#/components/schemas/ParticipantStatus" }, "newBIC": { "description": "The new BIC of the RB, following a Change BIC operation", "$ref": "#/components/schemas/Bic11Only" }, "newRole": { "description": "Whether the participant changed its role following a Change Role operation\ntrue= role changed\nfalse= role unchanged\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "DPBICCode": { "description": "The BIC of the DP", "$ref": "#/components/schemas/BIC8" }, "DPSettlementBIC": { "description": "The BIC of the DP known to the External Settlement Mechanism", "$ref": "#/components/schemas/Bic11Only" }, "DPName": { "description": "The name of the DP", "$ref": "#/components/schemas/ParticipantName1" } }, "required": [ "BICCode", "name", "initValidity", "endValidity", "status", "newRole", "DPBICCode", "DPSettlementBIC", "DPName" ] }, "InsertBRT": { "type": "object", "properties": { "counterpartBIC": { "description": "The inserted counterpart BIC", "$ref": "#/components/schemas/BIC8" } } }, "InsertReachableBICRequest": { "type": "object", "properties": { "dateTime": { "description": "The date time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "RBBICCode": { "description": "The relevant RB BIC\n\n **Validation Rule(s)** If already present in the system, it must have ‘disabled’ status with respect to the InitValidityDate\n(errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "initParticipantValidity": { "description": "The first date starting from which the RB is active\n\n **Validation Rule(s)** The first available effective date must be set as follows:\n- the effective date (initial validity 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”\n(error code DT01)", "$ref": "#/components/schemas/Date" }, "endParticipantValidity": { "description": "The last date until which this RB is active\n\n **Validation Rule(s)** It must be equal to the fixed value ‘9999-12-31’ (errorCode DT01)", "$ref": "#/components/schemas/Date" }, "parameters": { "$ref": "#/components/schemas/Parameters" } }, "required": [ "dateTime", "RBBICCode", "initParticipantValidity", "endParticipantValidity", "parameters" ] }, "InsertReachableBICResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "operationRef": { "description": "The reference assigned by the system to the \"Insert\" operation (logged in TBA status in the system).", "$ref": "#/components/schemas/OperationReference" } }, "required": [ "dateTime", "operationRef" ] }, "Lac": { "description": "The LAC in which the relevant LCR was generated", "type": "string", "pattern": "[0-9]{1,2}", "examples": [ "01" ] }, "LCRDetails": { "type": "object", "properties": { "referenceLCR": { "description": "The LCR reference", "$ref": "#/components/schemas/FileReference" }, "settlementDate": { "description": "The LCR settlement date", "$ref": "#/components/schemas/Date" }, "origBulkMsgId": { "description": "The “Bulk Message Id” of the ICF input file that includes the transactions leading to the creation of the LCR", "$ref": "#/components/schemas/BulkReference" }, "origInputFile": { "description": "The original ICF file reference", "$ref": "#/components/schemas/FileReference" }, "bulkType": { "description": "The Bulk Type to which the LCR refers", "$ref": "#/components/schemas/BulkType" }, "instructingDPBIC": { "description": "The Instructing Agent BIC.\nIt corresponds Debit Party for Pacs.004 and Pacs.008", "$ref": "#/components/schemas/BIC8" }, "instructedDPBIC": { "description": "The Instructed Agent BIC.\nIt corresponds Credit Party for Pacs.004 and Pacs.008", "$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" }, "lacInputS2": { "description": "The LAC assigned to the LCR by STEP2-DKK DCT Service", "$ref": "#/components/schemas/Lac" }, "cgsLacInput": { "description": "The LAC running on CGS when the LCR has been retrieved from the CGS.", "$ref": "#/components/schemas/Lac" }, "cgsLacOutput": { "description": "The LAC running on CGS when the LCR has closed its life-cycle.", "$ref": "#/components/schemas/Lac" }, "amount": { "description": "The amount managed in the relevant LCR", "$ref": "#/components/schemas/StandardAmount1" }, "numTransactions": { "description": "The number of transactions included in the relevant LCR", "$ref": "#/components/schemas/StandardInteger" }, "lcrStatus": { "description": "The status of the LCR", "$ref": "#/components/schemas/LcrStatus" }, "s2LcrCreationTimestamp": { "description": "The timestamp when the STEP2 Service created the LCR", "$ref": "#/components/schemas/DateTime" }, "cgsLcrStatusUpdate": { "description": "The timestamp of the last LCR’s status update", "$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": [ "referenceLCR", "settlementDate", "origBulkMsgId", "origInputFile", "bulkType", "instructingDPBIC", "instructedDPBIC", "credPartyBIC", "debPartyBIC", "lacInputS2", "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/SearchCriteria14" } }, "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" ] }, "LcrReference": { "description": "LCR Reference", "type": "string", "maxLength": 16, "examples": [ "LCRREF1111111111" ] }, "LCRs": { "type": "object", "properties": { "instructingDPBIC": { "description": "The Instructing Agent BIC", "$ref": "#/components/schemas/BIC8" }, "instructedDPBIC": { "description": "The Instructed Agent BIC", "$ref": "#/components/schemas/BIC8" }, "instgSttlmBIC": { "description": "The Settlement BIC configured for the Instructing Agent.\nAvailable only after LCRs have been sent to the CGS", "$ref": "#/components/schemas/Bic11Only" }, "instdSttlmBIC": { "description": "The Settlement BIC configured for the Instructed Agent.\nAvailable only after LCRs have been sent to the CGS", "$ref": "#/components/schemas/Bic11Only" }, "settlementDate": { "description": "The LCR settlement date", "$ref": "#/components/schemas/Date" }, "businessDateTime": { "description": "Business date and time at which the LCR has closed its life-cycle", "$ref": "#/components/schemas/DateTime" }, "bulkType": { "description": "The bulk type to which the LCR relates.", "$ref": "#/components/schemas/BulkType" }, "referenceLCR": { "description": "The LCR reference", "$ref": "#/components/schemas/FileReference" }, "lac": { "description": "The LAC in which the relevant LCR closed its life cycle", "$ref": "#/components/schemas/Lac" }, "lcrStatus": { "description": "The status of the LCR", "$ref": "#/components/schemas/LcrStatus" }, "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" }, "amount": { "description": "The amount managed in the LCR", "$ref": "#/components/schemas/StandardAmount1" }, "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": [ "instructingDPBIC", "instructedDPBIC", "settlementDate", "bulkType", "referenceLCR", "lcrStatus", "originalBulkReferenceId", "originalInputFileReferenceId", "amount", "dbrCrdFlag", "creationDateTime" ] }, "LcrStatus": { "type": "string", "enum": [ "WTG", "STTLD", "TRD", "CNLD", "RVKD", "RJCT", "RJCS", "QUED" ], "examples": [ "WTG" ] }, "LcrStatusUpdate": { "type": "object", "properties": { "lcrStatus": { "description": "The status of the LCR for which the enquiry is requested", "$ref": "#/components/schemas/LcrStatus" }, "lastStatusUpdate": { "description": "The date and time at which the LCR for which the enquiry is requested acquired the status set in lcrStatus field", "$ref": "#/components/schemas/DateTime" } } }, "ListAlertsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria12" }, "offset": { "description": "Indicator used to manage pagination\n\n **Validation Rule(s)** If used, it must correspond to the value provided in the previous listAlerts Response", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime" ] }, "ListAlertsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "alerts": { "type": "array", "items": { "$ref": "#/components/schemas/Alerts" } }, "endOfList": { "description": "Whether the list is complete or not. Possible values:\ntrue=the list is complete\nfalse=the list is not complete", "$ref": "#/components/schemas/GenericBoolean" }, "offset": { "description": "Provided if endOfList is set to false. It must be used in the subsequent listAlerts Request to retrieve the next portion of the list", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "alerts", "endOfList" ] }, "ListBulksRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria6" }, "offset": { "description": "The offset is used in order to manage the pagination. If used, it has to contain the same value of the offset present in the previous “listBulks – Positive Response Body”", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "searchCriteria" ] }, "ListBulksResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "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" }, "bulks": { "type": "array", "items": { "$ref": "#/components/schemas/Bulks" } }, "offset": { "description": "The offset is used in order to manage the pagination. It is used if the endOfList field is set to false", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "endOfList" ] }, "ListCommandsRequest": { "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" ] }, "ListCommandsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$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", "endOfList" ] }, "ListDefaultThresholdsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria3" }, "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" ] }, "ListDefaultThresholdsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API response creation", "$ref": "#/components/schemas/DateTime" }, "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" }, "defaultThresholds": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultThresholds" } }, "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", "endOfList" ] }, "ListFilesRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria7" }, "offset": { "description": "The offset is used in order to manage the pagination. If used, it has to contain the same value of the offset present in the previous “listFile - Positive Response Body”", "$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" }, "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" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/Files" } }, "offset": { "description": "Present in case of endOfList is set to “false”", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "endOfList" ] }, "ListLCRRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria13" } }, "required": [ "dateTime", "searchCriteria" ] }, "ListLCRResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "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/EndOfList" }, "LCRs": { "type": "array", "items": { "$ref": "#/components/schemas/LCRs" } }, "offset": { "description": "The offset points to a set of records. It must be used in the request to retrieve the next portion of records (when the endOfList is false)", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "endOfList", "LCRs" ] }, "ListMessagesRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria8" }, "offset": { "description": "The offset is used in order to manage the pagination\n\n **Validation Rule(s)** If used, it has to contain the same value of the offset present in the previous “listMessages - Positive Response Body”", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "searchCriteria" ] }, "ListMessagesResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "endOfList": { "description": "The flag used to show if the list is complete or not\ntrue= The list is complete\nfalse= The list is partial", "$ref": "#/components/schemas/EndOfList" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Messages" } }, "offset": { "description": "The offset is used in order to manage the pagination. Present in case endOfList is set to “false”", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "endOfList", "messages" ] }, "ListOperationsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "description": "Set of fields for search criteria", "$ref": "#/components/schemas/SearchCriteria2" }, "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" ] }, "ListOperationsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "operations": { "description": "The following section is repeated for each retrieved operation", "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" ] }, "ListParticipantsRequest": { "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" ] }, "ListParticipantsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/Participants" } } }, "required": [ "dateTime" ] }, "ListReachableBICsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria1" } }, "required": [ "dateTime" ] }, "ListReachableBICsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "indParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/IndParticipants" } } }, "required": [ "dateTime" ] }, "ListReportRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria9" } }, "required": [ "dateTime" ] }, "ListReportResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/Reports" } } }, "required": [ "dateTime" ] }, "ListThirdPoleReportRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$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" ] }, "ListThirdPoleReportResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/Reports1" } }, "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", "endOfList" ] }, "ListTransactionsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "searchCriteria": { "$ref": "#/components/schemas/SearchCriteria5" }, "offset": { "description": "The offset is used in order to manage the pagination. If used, it has to contain the same value of the offset present in the previous “ListTransactions - Positive Response Body”", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "searchCriteria" ] }, "ListTransactionsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "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" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/Transactions" } }, "offset": { "description": "The offset is used in order to manage the pagination. If used, it has to contain the same value of the offset present in the previous “ListTransactions - Positive Response Body”", "$ref": "#/components/schemas/Offset" } }, "required": [ "dateTime", "endOfList" ] }, "Message": { "type": "object", "properties": { "messageType": { "description": "The message type\n\n **Validation Rule(s)** It must be set with one of the values configured in the system\n(errorCode SC01)", "$ref": "#/components/schemas/GetMessageType" }, "messageStatus": { "description": "The status of the message.\nThe field is available only for single messages sent via SWIFTNet.\nPossible values are:\n• VAL – Validated: validated transactions; applicable to camt.003 and camt.005\n• RJS – Rejected by CS: rejected by STEP2; applicable to camt.003 and camt.005.\n• TSD – Transmitted: the output message is sent to the sender BIC; applicable to camt.004 and camt.006;\n• TSG – Transmitting: the message has been created and not yet sent, or it’s in the process of being transmitted; applicable to camt.004 and camt.006;\n• ERR – Error: the output message sending failed\n\n **Validation Rule(s)** If set, it must be set with one of the values configured in the system and applicable to the relevant message type\n(errorCode SC01)\nIt can be set only for messages for which network is set to Swiftnet\n(errorCode SC01)", "$ref": "#/components/schemas/GetMessageStatus" }, "messageRef": { "description": "The message reference", "$ref": "#/components/schemas/GetMessageRef" }, "dateTime": { "description": "The date and time of the sending/reception of the relevant message", "$ref": "#/components/schemas/DateTime" }, "senderReceiverBIC": { "description": "The BIC of the relevant DP", "$ref": "#/components/schemas/BIC8" } }, "required": [ "messageType", "messageRef", "dateTime", "senderReceiverBIC" ] }, "Message1": { "type": "object", "properties": { "messageType": { "description": "The type of the message to be retransmitted\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)\nThe values Camt.003 and Camt.005 cannot be used\n(error Code XA07)", "$ref": "#/components/schemas/GetMessageType" }, "messageRef": { "description": "The reference ID of the message to be retransmitted", "$ref": "#/components/schemas/GetMessageRef" } }, "required": [ "messageType", "messageRef" ] }, "MessageDetails": { "type": "object", "properties": { "messageType": { "description": "The message type", "$ref": "#/components/schemas/GetMessageType" }, "messageStatus": { "description": "The status of the message.\nThe field is set only for single messages sent via SWIFTNet.\nPossible values are:\n• VAL – Validated: validated transactions; applicable to camt.003 and camt.005\n• RJS – Rejected by CS: rejected by STEP2; applicable to camt.003 and camt.005.\n• TSD – Transmitted: the output message is sent to the sender BIC; applicable to camt.004 and camt.006;\n• TSG – Transmitting: the message has been created and not yet sent, or it’s in the process of being transmitted; applicable to camt.004 and camt.006;\n• ERR – Error: the output message sending failed; applicable to camt.004 and camt.006", "$ref": "#/components/schemas/GetMessageStatus" }, "messageRef": { "description": "The message reference", "$ref": "#/components/schemas/GetMessageRef" }, "dateTime": { "description": "The date and time of the sending/reception of the relevant message", "$ref": "#/components/schemas/DateTime" }, "validationDateTime": { "description": "The time at which the input message is validated\nApplicable to Camt.003 and Camt.005", "$ref": "#/components/schemas/DateTime" }, "lastStatusUpdate": { "description": "The timestamp of the message’s last status update", "$ref": "#/components/schemas/DateTime" }, "senderReceiverBIC": { "description": "The sender/receiver DP BIC", "$ref": "#/components/schemas/BIC8" }, "IGFFileRef": { "description": "The reference of the related IGF file.\nApplicable only for messages exchanged via EBICS or SIANet.XS. If the reference is set, no message status is available", "$ref": "#/components/schemas/FileReference" }, "OGFFileRef": { "description": "The reference of the related OGF file.\nApplicable only for messages exchanged via EBICS or SIANet.XS. If the reference is set, no message status is available.", "$ref": "#/components/schemas/FileReference" }, "network": { "description": "The network through which the message is sent or received\nPossible values:\nSWF, \"Swiftnet single request type\"\nSWA, \"Swiftnet multiple request type\"\nFXS, \"SIAnet.XS\"\nEBX, \"EBICS Network\"\nSWS, \"SWIFTNET S&F Single Request Type\"\nSWM, \"SWIFTNET S&F Multiple Request Type\"", "$ref": "#/components/schemas/Network2" }, "counter": { "description": "The counter of the retransmission requested for the message.\nSet for camt.004 and camt.006\nPossible values: 0 to 5", "$ref": "#/components/schemas/StandardInteger" }, "getAccountDetails": { "description": "This section is present if messageType is equal to Camt.003", "$ref": "#/components/schemas/GetAccountDetails" }, "returnAccountDetails": { "description": "This section is present if messageType is equal to Camt.004 (positive validation)", "$ref": "#/components/schemas/ReturnAccountDetails" }, "returnAccountQueryResponseError": { "description": "This section is present if messageType is equal to Camt.004 (negative validation)", "$ref": "#/components/schemas/ReturnAccountQueryResponseError" }, "getTransaction": { "description": "This section is present if messageType is equal to Camt.005", "$ref": "#/components/schemas/GetTransaction" }, "returnTransaction": { "description": "This section is present if messageType is equal to Camt.006 (positive validation)", "$ref": "#/components/schemas/ReturnTransaction" }, "returnTransactionQueryResponseError": { "description": "This section is present if messageType is equal to Camt.006 (negative validation)", "$ref": "#/components/schemas/ReturnAccountQueryResponseError" } }, "required": [ "messageType", "messageRef", "dateTime", "senderReceiverBIC", "network" ] }, "MessageDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "message": { "$ref": "#/components/schemas/Message" } }, "required": [ "dateTime", "message" ] }, "MessageDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "messageDetails": { "description": "This section reports the general information related to the message", "$ref": "#/components/schemas/MessageDetails" } }, "required": [ "dateTime", "messageDetails" ] }, "Messages": { "type": "object", "properties": { "senderReceiverBIC": { "description": "The BIC sending/receiving the message", "$ref": "#/components/schemas/BIC8" }, "messageType": { "description": "The message type", "$ref": "#/components/schemas/GetMessageType" }, "messageRef": { "description": "The reference of the message", "$ref": "#/components/schemas/GetMessageRef" }, "dateTime": { "description": "The date and time when the message was sent/received by the Central System", "$ref": "#/components/schemas/DateTime" }, "lastStatusUpdate": { "description": "The timestamp of the last status update of the message", "$ref": "#/components/schemas/DateTime" }, "messageStatus": { "description": "The status of the message", "$ref": "#/components/schemas/GetMessageStatus" }, "reasonCode": { "description": "The reason code associated to the message", "$ref": "#/components/schemas/GetMessageReasonCode" }, "originalMessageRef": { "description": "The original message reference. Applicable to camt.004 and camt.006", "$ref": "#/components/schemas/GetMessageRef" }, "network": { "description": "The network from which the message is received or sent", "$ref": "#/components/schemas/Network2" }, "IGFFileRef": { "description": "The reference of the relevant IGF\nApplicable only to messages sent via SIANet.XS or EBICS", "$ref": "#/components/schemas/FileReference" }, "OGFFileRef": { "description": "The reference of the relevant OGF\nApplicable only to messages sent via SIANet.XS or EBICS", "$ref": "#/components/schemas/FileReference" } }, "required": [ "senderReceiverBIC", "messageType", "messageRef", "dateTime", "reasonCode", "network" ] }, "MessageType": { "description": "The type of message.", "type": "string", "enum": [ "Camt.027", "Camt.028", "Camt.029", "Camt.056", "Camt.087", "Pacs.004", "Pacs.008", "Pacs.028", "Pacs.2S2" ], "examples": [ "Pacs.008" ] }, "Network": { "description": "Network from which the file is received or sent.", "type": "string", "enum": [ "FXS", "EBX", "SWF", "SWA", "SWS", "SWM" ], "pattern": "[A-Za-z0-9]{3,3}", "examples": [ "SWF" ] }, "Network1": { "description": "Network from which the file is received or sent.", "type": "string", "pattern": "[A-Za-z0-9]{3,3}", "examples": [ "SWT" ] }, "Network2": { "description": "Network from which the file is received or sent.", "type": "string", "enum": [ "SWF", "SWA", "FXS", "EBX", "SWS", "SWM" ], "pattern": "[A-Za-z0-9]{3,3}", "examples": [ "SWF" ] }, "NetworkFileName": { "description": "Network file name of the file.", "type": "string", "pattern": "^\\S{15,30}\\.[A-Z]{1,1}", "examples": [ "S202DCTTESTITMM_F800AAA.I" ] }, "NetworkIdentification": { "description": "Identification network.", "type": "string", "maxLength": 100, "examples": [ "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" ] }, "NetworkIdentification1": { "description": "Network Identification", "type": "string", "enum": [ "FXS", "EBX", "SWF", "SWA", "SWS", "SWM" ], "maxLength": 3, "examples": [ "SWF" ] }, "NetworkIdentificationSendingReceiving": { "description": "Network identification for sending and receiving", "type": "string", "maxLength": 100, "examples": [ "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift" ] }, "Offset": { "description": "Offset is used in lists that support pagination.", "type": "string", "examples": [ "AAaa88ss2345fggGGDDaaaHH" ] }, "OperationDetails": { "type": "object", "properties": { "DPRBOperation": { "description": "Whether the operation involves a Direct Participant or a Reachable BIC", "$ref": "#/components/schemas/DPRBOperation1" }, "operationType": { "description": "The operation type. Possible values:\nINS for “Insert”\nREM for “Remove”\nUPD for “Update”\nBRI for “Insert BRT”\nBRR for “Remove BRT”\nMOD for “Amend Change”\nREV for “Revoke Change”\nCDP for “RB Change DP”", "$ref": "#/components/schemas/OperationType" }, "operationStatus": { "description": "The operation status. Possible values:\nAUT for “Authorized”\nEXE for “Executed”\nREJ for “Rejected by User”\nRJS for “Rejected by System”\nTBA for “To Be Authorized”\nTBC for \"Submitted\"", "$ref": "#/components/schemas/OperationStatus" }, "operationRef": { "description": "The reference of the operation", "$ref": "#/components/schemas/OperationReference" }, "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" }, "confirmDateTime": { "description": "The date and time of the confirmation by Participant User.\nApplicable only in case of “Critical” 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/UserId" }, "confirmer": { "description": "The user Id of the user who confirmed the operation.\nApplicable only in case of “Critical” operation", "$ref": "#/components/schemas/UserId" }, "userAuthReject": { "description": "The user Id of the user who authorized/rejected the operation", "$ref": "#/components/schemas/UserId" }, "critical": { "description": "Whether the operation is critical or not. Possible values:\ntrue=critical\nfalse=non-critical", "$ref": "#/components/schemas/GenericBoolean" }, "directParticipant": { "description": "The following details are present for UPD DP", "$ref": "#/components/schemas/DirectParticipant" }, "reachableBIC": { "description": "The following details are present for INS - REM - UPD RB - MOD - REV - CDP\nIn case of Amend Change/Revoke Change the fields report the new value set with the operation", "$ref": "#/components/schemas/ReachableBIC" }, "insertBRT": { "description": "The following section is present if operationType is equal to BRI", "$ref": "#/components/schemas/InsertBRT" }, "removeBRT": { "description": "The following section is present if operationType is equal to BRR", "$ref": "#/components/schemas/InsertBRT" } }, "required": [ "DPRBOperation", "operationType", "operationStatus", "operationRef", "effectiveDate", "requestDateTime", "userIssuer", "critical" ] }, "OperationDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "operationRef": { "description": "The operation reference", "$ref": "#/components/schemas/OperationReference" } }, "required": [ "dateTime", "operationRef" ] }, "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", "operationDetails" ] }, "OperationReference": { "description": "The reference of the operation", "type": "string", "maxLength": 16, "examples": [ "REF0123456789111" ] }, "Operations": { "type": "object", "properties": { "DPRBOperation": { "description": "Whether the operation refers to a Direct Participant or a Reachable BIC", "$ref": "#/components/schemas/DPRBOperation" }, "DPBICCode": { "description": "The DP to which the operation refers.It must correspond to the senderBIC", "$ref": "#/components/schemas/BIC8" }, "RBBICCode": { "description": "The RB to which the operation refers", "$ref": "#/components/schemas/Bic11Only" }, "operationType": { "description": "The operation type", "$ref": "#/components/schemas/OperationType" }, "operationStatus": { "description": "The operation status", "$ref": "#/components/schemas/OperationStatus" }, "effectiveDate": { "description": "The effective date of the operation", "$ref": "#/components/schemas/Date" }, "requestDateTime": { "description": "The date and time when the operation was requested", "$ref": "#/components/schemas/DateTime" }, "confirmDateTime": { "description": "The date and time of the confirmation by Participant User.\nApplicable only in case of “Critical” operation", "$ref": "#/components/schemas/DateTime" }, "authRejectDateTime": { "description": "The date and time when the operation was authorized/rejected", "$ref": "#/components/schemas/DateTime" }, "userIssuer": { "description": "The user Id of the user who issued the operation", "$ref": "#/components/schemas/UserId" }, "confirmer": { "description": "The user Id of the user who confirmed the operation.\nApplicable only in case of “Critical” operation", "$ref": "#/components/schemas/UserId" }, "userAuthReject": { "description": "The user Id of the user who authorized/rejected the operation", "$ref": "#/components/schemas/UserId" }, "operationRef": { "description": "The operation reference", "$ref": "#/components/schemas/OperationReference" }, "critical": { "description": "Whether the operation is critical\ntrue= critical operation\nfalse=non-critical operation", "$ref": "#/components/schemas/GenericBoolean" } }, "required": [ "DPRBOperation", "operationType", "operationStatus", "effectiveDate", "requestDateTime", "userIssuer", "operationRef", "critical" ] }, "OperationStatus": { "description": "The status of the operation", "type": "string", "enum": [ "AUT", "EXE", "REJ", "RJS", "TBA", "TBC" ], "maxLength": 3, "examples": [ "AUT" ] }, "OperationType": { "description": "The type of operation", "type": "string", "enum": [ "INS", "REM", "UPD", "BRI", "BRR", "MOD", "REV", "CDP" ], "maxLength": 3, "examples": [ "INS" ] }, "OriginalXml": { "description": "OriginalXml.", "type": "string", "format": "xml", "examples": [ "......" ] }, "OriginalXMLRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "transactionRef": { "$ref": "#/components/schemas/TransactionRef1" } }, "required": [ "dateTime", "transactionRef" ] }, "OriginalXMLResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "originalXml": { "description": "The OriginalXml", "$ref": "#/components/schemas/OriginalXml" } }, "required": [ "dateTime", "originalXml" ] }, "Parameters": { "type": "object", "properties": { "name": { "description": "The name of the RB", "$ref": "#/components/schemas/ParticipantName" }, "acceptanceDateAO1": { "description": "Whether the RB is configured for AOS1\ntrue= AOS1 enabled\nfalse= AOS1 not enabled\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "remittanceInformationERI": { "description": "Whether the RB is configured for ERI\ntrue= ERI enabled\nfalse= ERI not enabled\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "sameBankingGroupAsDP": { "description": "Whether the RB part of the same banking group as its DP\ntrue= RB part of the same banking group as its DP\nfalse= RB not part of the same banking group as its DP\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" } }, "required": [ "name", "acceptanceDateAO1", "remittanceInformationERI", "sameBankingGroupAsDP" ] }, "Parameters1": { "type": "object", "properties": { "name": { "description": "The name of the participant", "$ref": "#/components/schemas/ParticipantName" }, "settlementFiles": { "description": "The number of settlement files the Direct Participant is configured to receive\n\n **Validation Rule(s)** It must be set with one of the configured values\n(errorCode SC01)", "$ref": "#/components/schemas/SettlementFile1" }, "separateReturnFile": { "description": "The Participant is configured to receive a dedicated SCF files containing only Return payments\ntrue= Separate Return file\nfalse=No separate Return file\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "technicalBIC": { "description": "Technical BIC indicator\ntrue= Technical BIC\nfalse=No technical BIC\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "RSFRequired": { "description": "The DP is configured to receive RSF files\ntrue= RSF enabled\nfalse= RSF not enabled\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "extendedPSR": { "description": "The DP is configured to receive extended PSR\ntrue= extended PSR enabled\nfalse= extended PSR not enabled\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "acceptanceDateAO1": { "description": "The DP is configured for AO1\ntrue= AO1 enabled\nfalse= AO1 not enabled\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "remittanceInformationERI": { "description": "The DP is configured for ERI\ntrue= ERI enabled\nfalse= ERI not enabled\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "allowedPCF": { "description": "The DP is configured to receive PCF files\ntrue= PCF enabled\nfalse= PCF not enabled\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "nonTargetDaySettlement": { "description": "The DP Iis configured for NTD\ntrue= NTD enabled\nfalse= NTD not enabled\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "maxReceivingFileSize": { "description": "The maximum number of bytes that a DP will accept for the size of each file received from STEP2 CS\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" }, "defaultThresholdValue": { "description": "The Default Threshold Value between the DP and each other enabled DP.\n\n **Validation Rule(s)** Only decimal notation is allowed\n(errorCode XA05)", "$ref": "#/components/schemas/StandardAmount1" }, "swiftNetOutputFileCompression": { "description": "The DP is allowed to send/receive compressed files\ntrue= Compression enabled\nfalse= Compression not enabled\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)\nIt can be set to \"true\" only if active output is configured with Swiftnet\n(errorCode XA07)", "$ref": "#/components/schemas/GenericBoolean" }, "nightTimeSettlement": { "description": "The DP is configured to settle for CGS night-time settlement\ntrue= CGS night-time settlement enabled\nfalse= CGS night-time settlemen not enabled\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "priNetworkIdentification": { "description": "The primary network through which the DP connects to STEP2\n\n **Validation Rule(s)** It can contain:\n- “FXS” for SIAnet.XS,\n- “EBX” for EBICS;\n- “SWF” for SWIFTNet single request;\n- “SWA” for SWIFTNet multiple request\n- \"SWS\" for SWIFTNet S&F Single Request Type\n- \"SWM\" for SWIFTNet S&F Multiple Request Type\n(errorCode SC01)", "$ref": "#/components/schemas/NetworkIdentification1" }, "secNetworkIdentification": { "description": "The type of network used by the DP as “Secondary Network”\n\n **Validation Rule(s)** It can contain:\n- “FXS” for SIAnet.XS,\n- “EBX” for EBICS;\n- “SWF” for SWIFTNet single request;\n- “SWA” for SWIFTNet multiple request\n- \"SWS\" for SWIFTNet S&F Single Request Type\n- \"SWM\" for SWIFTNet S&F Multiple Request Type\n(errorCode SC01)", "$ref": "#/components/schemas/NetworkIdentification1" }, "priReceivingNetIdentification": { "description": "The identifier by which the DP is known on the primary network when receiving files from STEP2 CS", "$ref": "#/components/schemas/NetworkIdentificationSendingReceiving" }, "secReceivingNetIdentification": { "description": "The identifier by which the DP is known on the secondary network, when receiving files from STEP2 CS", "$ref": "#/components/schemas/NetworkIdentificationSendingReceiving" }, "priSendingNetIdentification": { "description": "The identifier by which this DP is known on the primary network when sending files to STEP2 CS", "$ref": "#/components/schemas/NetworkIdentificationSendingReceiving" }, "secSendingNetIdentification": { "description": "The identifier by which the DP is known on the secondary network, when sending files from STEP2 CS", "$ref": "#/components/schemas/NetworkIdentificationSendingReceiving" }, "T2RTGSAuthorisedAccountUserAAUForAS-D": { "description": "The BIC11 of the T2-RTGS DCA for settlement of STEP2 transactions. It must be declared at TARGET Level as Authorized Account User BIC of the T2-RTGS DCA used for AS-D\n\n **Validation Rule(s)** Format checks only (errorCode SC01)", "$ref": "#/components/schemas/Bic11Only" }, "T2RTGSAuthorisedAccountUserAAUForAS-E": { "description": "The BIC11 of the T2-RTGS Dedicated Cash Account (DCA) for remuneration process\n\n **Validation Rule(s)** It must be set only if different from the one used for T2RTGSAuthorisedAccountUserAAUForAS-D.\n(errorCode XA04)", "$ref": "#/components/schemas/Bic11Only" }, "T2RTGSDedicatedCashAccountDCAForAS-D": { "description": "T2-RTGS Dedicated Cash Account (DCA) used by a Participant for funding/defunding CGS position (with Ancillary System AS-D). It is the Account registered with STEP2 Settlement Bank Account Group (as registered in T2 CRDM Registration form)\n\n **Validation Rule(s)** Format checks only (errorCode SC01)", "$ref": "#/components/schemas/DedicatedCashAccount" }, "T2RTGSDedicatedCashAccountDCAForAS-E": { "description": "The T2-RTGS Dedicated Cash Account (DCA) used by a Participant for remuneration process (with Ancillary System AS-E).\n\n **Validation Rule(s)** It must be set only if different by T2RTGSDedicatedCashAccountDCAForAS-D.\n(errorCode XA04)", "$ref": "#/components/schemas/DedicatedCashAccount" }, "txThresholdForOutput": { "description": "Minimum number of settled pacs.008 /pacs.004 and valid camt.056/camt.029 transactions which trigger the generation of output files at relevant intervals. The parameter is applicable to SCF and RSF files.\nThe parameter must not be less than service parameter “Min. number of Transactions in Output Files”.\n\n **Validation Rule(s)** The set value must be included within the allowed range (service parameter)\n(errorCode XA15)", "$ref": "#/components/schemas/StandardInteger" } } }, "Parameters2": { "type": "object", "properties": { "name": { "description": "The name of the RB", "$ref": "#/components/schemas/ParticipantName" }, "acceptanceDateAO1": { "description": "Whether the RB is configured for AOS1\ntrue= AOS1 enabled\nfalse= AOS1 not enabled\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "remittanceInformationERI": { "description": "Whether the RB is configured for ERI\ntrue= ERI enabled\nfalse= ERI not enabled\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "sameBankingGroupAsDP": { "description": "RB part of the same banking group as its DP\ntrue= RB part of the same banking group as its DP\nfalse= RB not part of the same banking group as its DP\n\n **Validation Rule(s)** it can only be set as\n- true; or\n- false\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" } } }, "ParModHistory": { "type": "object", "properties": { "initParameterValidity": { "description": "The first date starting from which the parameter is valid", "$ref": "#/components/schemas/Date" }, "endParameterValidity": { "description": "The last date until which the parameter is valid", "$ref": "#/components/schemas/Date" }, "BICName": { "description": "The name of the participant", "$ref": "#/components/schemas/ParticipantName" }, "settlementBIC": { "description": "The BIC by which this DP is known to the External Settlement Mechanism", "$ref": "#/components/schemas/Bic11Only" }, "settlementFiles": { "description": "The number of settlement files the Direct Participant is configured to receive", "$ref": "#/components/schemas/SettlementFile" }, "separateReturnFile": { "description": "The Participant is configured to receive a dedicated SCF files containing only Return payments\ntrue= Separate Return file\nfalse=No separate Return file", "$ref": "#/components/schemas/GenericBoolean" }, "technicalBIC": { "description": "Technical BIC indicator\ntrue= Technical BIC\nfalse=No technical BIC", "$ref": "#/components/schemas/GenericBoolean" } } }, "ParModHistory1": { "type": "object", "properties": { "initParameterValidity": { "description": "The first date starting from which the set of parameters is valid", "$ref": "#/components/schemas/Date" }, "endParameterValidity": { "description": "The last date until this set of parameters is valid", "$ref": "#/components/schemas/Date" }, "BICName": { "description": "The name of the RB", "$ref": "#/components/schemas/ParticipantName" }, "DPBICCode": { "description": "The BIC of the DP to which the RB is linked", "$ref": "#/components/schemas/BIC8" }, "status": { "description": "The status of the RB", "$ref": "#/components/schemas/ParticipantStatus" } } }, "Participant": { "type": "object", "properties": { "name": { "description": "The name of the participant", "$ref": "#/components/schemas/ParticipantName" }, "BICCode": { "description": "The BIC of the DP", "$ref": "#/components/schemas/BIC8" }, "initParticipantValidity": { "description": "The initial validity date of the DP", "$ref": "#/components/schemas/Date" }, "endParticipantValidity": { "description": "The end validity date of the DP", "$ref": "#/components/schemas/Date" }, "currentStatus": { "description": "The status of the DP", "$ref": "#/components/schemas/ParticipantStatus" }, "settlementBIC": { "description": "The BIC by which this DP is known to the External Settlement Mechanism", "$ref": "#/components/schemas/Bic11Only" }, "parModHistory": { "description": "Present only in case the sender BIC inquires its own details", "type": "array", "items": { "$ref": "#/components/schemas/ParModHistory" } }, "detailsHistory": { "description": "Present only in case the sender BIC inquires its own details", "type": "array", "items": { "$ref": "#/components/schemas/DetailsHistory" } } } }, "ParticipantDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "participantRef": { "$ref": "#/components/schemas/ParticipantRef" } }, "required": [ "dateTime", "participantRef" ] }, "ParticipantDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "participant": { "$ref": "#/components/schemas/Participant" } }, "required": [ "dateTime" ] }, "ParticipantName": { "description": "Name of Participant.", "type": "string", "pattern": "(^\\S+.*){1,50}", "examples": [ "Merrill Lynch" ] }, "ParticipantName1": { "description": "Name of Participant.", "type": "string", "pattern": "(^\\S+.*){1,50}", "maxLength": 50, "examples": [ "Merrill Lynch" ] }, "ParticipantRef": { "type": "object", "properties": { "BICCode": { "description": "The DP to which the request refers\n\n **Validation Rule(s)** It must be the BIC of the senderBIC\n(errorCode PY01)", "$ref": "#/components/schemas/BIC8" } }, "required": [ "BICCode" ] }, "Participants": { "type": "object", "properties": { "name": { "description": "The name of the relevant DP", "$ref": "#/components/schemas/ParticipantName" }, "BICCode": { "description": "The BIC of the relevant DP", "$ref": "#/components/schemas/BIC8" }, "initValidity": { "description": "The Initial validity date of the DP", "$ref": "#/components/schemas/Date" }, "endValidity": { "description": "The end validity date of the DP", "$ref": "#/components/schemas/Date" }, "status": { "description": "The status of the DP", "$ref": "#/components/schemas/ParticipantStatus" }, "settlementBIC": { "description": "The BIC by which this DP is known to the External Settlement Mechanism", "$ref": "#/components/schemas/Bic11Only" }, "newBIC": { "description": "The BIC of the DP following a “Change BIC” operation", "$ref": "#/components/schemas/BIC8" }, "newRole": { "description": "Whether the DP changed role after a \"Change Role\" operation\ntrue= Role changed\nfalse= Role unchanged", "$ref": "#/components/schemas/GenericBoolean" } }, "required": [ "BICCode", "name", "initValidity", "endValidity", "status", "settlementBIC", "newRole" ] }, "ParticipantStatus": { "description": "Status of participant.", "type": "string", "enum": [ "CHG", "ENB", "DIS", "SUS" ], "examples": [ "ENB" ] }, "ParticipantStatus1": { "description": "Status of participant.", "type": "string", "enum": [ "DIS", "ENB" ], "examples": [ "ENB" ] }, "RBDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "indParticipantRef": { "$ref": "#/components/schemas/IndParticipantRef" } }, "required": [ "dateTime", "indParticipantRef" ] }, "RBDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "indParticipant": { "$ref": "#/components/schemas/IndParticipant" } }, "required": [ "dateTime" ] }, "ReachableBIC": { "type": "object", "properties": { "name": { "description": "The name of the participant", "$ref": "#/components/schemas/ParticipantName" }, "RBBICCode": { "description": "The BIC Code of the Reachable BIC", "$ref": "#/components/schemas/Bic11Only" }, "oldDPBICCode": { "description": "The DP under which the RB is configured at the time of the operation.\nThe field will be available only in case of CDP operation.", "$ref": "#/components/schemas/BIC8" }, "newDPBICCode": { "description": "The DP under which the RB will be configured with the “RB Change DP” operation.\nThe field will be available only in case of CDP operation.", "$ref": "#/components/schemas/BIC8" }, "acceptanceDateAO1": { "description": "The value set for AO1 parameter", "$ref": "#/components/schemas/GenericBoolean" }, "remittanceInformationERI": { "description": "The value set for ERI parameter", "$ref": "#/components/schemas/GenericBoolean" }, "sameBankingGroupAsDP": { "description": "The value set for Same Banking Group adherence", "$ref": "#/components/schemas/GenericBoolean" } } }, "ReasonCode": { "description": "Error code associated to the file.", "type": "string", "pattern": "[A-Z]{1,1}[0-9]{2,2}", "examples": [ "A01" ] }, "ReasonCodeTransaction": { "description": "Error code associated to the transaction.", "type": "string", "maxLength": 4, "examples": [ "CNOR" ] }, "RecordType": { "description": "Record Type.", "type": "string", "enum": [ "HCRR", "HDRR", "HMSR" ], "examples": [ "HCRR" ] }, "RejectParticipantOperationRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "operationRef": { "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/OperationReference" } }, "required": [ "dateTime", "operationRef" ] }, "RejectParticipantOperationResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "operationRef": { "description": "The reference of the operation rejected with the API request (this operation is logged in the system in REJ status)", "$ref": "#/components/schemas/OperationReference" } }, "required": [ "dateTime", "operationRef" ] }, "Report": { "type": "object", "properties": { "reportRef": { "description": "The reference of the report", "$ref": "#/components/schemas/ReportRef" }, "creationDateTime": { "description": "The date and time of the creation of the report", "$ref": "#/components/schemas/DateTime" }, "reportType": { "description": "The report type", "$ref": "#/components/schemas/ReportType" }, "reportStatus": { "description": "The status of the report", "$ref": "#/components/schemas/ReportStatus" }, "data": { "description": "The data contained in the report", "$ref": "#/components/schemas/ReportData" } }, "required": [ "reportRef", "creationDateTime", "reportType", "reportStatus", "data" ] }, "ReportCriteria": { "type": "object", "properties": { "fileType": { "description": "The file type\n\n **Validation Rule(s)** It can assume only one of the configured values on the system\n(errorCode SC01)\nOnly “ICF” , “SCF” , “IQF”, “OQF” (errorCode XA07) can be used", "$ref": "#/components/schemas/FileType" }, "fileReference": { "description": "The reference of file", "$ref": "#/components/schemas/FileReference" }, "lac": { "description": "The LAC in which the relevant transaction was settled.\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/Lac" }, "bulkType": { "description": "The bulk type\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/MessageType" }, "settlementDateFrom": { "description": "The Interbank Settlement date of the payment - From\n\n **Validation Rule(s)** It must be previous or equal to the current date and time\n(errorCode DT01)", "$ref": "#/components/schemas/Date" }, "settlementDateTo": { "description": "The Interbank Settlement date of the payment - To\n\n **Validation Rule(s)** It must be greater than or equal to the dateTimeFrom\n(errorCode DT01)", "$ref": "#/components/schemas/Date" }, "debtorAgent": { "description": "The Debtor Agent of the transaction.\nUsed to identify the transaction. Enabled only if the selected Bulk Type is pacs.008.", "$ref": "#/components/schemas/BIC11" }, "instructingAgent": { "description": "The clearing agent that prepares the (file of) transaction instructions and forwards it to the next party in the transaction chain", "$ref": "#/components/schemas/BIC8" }, "transactionId": { "description": "The reference of transaction", "$ref": "#/components/schemas/TransactionId" } }, "required": [ "settlementDateFrom", "settlementDateTo", "transactionId" ] }, "ReportCriteria1": { "type": "object", "properties": { "processCycle": { "description": "The process cycle\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/Cycle" }, "bulkType": { "description": "The bulk type\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/MessageType" } } }, "ReportData": { "description": "Report data.", "type": "string", "format": "binary", "examples": [ "U3dhZ2dlciByb2Nrcw" ] }, "ReportReceivingRequestRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "reportRef": { "description": "The report reference", "$ref": "#/components/schemas/ReportRef" } }, "required": [ "dateTime", "reportRef" ] }, "ReportReceivingRequestResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "report": { "$ref": "#/components/schemas/Report" } }, "required": [ "dateTime" ] }, "ReportRef": { "description": "Report reference.", "type": "string", "minLength": 54, "maxLength": 54, "examples": [ "UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN" ] }, "ReportRef1": { "description": "Report reference.", "type": "string", "maxLength": 54, "examples": [ "UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN" ] }, "ReportRequestRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "reportCriteria": { "$ref": "#/components/schemas/ReportCriteria" } }, "required": [ "dateTime", "reportCriteria" ] }, "ReportRequestResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "reportRef": { "description": "The reference of the report", "$ref": "#/components/schemas/ReportRef1" } }, "required": [ "dateTime", "reportRef" ] }, "Reports": { "type": "object", "properties": { "reportRef": { "description": "The reference of report", "$ref": "#/components/schemas/ReportRef" }, "creationDateTime": { "description": "The creation Date and Time", "$ref": "#/components/schemas/DateTime" }, "reportType": { "description": "The report type", "$ref": "#/components/schemas/ReportType" }, "reportStatus": { "description": "The status of report", "$ref": "#/components/schemas/ReportStatus" } }, "required": [ "reportRef", "creationDateTime", "reportType", "reportStatus" ] }, "Reports1": { "type": "object", "properties": { "reportRef": { "description": "The reference of the report", "$ref": "#/components/schemas/ReportRef1" }, "creationDateTime": { "description": "The creation Date and Time", "$ref": "#/components/schemas/DateTime" }, "reportType": { "description": "The type of report", "$ref": "#/components/schemas/ReportType" }, "reportStatus": { "description": "The status of the report", "$ref": "#/components/schemas/ReportStatus" } }, "required": [ "reportRef", "creationDateTime", "reportType", "reportStatus" ] }, "ReportStatus": { "description": "Status of report.", "type": "string", "enum": [ "WTG", "RDY", "NTF" ], "examples": [ "WTG" ] }, "ReportType": { "description": "Type of report.", "type": "string", "enum": [ "BRE", "TOF" ], "examples": [ "BRE" ] }, "RequestId": { "description": "Request Identification.", "type": "string", "maxLength": 36, "examples": [ "20180501183030100000" ] }, "ResendAll": { "type": "object", "properties": { "commandRef": { "description": "The command reference", "$ref": "#/components/schemas/CommandRef" }, "commandType": { "description": "The command type (F04 for Resend All)", "$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/UserId" }, "userAuthReject": { "description": "The UserID of the user that has authorized or rejected the command", "$ref": "#/components/schemas/UserId" }, "fileType": { "description": "The file type", "$ref": "#/components/schemas/FileType" }, "dateTime": { "description": "The date and time of the last command’s update", "$ref": "#/components/schemas/DateTime" } }, "required": [ "commandRef", "commandType", "commandStatus", "requestDateTime", "authRejectDateTime", "userIssuer", "userAuthReject", "fileType", "dateTime" ] }, "ResendAllRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "resendCriteria": { "$ref": "#/components/schemas/ResendCriteria" } }, "required": [ "dateTime", "resendCriteria" ] }, "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/CommandRef" } }, "required": [ "dateTime", "commandRef" ] }, "ResendCriteria": { "type": "object", "properties": { "fileType": { "description": "The file type\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)\n“ICF”,“IQF” or \"IGF\" values cannot be used\n(errorCode XA07)", "$ref": "#/components/schemas/FileType" }, "dateFrom": { "description": "The oldest date for which the files are requested\n\n **Validation Rule(s)** It cannot be lesser two days to the current calendar date\n(errorCode DT01)", "$ref": "#/components/schemas/Date" }, "dateTo": { "description": "The maximum date for which the files are requested\n\n **Validation Rule(s)** It must be greater than or equal to the dateTimeFrom\n(errorCode DT01)", "$ref": "#/components/schemas/Date" }, "fileReference": { "description": "The file reference", "$ref": "#/components/schemas/FileReference" }, "lac": { "description": "The LAC to which the file refers\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)\nIt can be used only if “file type” is equal to “OQF”, “PCF”, “SCF”, “PSR” or \"RSF\"\n(ErrorCode XA07)", "$ref": "#/components/schemas/Lac" }, "originalFileRef": { "description": "The original file reference", "$ref": "#/components/schemas/FileReference" }, "fileStatus": { "description": "The status of file\n\n **Validation Rule(s)** Only TSG and ERR values can be used\n(errorCode SC01)", "$ref": "#/components/schemas/FileStatusResentAll" }, "reasonCode": { "description": "The validation reason code of the file", "$ref": "#/components/schemas/ReasonCode" } }, "required": [ "fileType", "dateFrom", "dateTo", "fileStatus" ] }, "RetransmitOutFiles": { "type": "object", "properties": { "commandRef": { "description": "The reference of command", "$ref": "#/components/schemas/CommandRef" }, "commandType": { "description": "The type of command (F01 for Retransmit Out Files)", "$ref": "#/components/schemas/CommandType" }, "commandStatus": { "description": "The status of command", "$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/UserId" }, "userAuthReject": { "description": "The UserID of the user that has authorized or rejected the command", "$ref": "#/components/schemas/UserId" }, "fileType": { "description": "The file type", "$ref": "#/components/schemas/FileType" }, "networkFileName": { "description": "The network file name", "$ref": "#/components/schemas/NetworkFileName" }, "settlementDate": { "description": "The settlement date of file", "$ref": "#/components/schemas/DateTime" }, "dateTime": { "description": "The date and time of the last command’s update", "$ref": "#/components/schemas/DateTime" } }, "required": [ "commandRef", "commandType", "commandStatus", "requestDateTime", "authRejectDateTime", "userIssuer", "userAuthReject", "fileType", "networkFileName", "settlementDate", "dateTime" ] }, "RetransmitOutFilesRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "fileRef": { "$ref": "#/components/schemas/FileRef1" } }, "required": [ "dateTime", "fileRef" ] }, "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/CommandRef" } }, "required": [ "dateTime", "commandRef" ] }, "RetransmitOutMessage": { "type": "object", "properties": { "commandRef": { "description": "The relevant command reference", "$ref": "#/components/schemas/CommandRef" }, "commandType": { "description": "The relevant command type (F05 for Retransmit Out Message)", "$ref": "#/components/schemas/CommandType" }, "commandStatus": { "description": "The relevant command status", "$ref": "#/components/schemas/CommandStatus" }, "requestDateTime": { "description": "The date and time when the command was requested.", "$ref": "#/components/schemas/DateTime" }, "authRejectDateTime": { "description": "The date and time when the command was authorized or rejected.", "$ref": "#/components/schemas/DateTime" }, "userIssuer": { "description": "The UserID of the Supervisor that has requested the command.", "$ref": "#/components/schemas/UserId" }, "userAuthReject": { "description": "The UserID of the Supervisor that has authorized or rejected the command", "$ref": "#/components/schemas/UserId" }, "messageType": { "description": "The type of message to be retransmitted.", "$ref": "#/components/schemas/GetMessageType" }, "messageRef": { "description": "The message reference", "$ref": "#/components/schemas/GetMessageRef" }, "dateTime": { "description": "The date and time of the last command’s update.", "$ref": "#/components/schemas/DateTime" } }, "required": [ "commandRef", "commandType", "commandStatus", "requestDateTime", "userIssuer", "messageType", "messageRef", "dateTime" ] }, "RetransmitOutMessagesRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "message": { "$ref": "#/components/schemas/Message1" } }, "required": [ "dateTime", "message" ] }, "RetransmitOutMessagesResponse": { "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/CommandRef" }, "counter": { "description": "The counter of the retransmission requested for the message.\nPossible values: 0 to 5", "$ref": "#/components/schemas/StandardInteger" } }, "required": [ "dateTime", "commandRef", "counter" ] }, "ReturnAccountDetails": { "type": "object", "properties": { "settlementBIC": { "description": "The settlement BIC for which the position is enquired", "$ref": "#/components/schemas/BIC11Only" }, "position": { "description": "The position retrieved at the relevant positionTimestamp", "$ref": "#/components/schemas/Amount" }, "positionTimestamp": { "description": "The timestamp at which the position is retrieved", "$ref": "#/components/schemas/DateTime" } }, "required": [ "settlementBIC", "position", "positionTimestamp" ] }, "ReturnAccountQueryResponseError": { "type": "object", "properties": { "reasonCode": { "description": "The Reason Code of the message", "$ref": "#/components/schemas/GetMessageReasonCode" } }, "required": [ "reasonCode" ] }, "ReturnTransaction": { "type": "object", "properties": { "instructingSettlementBIC": { "description": "The settlement BIC of the Instructing DP BIC", "$ref": "#/components/schemas/BIC11Only" }, "instructingDPBIC": { "description": "The DP sending the LCR for which the enquiry is requested", "$ref": "#/components/schemas/BIC8" }, "instructedSettlementBIC": { "description": "The settlement BIC of the Instructed DP BIC", "$ref": "#/components/schemas/BIC11Only" }, "instructedDPBIC": { "description": "The Instructed DP of the LCR for which the enquiry is requested", "$ref": "#/components/schemas/BIC8" }, "lcrStatusUpdate": { "description": "This section is repeated as many times as the status of relevant LCR has changed", "type": "array", "items": { "$ref": "#/components/schemas/LcrStatusUpdate" } }, "totalLCRNumber": { "description": "The total number of debit queued LCRs listed in the relevant camt.006", "$ref": "#/components/schemas/StandardInteger" }, "totalLCRAmount": { "description": "The total amount of debit queued LCRs listed in the relevant camt.006", "$ref": "#/components/schemas/StandardAmount1" } } }, "RoutingType": { "description": "Routing Type.", "type": "string", "enum": [ "DIR", "IND" ], "examples": [ "DIR" ] }, "SearchCriteria": { "type": "object", "properties": { "name": { "description": "The name of the participant", "$ref": "#/components/schemas/ParticipantName" }, "BICCode": { "description": "The BIC of the DP", "$ref": "#/components/schemas/BIC8" }, "initParticipantValidity": { "description": "The initial validity date of the DP", "$ref": "#/components/schemas/Date" }, "endParticipantValidity": { "description": "The end validity date of the DP", "$ref": "#/components/schemas/Date" }, "status": { "description": "The status of the DP\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/ParticipantStatus" }, "AOSParam": { "description": "The AOS to which the DP adheres\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/AOSParam" }, "technicalBIC": { "description": "Whether the DP is a technical BIC\n\n **Validation Rule(s)** It can contain only\ntrue= Technical BIC\nfalse= No Technical BIC\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "nightTimeSettlement": { "description": "Whether the DP is configured to settle in CGS for Night Time Settlement for T2I\n\n **Validation Rule(s)** It can contain only\ntrue= configured for CGS Night Time Settlement\nfalse= not configured for CGS Night Time Settlement\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "network": { "description": "The network channel used by the DP\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/Network" } } }, "SearchCriteria1": { "type": "object", "properties": { "name": { "description": "The name of the relevant RB", "$ref": "#/components/schemas/ParticipantName1" }, "BICCode": { "description": "The RB BIC", "$ref": "#/components/schemas/Bic11Only" }, "initParticipantValidity": { "description": "The Initial validity date of the RB", "$ref": "#/components/schemas/Date" }, "endParticipantValidity": { "description": "The end validity date of the RB", "$ref": "#/components/schemas/Date" }, "status": { "description": "The status of the RB\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/ParticipantStatus" }, "DPBICCode": { "description": "The DP BIC", "$ref": "#/components/schemas/BIC8" }, "AOS": { "description": "The AOS to which the RB adheres\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/AOSParam1" } } }, "SearchCriteria10": { "type": "object", "properties": { "reportRef": { "description": "The reference of report", "$ref": "#/components/schemas/ReportRef1" }, "creationDateTimeFrom": { "description": "The creation Date and Time - From\n\n **Validation Rule(s)** It must be previous or equal to the current date and time\n(errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "creationDateTimeTo": { "description": "The creation Date and Time - To\n\n **Validation Rule(s)** It must be greater than or equal to the dateTimeFrom\n(errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "reportStatus": { "description": "The status of report\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/ReportStatus" } } }, "SearchCriteria11": { "type": "object", "properties": { "commandType": { "description": "The command type", "$ref": "#/components/schemas/CommandType" }, "commandStatus": { "description": "The command status", "$ref": "#/components/schemas/CommandStatus" }, "requestDateTimeFrom": { "description": "The date and time of the request - from", "$ref": "#/components/schemas/DateTime" }, "requestDateTimeTo": { "description": "The date and time of the request - to", "$ref": "#/components/schemas/DateTime" }, "authRejectDateTimeFrom": { "description": "The date and time of the authorization/rejection - from", "$ref": "#/components/schemas/DateTime" }, "authRejectDateTimeTo": { "description": "The date and time of the authorization/rejection - to", "$ref": "#/components/schemas/DateTime" }, "userIssuer": { "description": "The user who issued the command", "$ref": "#/components/schemas/UserId" }, "userAuthReject": { "description": "The user who authorized/rejected the command", "$ref": "#/components/schemas/UserId" } } }, "SearchCriteria12": { "type": "object", "properties": { "dateTimeFrom": { "description": "The Date and Time of the alert - From\n\n **Validation Rule(s)** It must be previous or equal to the current date and time\n(errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "dateTimeTo": { "description": "The Date and Time of the alert - To\n\n **Validation Rule(s)** It must be greater than or equal to the dateTimeFrom\n(errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "eventDescription": { "description": "The description of the alert", "$ref": "#/components/schemas/EventDescription" }, "issuer": { "description": "The issuer of the alert", "$ref": "#/components/schemas/UserId" }, "authorizer": { "description": "The authorizer of the alert", "$ref": "#/components/schemas/UserId" } } }, "SearchCriteria13": { "type": "object", "properties": { "instructingDPBIC": { "description": "The Instructing Agent BIC\n\n **Validation Rule(s)** Must be present if the Instructed Agent BIC has not been set (errorCode XA04).\nEither the Instructing Agent or the Instructed Agent must be set with the DP BIC configured for the User (errorCode XA07).", "$ref": "#/components/schemas/BIC8" }, "instructedDPBIC": { "description": "The Instructed Agent BIC\n\n **Validation Rule(s)** Must be present if the Instructing Agent BIC has not been set (errorCode XA04).\nEither the Instructing Agent or the Instructed Agent must be set with the DP BIC configured for the User (errorCode XA07).", "$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" }, "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" }, "referenceLCR": { "description": "The LCR reference", "$ref": "#/components/schemas/FileReference" }, "bulkType": { "description": "The bulk type to which the LCR relates\n\n **Validation Rule(s)** Possible values are:\n• pacs.004\n• pacs.008\n(errorCode XA07)", "$ref": "#/components/schemas/BulkType" }, "lac": { "description": "The LAC in which the relevant LCR closed its life-cycle\n\n **Validation Rule(s)** It must be a valid LAC\n(errorCode SC01)", "$ref": "#/components/schemas/Lac" }, "lcrStatus": { "description": "The status of the LCR\n\n **Validation Rule(s)** It must be a valid code\n(errorCode SC01)", "$ref": "#/components/schemas/LcrStatus" }, "offset": { "description": "The offset is used in order to manage the pagination\n\n **Validation Rule(s)** If used, it has to contain the same value of the offset present in the previous \"listLCR – Positive Response Body”", "$ref": "#/components/schemas/Offset" } }, "required": [ "settlementDateFrom", "settlementDateTo" ] }, "SearchCriteria14": { "type": "object", "properties": { "settlementDate": { "description": "LCR Settlement date", "$ref": "#/components/schemas/Date" }, "referenceLCR": { "description": "The LCR reference", "$ref": "#/components/schemas/FileReference" }, "lac": { "description": "The LAC in which the relevant LCR has closed its life-cycle\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/Lac" }, "lcrStatus": { "description": "The status of LCR\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/LcrStatus" } }, "required": [ "referenceLCR" ] }, "SearchCriteria2": { "type": "object", "properties": { "DPRBOperation": { "description": "Whether the operation refers to a Direct Participant or a Reachable BIC\n\n **Validation Rule(s)** Possible values:\n- DIR, if the command is referred to DP\n- IND, if the command is referred to an RB\n(errorCode SC01)", "$ref": "#/components/schemas/DPRBOperation" }, "DPBICCode": { "description": "The DP related to the request.\n\n **Validation Rule(s)** For participants, it must correspond to the Sender BIC\n(errorCode PY01)", "$ref": "#/components/schemas/BIC8" }, "RBBICCode": { "description": "The Reachable BIC related to the request\n\n **Validation Rule(s)** It must correspond to an RB listed in routing table under the senderBIC\n(errorCode PY01)", "$ref": "#/components/schemas/Bic11Only" }, "operationType": { "description": "The operation type:\nINS for “Insert”\nREM for “Remove”\nUPD for “Update”\nBRI for “Insert BRT”\nBRR for “Remove BRT”\nMOD for “Amend Change”\nREV for “Revoke Change”\nCDP for “RB Change DP”\n\n **Validation Rule(s)** The type of the operation. It must be set with one of the values configured in the system\n(errorCode SC01)", "$ref": "#/components/schemas/OperationType" }, "operationRef": { "description": "The reference id of the operation", "$ref": "#/components/schemas/OperationReference" }, "effectiveDate": { "description": "The effective date of the operation.", "$ref": "#/components/schemas/Date" }, "operationStatus": { "description": "The operation status. Possible values:\nAUT for “Authorized”\nEXE for “Executed”\nREJ for “Rejected by User”\nRJS for “Rejected by System”\nTBA for “To Be Authorized”\nTBC for \"Submitted\"\n\n **Validation Rule(s)** The status of the operation. It must be set with one of the values configured in the system\n(errorCode SC01)", "$ref": "#/components/schemas/OperationStatus" }, "requestDate": { "description": "The date of the request", "$ref": "#/components/schemas/Date" }, "confirmDate": { "description": "The date of the confirmation by Participant User.\nApplicable only in case of “Critical” operation", "$ref": "#/components/schemas/Date" }, "authRejectDate": { "description": "The date of authorization/rejection", "$ref": "#/components/schemas/Date" }, "userIssuer": { "description": "The user Id of the user who issued the operation", "$ref": "#/components/schemas/UserId" }, "confirmer": { "description": "The user Id of the user who confirmed the operation.\nApplicable only in case of “Critical” operation", "$ref": "#/components/schemas/UserId" }, "userAuthReject": { "description": "The user Id of the user who authorized/rejected the operation", "$ref": "#/components/schemas/UserId" }, "critical": { "description": "Whether the operation is critical\ntrue= critical operation\nfalse=non-critical operation\n\n **Validation Rule(s)** It must be set with one of the configured values\n(errorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" } } }, "SearchCriteria3": { "type": "object", "properties": { "creditPartyBIC": { "description": "The BIC of the credit party", "$ref": "#/components/schemas/BIC8" } } }, "SearchCriteria4": { "type": "object", "properties": { "interbankSettlementDate": { "description": "The relevant interbank settlement date", "$ref": "#/components/schemas/Date" }, "lac": { "description": "The relevant LAC", "$ref": "#/components/schemas/Lac" }, "counterpartyBIC": { "description": "The BIC of the counterparty (Credit BIC)", "$ref": "#/components/schemas/BIC8" } }, "required": [ "interbankSettlementDate" ] }, "SearchCriteria5": { "type": "object", "properties": { "type": { "description": "The option to specify if the searched transaction has been sent or received by the involved Participant\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/SentReceived" }, "DPInstructingBIC": { "description": "The clearing agent that sends the (file of) transaction instructions\n\n **Validation Rule(s)** Cannot be used at the same time as Instructed Agent (below)\n(errorCode XA07)\nIt can be used if the type is equal to “RCV”\n(errorCode XA07)", "$ref": "#/components/schemas/BIC8" }, "DPInstructedBIC": { "description": "The clearing agent that receives the (file of) transaction instructions\n\n **Validation Rule(s)** Cannot be used at the same time as Instructing Agent (below)\n(errorCode XA07)\nIt can be used if the type is equal to “SNT” (errorCode XA07)", "$ref": "#/components/schemas/BIC8" }, "transactionType": { "description": "The type of transaction to be enquired\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/MessageType" }, "transactionStatus": { "description": "The status of transaction to be enquired\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/TransactionStatus" }, "transactionId": { "description": "The reference assigned by the DP to the transaction instruction", "$ref": "#/components/schemas/TransactionId" }, "processingDate": { "description": "The STEP2 business date opened when the transaction was processed\n\n **Validation Rule(s)** It must be lesser or equal to the current calendar date and timestamp\n (errorCode DT01)", "$ref": "#/components/schemas/Date" }, "interbankSettlDate": { "description": "The Target date when funds cease to be available to the agent who owes the funds and when funds become available to the agent whom funds are due to", "$ref": "#/components/schemas/Date" }, "lac": { "description": "The LAC to which transaction is related. It corresponds to the LAC when the transaction closed its life-cycle. Not available for rejected transactions.\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/Lac" }, "creditorBankBIC": { "description": "Financial institution that receives the transaction from either the account owner or authorized party and processes the instructions", "$ref": "#/components/schemas/BIC11" }, "debtorBankBIC": { "description": "The financial institution that receives the transaction instruction on behalf of the account owner or other nominated party and applies the transaction to the account", "$ref": "#/components/schemas/BIC11" }, "ICFReference": { "description": "The reference identifier of the ICF file, which included this transaction", "$ref": "#/components/schemas/FileReference" }, "IQFReference": { "description": "The reference identifier of the IQF file, which included this transaction", "$ref": "#/components/schemas/FileReference" }, "bulkReference": { "description": "The relevant ICF bulk reference", "$ref": "#/components/schemas/BulkReference" }, "CVFReference": { "description": "The relevant CVF file reference related to this transaction", "$ref": "#/components/schemas/FileReference" }, "QVFReference": { "description": "The relevant QVF file reference related to this transaction", "$ref": "#/components/schemas/FileReference" }, "SCFReference": { "description": "The relevant SCF file reference, which included this transaction, sent to the Participant after settlement", "$ref": "#/components/schemas/FileReference" }, "OQFReference": { "description": "The relevant OQF file reference, which included this transaction, sent to the Participant after settlement", "$ref": "#/components/schemas/FileReference" }, "RSFReference": { "description": "The relevant RSF file reference, which included this transaction, sent to the Participant after settlement", "$ref": "#/components/schemas/FileReference" }, "LCRReference": { "description": "The reference of the LCR related to this transactions", "$ref": "#/components/schemas/LcrReference" }, "routingType": { "description": "The routing applied by the STEP2 central system to deliver this transaction\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/RoutingType" }, "amountRangeFrom": { "description": "A range of values for the amount of the searched payment instructions\n\n **Validation Rule(s)** Only decimal notation is allowed\n(errorCode XA05)", "$ref": "#/components/schemas/StandardAmount1" }, "amountRangeTo": { "description": "A range of values for the amount of the searched payment instructions\n\n **Validation Rule(s)** Only decimal notation is allowed\n(errorCode XA05)", "$ref": "#/components/schemas/StandardAmount1" }, "originalTransactionId": { "description": "The original reference of the transaction (only for PCR/ROI transactions)", "$ref": "#/components/schemas/TransactionId" }, "originalSettlementDate": { "description": "The original settlement date when the original transaction was settled (only for PCR/ROI and Payment Status Request transactions)", "$ref": "#/components/schemas/Date" }, "originalAmount": { "description": "The Original amount of the transaction (only for PCR/ROI transactions)\n\n **Validation Rule(s)** Only decimal notation is allowed\n(errorCode XA05)", "$ref": "#/components/schemas/StandardAmount1" }, "creditPartyBIC": { "description": "The Credit Party", "$ref": "#/components/schemas/BIC8" }, "debitPartyBIC": { "description": "The Debit Party", "$ref": "#/components/schemas/BIC8" } }, "required": [ "type", "transactionType", "transactionStatus", "processingDate" ] }, "SearchCriteria6": { "type": "object", "properties": { "fileType": { "description": "The type of file\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/FileType1" }, "messageType": { "description": "The type of message\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/MessageType" }, "fileReference": { "description": "The reference of file", "$ref": "#/components/schemas/FileReference" }, "bulkStatus": { "description": "The status of bulk\n\n **Validation Rule(s)** It can be used only if the File Type is equal to “ICF” or “IQF”\n(errorCode XA07)", "$ref": "#/components/schemas/BulkStatus" }, "bulkReference": { "description": "The reference of bulk", "$ref": "#/components/schemas/BulkReference" }, "date": { "description": "The date of STEP2 CS of the bulk header", "$ref": "#/components/schemas/Date" }, "dateType": { "description": "The \"type of date\" of STEP2 CS of the bulk header\n\n **Validation Rule(s)** Possible values are:\n• Calendar date\n• Business date\n• Settlement Date\nErrorCodeSC01", "$ref": "#/components/schemas/DateType" }, "lac": { "description": "The LAC to which this bulk is related. Only available for bulks included in Output files generated for Participants configured for settling in CGS.\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)\nIt cannot be used if if “file type” is equal to “ICF”, “IQF”, “CVF” or “QVF” (ErrorCode XA07)", "$ref": "#/components/schemas/Lac" } }, "required": [ "fileType", "dateType" ] }, "SearchCriteria7": { "type": "object", "properties": { "fileType": { "description": "The file type\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/FileType" }, "dateTimeFrom": { "description": "The oldest date and time of the reception or sending of the files by the system\n\n **Validation Rule(s)** It must be previous or equal to the current date and time\n(errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "dateTimeTo": { "description": "The maximum date and time for which the files are requested\n\n **Validation Rule(s)** It must be greater than or equal to the dateTimeFrom\n(errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "dateType": { "description": "The date type for which the files are requested\n\n **Validation Rule(s)** The Type of Date. The possible values are:\n- Business Date\n- Calendar Date\nErrorCode SC01", "$ref": "#/components/schemas/DateType1" }, "fileReference": { "description": "The file reference", "$ref": "#/components/schemas/FileReference" }, "lac": { "description": "The LAC to which file is related. Only available for Output files generated for Participants configured to settle in CGK.\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/Lac" }, "lacIndicator": { "description": "Allowed values:\n• true = the output file has been generated at LAC sending Cut-Off\n• false = the output file has been generated intra-LAC\n\n **Validation Rule(s)** Only available for:\n- RSF\n- SCF\n(ErrorCode SC01)", "$ref": "#/components/schemas/GenericBoolean" }, "originalFileRef": { "description": "The original file reference. This criterion is only relevant for “ICF”/ “IQF”/ “IGF” and “CVF/”QVF\"/ “OGF” files. If the fileType criterion is set to “ICF”, ”IQF” or “IGF”, this field can be used to search respectively the “CVF”, ”QVF” or “OGF” file reference which this file relates to. If the fileType criterion is set to “CVF”, ”QVF” or “OGF”, this field can be used to search the Sender’s File Reference respectively of the “ICF”, ”IQF” or “IGF” which this file relates to.", "$ref": "#/components/schemas/FileReference" }, "fileStatus": { "description": "The file status", "$ref": "#/components/schemas/FileStatusALL" }, "reasonCode": { "description": "The validation reason code associated to the file", "$ref": "#/components/schemas/ReasonCode" } }, "required": [ "fileType", "dateType" ] }, "SearchCriteria8": { "type": "object", "properties": { "fileType": { "description": "The file type in which the relevant message is sent/received.\n\n **Validation Rule(s)** Mandatory for messages sent via file\n(errorCode SC01)\nOnly \"IGF\" and \"OGF\" values can be used\n(errorCode SC01)", "$ref": "#/components/schemas/FileType" }, "messageType": { "description": "The relevant message type\n\n **Validation Rule(s)** It must be set with one of the values configured in the system\n(errorCode SC01)", "$ref": "#/components/schemas/GetMessageType" }, "senderReceiverBIC": { "description": "The BIC sending/receiving the message\n\n **Validation Rule(s)** The BIC must be equal to the senderBIC\n(errorCode PY01)", "$ref": "#/components/schemas/BIC8" }, "dateTimeFrom": { "description": "The start date and time of the relevant search timespan\n\n **Validation Rule(s)** It must be previous or equal to the current date and time (errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "dateTimeTo": { "description": "The end date of the relevant search timespan\n\n **Validation Rule(s)** It must be greater than or equal to the dateTimeFrom (errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "messageRef": { "description": "The reference ID of the message", "$ref": "#/components/schemas/GetMessageRef" }, "originalMessageRef": { "description": "The original message reference\n\n **Validation Rule(s)** The original message reference. Applicable only to:\n• Camt.004\n• Camt.006\n(errorCode XA07)", "$ref": "#/components/schemas/GetMessageRef" }, "messageStatus": { "description": "The status of the relevant message.\nPossible values:\n• RCV – Received: received messages; applicable to camt.003 and camt.005\n• VAL – Validated: validate messages; applicable to camt.003 and camt.005\n• RJS – Rejected by CS: rejected by STEP2; applicable to camt.003 and camt.005. Messages in RJS status can be retrieved starting from both IGF and OGF.\n• TSD – Transmitted: the output message is sent to the sender BIC; applicable to camt.004 and camt.006;\n• TSG – Transmitting: the message has been created and not yet sent, or it’s in the process of being transmitted; applicable to camt.004 and camt.006;\n• ERR – Error: the output message sending failed\n\n **Validation Rule(s)** If filled in, it must be set with one of the values configured in the system and applicable to the relevant message type\n(errorCode SC01)\nThe field is available only for messages sent/received via Swiftnet\n(errorCode SC01)", "$ref": "#/components/schemas/GetMessageStatus" }, "reasonCode": { "description": "The validation reason code associated to the message", "$ref": "#/components/schemas/GetMessageReasonCode" }, "IGFFileRef": { "description": "The reference of the relevant IGF\nApplicable only for messages sent into files via SIANet or EBICS", "$ref": "#/components/schemas/FileReference" }, "OGFFileRef": { "description": "The reference of the relevant OGF\nApplicable only for messages sent into files via SIANet or EBICS", "$ref": "#/components/schemas/FileReference" }, "network": { "description": "The network through which the message is received\n\n **Validation Rule(s)** If filled in, it must be set with one of the values configured in the system\nPossible values:\nSWF, \"Swiftnet single request type\"\nSWA, \"Swiftnet multiple request type\"\nFXS, \"SIAnet.XS\"\nEBX, \"EBICS Network\"\nSWS, \"SWIFTNet S&F Single Request Type\"\nSWM, \"SWIFTNet S&F Multiple Request Type\"\n(errorCode SC01)", "$ref": "#/components/schemas/Network2" } }, "required": [ "messageType", "senderReceiverBIC" ] }, "SearchCriteria9": { "type": "object", "properties": { "reportRef": { "description": "The reference of report", "$ref": "#/components/schemas/ReportRef" }, "creationDateTimeFrom": { "description": "The creation Date and Time - From\n\n **Validation Rule(s)** It must be previous or equal to the current date and time\n(errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "creationDateTimeTo": { "description": "The creation Date and Time - To\n\n **Validation Rule(s)** It must be greater than or equal to the dateTimeFrom\n(errorCode DT01)", "$ref": "#/components/schemas/DateTime" }, "reportStatus": { "description": "The status of report\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/ReportStatus" } } }, "SenderBIC": { "description": "BIC searching.", "type": "string", "pattern": "[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}", "examples": [ "BICSCT01" ] }, "SentReceived": { "description": "The direction of transaction.", "type": "string", "enum": [ "SNT", "RCV" ], "examples": [ "SNT" ] }, "SettlementFile": { "description": "Number of file.", "type": "integer", "examples": [ 1 ] }, "SettlementFile1": { "description": "Number of file.", "type": "integer", "minimum": 1, "maximum": 3, "examples": [ 1 ] }, "Sign": { "description": "sign", "type": "string", "enum": [ "C", "D" ], "examples": [ "C" ] }, "StandardAmount": { "description": "Standard Amount.", "type": "number", "format": "double", "maximum": 999999999999.99, "examples": [ 10000.01 ] }, "StandardAmount1": { "description": "Standard Amount.", "type": "number", "format": "double", "maximum": 1000000000000000, "examples": [ 10000.01 ] }, "StandardInteger": { "description": "Standard Integer.", "type": "integer", "format": "int32", "examples": [ 1000 ] }, "String8": { "description": "String length 8", "type": "string", "maxLength": 8, "examples": [ "Alert001" ] }, "ThirdPoleReportReceivingRequestRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "reportRef": { "description": "The reference of the report", "$ref": "#/components/schemas/ReportRef1" } }, "required": [ "dateTime", "reportRef" ] }, "ThirdPoleReportReceivingRequestResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API response creation", "$ref": "#/components/schemas/DateTime" }, "report": { "$ref": "#/components/schemas/Report" } }, "required": [ "dateTime" ] }, "ThirdPoleReportRequestRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "reportCriteria": { "$ref": "#/components/schemas/ReportCriteria1" } }, "required": [ "dateTime" ] }, "ThirdPoleReportRequestResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" } }, "required": [ "dateTime" ] }, "TimeIndicator": { "type": "string", "pattern": "[0-9]{2,2}:[0-9]{2,2}", "examples": [ "16:00" ] }, "Transaction": { "type": "object", "properties": { "transactionType": { "description": "The transaction type", "$ref": "#/components/schemas/MessageType" }, "lac": { "description": "The LAC received from the CGS when the transaction closed its life-cycle.\nNot available for rejected transactions.", "$ref": "#/components/schemas/Lac" }, "processingDate": { "description": "The STEP2 business date when the transaction was processed", "$ref": "#/components/schemas/Date" }, "interbankSettlementDate": { "description": "The settlement date when funds cease to be available to the agent who owes the funds and when funds become available to the agent whom funds are due to", "$ref": "#/components/schemas/Date" }, "orderingDate": { "description": "The Ordering Date of the transaction", "$ref": "#/components/schemas/Date" }, "routingType": { "description": "The routing applied by the STEP2 central system to deliver this transaction", "$ref": "#/components/schemas/RoutingType" }, "DPInstructingBIC": { "description": "The clearing agent that prepares the (file of) transaction instructions and forwards it to the next party in the transaction chain", "$ref": "#/components/schemas/BIC8" }, "DPInstructedBIC": { "description": "The clearing agent that receives the (file of) transaction instructions", "$ref": "#/components/schemas/BIC8" }, "debtorBankBIC": { "description": "The financial institution that receives the transaction instruction on behalf of the account owner or other nominated party and applies the transaction to the account", "$ref": "#/components/schemas/BIC11" }, "creditorBankBIC": { "description": "Financial institution that receives the transaction from either the account owner or authorized party and processes the instructions", "$ref": "#/components/schemas/BIC11" }, "orderingCustomer": { "description": "The ordering customer description/name", "$ref": "#/components/schemas/CustomerName" }, "beneficiaryCustomer": { "description": "The beneficiary customer description/name", "$ref": "#/components/schemas/CustomerName" }, "orderingAccountNumber": { "description": "The ordering IBAN account", "$ref": "#/components/schemas/IBAN" }, "beneficiaryAccountNumber": { "description": "The beneficiary IBAN account", "$ref": "#/components/schemas/IBAN" }, "debitPartyBIC": { "description": "The Settlement System Debit Party", "$ref": "#/components/schemas/BIC11" }, "creditPartyBIC": { "description": "The Settlement System Credit Party", "$ref": "#/components/schemas/BIC11" }, "ICFReference": { "description": "The reference identifier of the ICF file, which included this transaction", "$ref": "#/components/schemas/FileReference" }, "bulkReference": { "description": "The bulk reference of the ICF file, which included this transaction", "$ref": "#/components/schemas/BulkReference" }, "IQFReference": { "description": "The reference identifier of the IQF file, which included this transaction", "$ref": "#/components/schemas/FileReference" }, "CVFReference": { "description": "The relevant CVF file reference related to this transaction", "$ref": "#/components/schemas/FileReference" }, "QVFReference": { "description": "The relevant QVF file reference related to this transaction", "$ref": "#/components/schemas/FileReference" }, "SCFReference": { "description": "The relevant SCF file reference, which included this transaction, sent to the Participant after settlement", "$ref": "#/components/schemas/FileReference" }, "OQFReference": { "description": "The relevant OQF file reference, which included this transaction, sent to the Participant after settlement", "$ref": "#/components/schemas/FileReference" }, "RSFReference": { "description": "The relevant RSF file reference, which included this transaction, sent to the Participant after settlement", "$ref": "#/components/schemas/FileReference" }, "transactionId": { "description": "The reference assigned by the DP to the transaction instruction", "$ref": "#/components/schemas/TransactionId" }, "transactionStatus": { "description": "The status of transaction to be enquired", "$ref": "#/components/schemas/TransactionStatus" }, "amountValue": { "description": "The amount of the transaction", "$ref": "#/components/schemas/StandardAmount1" }, "LCRReference": { "description": "The reference of the LCR which included this transaction", "$ref": "#/components/schemas/LcrReference" }, "settlementReference": { "description": "The reference of the Settlement Instruction related to these transactions", "$ref": "#/components/schemas/BulkReference" }, "originalAmount": { "description": "The Original amount of the transaction (only for PCR/ROI transactions)", "$ref": "#/components/schemas/StandardAmount1" }, "reasonCode": { "description": "The Reason Code of the transaction", "$ref": "#/components/schemas/ReasonCodeTransaction" }, "originalTransactionId": { "description": "The original reference of the transaction (only for PCR/ROI transactions)", "$ref": "#/components/schemas/TransactionId" }, "originalSettlementDate": { "description": "The original settlement date when the original transaction was settled (only for PCR/ROI and Payment Status Request transactions)", "$ref": "#/components/schemas/Date" }, "endToEndId": { "description": "The End To End Id. This field:\n- can be populated with both transaction field “EndToEnd Id” (when data retrieved are related to pacs.008) and “Original End to End Id” (when data retrieved are related to any other message different than pacs.008)\n- is always returned as \"collapsed”", "$ref": "#/components/schemas/EndToEndId" } }, "required": [ "transactionType", "processingDate", "interbankSettlementDate", "orderingDate", "routingType", "DPInstructingBIC", "DPInstructedBIC", "debtorBankBIC", "creditorBankBIC", "orderingCustomer", "beneficiaryCustomer", "orderingAccountNumber", "beneficiaryAccountNumber", "debitPartyBIC", "creditPartyBIC", "bulkReference", "transactionId", "transactionStatus", "amountValue" ] }, "TransactionDetailsRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "transactionRef": { "$ref": "#/components/schemas/TransactionRef" } }, "required": [ "dateTime", "transactionRef" ] }, "TransactionDetailsResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "transaction": { "$ref": "#/components/schemas/Transaction" } }, "required": [ "dateTime" ] }, "TransactionId": { "description": "Transaction reference.", "type": "string", "pattern": "([A-Za-z0-9]|[+|\\?|/|\\-|:|\\(|\\)|\\.|,|']){1,35}", "examples": [ "TESTTRANSEF135000000000000000000123" ] }, "TransactionRef": { "type": "object", "properties": { "type": { "description": "The option to specify if the searched transaction has been sent or received by the involved Participant\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/SentReceived" }, "transactionType": { "description": "The type of transaction to be enquired\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/MessageType" }, "interbankSettlementDate": { "description": "The Interbank settlement date of the transaction", "$ref": "#/components/schemas/Date" }, "transactionId": { "description": "The reference assigned by the DP to the transaction instruction", "$ref": "#/components/schemas/TransactionId" }, "transactionStatus": { "description": "The status of the transaction\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/TransactionStatus" }, "debtorBankBIC": { "description": "The BIC of the Debtor PSP\n\n **Validation Rule(s)** Mandatory if Credit PSP BIC is not set\n(errorCode XA07)", "$ref": "#/components/schemas/BIC11" }, "creditorBankBIC": { "description": "The BIC of the Creditor PSP\n\n **Validation Rule(s)** Mandatory if Debtor PSP BIC is not set\n(errorCode XA07)", "$ref": "#/components/schemas/BIC11" }, "lac": { "description": "The LAC to which transaction is related. It corresponds to the LAC when the transaction closed its life-cycle. Not available for rejected transactions.\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/Lac" } }, "required": [ "transactionId" ] }, "TransactionRef1": { "type": "object", "properties": { "type": { "description": "The option to specify if the searched transaction has been sent or received by the involved Participant\n\n **Validation Rule(s)** It can be set only with a configured value in the system\n(errorCode SC01)", "$ref": "#/components/schemas/SentReceived" }, "transactionType": { "description": "The type of transaction", "$ref": "#/components/schemas/MessageType" }, "interbankSettlementDate": { "description": "The Interbank settlement date of the transaction", "$ref": "#/components/schemas/Date" }, "transactionId": { "description": "The Id of transaction", "$ref": "#/components/schemas/TransactionId" }, "transactionStatus": { "description": "The status of the transaction", "$ref": "#/components/schemas/TransactionStatus" }, "debtorBankBIC": { "description": "The BIC of the debtor bank", "$ref": "#/components/schemas/BIC11" }, "creditorBankBIC": { "description": "The BIC of the creditor bank", "$ref": "#/components/schemas/BIC11" }, "lac": { "description": "The LAC running when the transaction was settled or processed.\nIt can be retrieved transaction in status STD or CNL\n\n **Validation Rule(s)** It must be set with one of the LAC values provided by the system\n(errorCode SC01)", "$ref": "#/components/schemas/Lac" } }, "required": [ "transactionId", "transactionStatus" ] }, "Transactions": { "type": "object", "properties": { "type": { "description": "The direction of the transaction (send/receive)", "$ref": "#/components/schemas/SentReceived" }, "transactionType": { "description": "The type of transaction to be enquired", "$ref": "#/components/schemas/MessageType" }, "processingDate": { "description": "The STEP2 business date opened when the transaction was processed", "$ref": "#/components/schemas/Date" }, "lac": { "description": "The LAC received from the CGS when the transaction closed its life-cycle. Not available if:\n- rejected transactions.", "$ref": "#/components/schemas/Lac" }, "transactionId": { "description": "The reference assigned by the DP to the transaction instruction", "$ref": "#/components/schemas/TransactionId" }, "DPInstructingBIC": { "description": "The clearing agent that prepares the (file of) transaction instructions and forwards it to the next party in the transaction chain", "$ref": "#/components/schemas/BIC8" }, "DPInstructedBIC": { "description": "The clearing agent that receives the (file of) transaction instructions", "$ref": "#/components/schemas/BIC8" }, "transactionStatus": { "description": "The status of transaction to be enquired", "$ref": "#/components/schemas/TransactionStatus" }, "interbankSettlementAmount": { "description": "The amount of the searched payment instructions", "$ref": "#/components/schemas/StandardAmount1" }, "interbankSettlementDate": { "description": "The Target date when funds cease to be available to the agent who owes the funds and when funds become available to the agent whom funds are due to", "$ref": "#/components/schemas/Date" }, "originalSettlementDate": { "description": "The original settlement date when the original transaction was settled (only for PCR/ROI and Payment Status Request transactions)", "$ref": "#/components/schemas/Date" }, "debtorBankBIC": { "description": "The financial institution that receives the transaction instruction on behalf of the account owner or other nominated party and applies the transaction to the account", "$ref": "#/components/schemas/BIC11" }, "creditorBankBIC": { "description": "The financial institution that receives the transaction from either the account owner or authorized party and processes the instructions", "$ref": "#/components/schemas/BIC11" } }, "required": [ "transactionType", "processingDate", "transactionId", "DPInstructingBIC", "DPInstructedBIC", "transactionStatus", "interbankSettlementAmount", "interbankSettlementDate", "type", "debtorBankBIC", "creditorBankBIC" ] }, "TransactionStatus": { "description": "Status of the transaction.", "type": "string", "enum": [ "VAL", "STG", "STD", "CNL", "RJS", "RFC", "NTF" ], "examples": [ "STG" ] }, "UpdateDefaultThresholdRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "defaultThreshold": { "$ref": "#/components/schemas/DefaultThreshold" } }, "required": [ "dateTime", "defaultThreshold" ] }, "UpdateDefaultThresholdResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" } }, "required": [ "dateTime" ] }, "UpdateDirectParticipantRequest": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "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 (errorCode XA22)", "$ref": "#/components/schemas/Date" }, "parameters": { "$ref": "#/components/schemas/Parameters1" } }, "required": [ "dateTime", "effectiveDate", "parameters" ] }, "UpdateDirectParticipantResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "operationRef": { "description": "The reference assigned by the system to the \"Update\" operation", "$ref": "#/components/schemas/OperationReference" } }, "required": [ "dateTime", "operationRef" ] }, "UpdateReachableBICRequest": { "type": "object", "properties": { "dateTime": { "description": "The date time of the API Request creation", "$ref": "#/components/schemas/DateTime" }, "RBBICCode": { "description": "The relevant RB BIC\n\n **Validation Rule(s)** It must have status “Enabled”, “R-Only” or “Suspended”\n(errorCode PY01)\nIt must be listed in Routing Table under the senderBIC\n(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 (errorCode XA22)", "$ref": "#/components/schemas/Date" }, "parameters": { "$ref": "#/components/schemas/Parameters2" } }, "required": [ "dateTime", "RBBICCode", "effectiveDate", "parameters" ] }, "UpdateReachableBICResponse": { "type": "object", "properties": { "dateTime": { "description": "The date and time of the API Response creation", "$ref": "#/components/schemas/DateTime" }, "operationRef": { "description": "The reference assigned by the system to the \"Update\" operation", "$ref": "#/components/schemas/OperationReference" } }, "required": [ "dateTime", "operationRef" ] }, "UserId": { "description": "User.", "type": "string", "pattern": "(\\S+.*){8,8}", "examples": [ "APIUSER1" ] }, "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" } } } } } }