Number of APIs: 26
STEP2 System CGS Module - API Specifications Annex Based on: EBACLSTEP220220330OpenApiCGSAPIParticipant130v20220613.yaml Contact Support:
Email: api@ebaclearing.eu
POST {{baseUrl}}/listSettlementBICs/:senderBIC
The listSettlement request allows the STEP2 Preferred Agents and STEP2 BICs configured for settlement in CGS to retrieve the CGS Settlement BIC list
POST {{baseUrl}}/settlementBICDetails/:senderBIC
The settlementBICDetails allows the STEP2 Preferred Agents and STEP2 BICs configured for settlement in CGS to get the details of a specific Settlement BIC
PUT {{baseUrl}}/updateSettlementBIC/:senderBIC
The updateSettlementBIC request allows the STEP2 Preferred Agent to update the routing configuration parameters for a specific Settlement BIC in the CGS Routing Table. This function is managed under BCWS dual control and it generates an “Update Settlement BIC” operation logged as “TO BE AUTHORIZED”.
POST {{baseUrl}}/currentPosition/:senderBIC
The currentPosition request allows the STEP2 Preferred Agent to retrieve its current position in a selected date range
POST {{baseUrl}}/positionLac/:senderBIC
The positionLac request allows the STEP2 Preferred Agent to retrieve the position at a specific LAC
PUT {{baseUrl}}/setDefaultAgenda/:senderBIC
The setDefaultAgenda request allows the STEP2 Preferred Agent to set and/or change the default thresholds related to its position, setting the values for - Lower Position; - Base Position; - Upper Position; - Reset to base position flag for each LAC of each TARGET day of the week.
POST {{baseUrl}}/getDefaultAgenda/:senderBIC
The getDefaultAgenda request allows the STEP2 Preferred Agent to retrieve the default thresholds related to its position, namely - Lower Position; - Base Position; - Upper Position; - Reset to base position flag
PUT {{baseUrl}}/setCalendar/:senderBIC
The setCalendar request allows the STEP2 Preferred Agent to change one or more of the default values set in the Liquidity Agenda for specific LAC(s) of a specific day of the year, including the current one
POST {{baseUrl}}/listCalendar/:senderBIC
The listCalendar request allows the STEP2 Preferred Agent to retrieve the changed values in the Agenda set for specific LAC(s) of a specific day of the year
PUT {{baseUrl}}/liquidityManagement/:senderBIC
The liquidityManagement request allows the STEP2 Preferred Agent to fund/defund liquidity from its position. As soon as the command is authorized, the settlementBIC’s position is debited of the defunded amount and a LAF file is generated for T2I.
POST {{baseUrl}}/listFundingDefunding/:senderBIC
The listFundingDefunding request allows the STEP2 Preferred Agent to retrieve information on single liquidity instructions
POST {{baseUrl}}/interestMonthlyReport/:senderBIC
The interestMonthlyReport request allows the STEP2 Preferred Agent to retrieve monthly information resulting from the “Interest Calculation Process” for its Settlement BIC. Data are available by the first TARGET business day of the month, once calculated by the system. Since calculations may differ from the set of information provided by the ECB (especially due to the rounding mechanism), Participants are invited to take note of this figure only upon EBA CLEARING email confirmation. Once confirmed as valid, the amount is collected from Participants on the third TARGET business day of the month. Once collected, daily interest details are available for Participants. If for the selected period there are not validated data, no data found
response is provided. If the range selected by the user includes more months for which EBA CLEARING has validated only some months, the report is provided only for the months already validated.
POST {{baseUrl}}/interestDailyReport/:senderBIC
The interestReport request allows the STEP2 Preferred Agent to retrieve the daily information resulting from the “Interest Calculation Process” of a specific month for its Settlement BIC. Data are available by the first TARGET business day of the month, once calculated by the system.
POST {{baseUrl}}/lcrList/:senderBIC
The lcrList request allows the STEP2 Preferred Agent to retrieve processed (settled / cancelled / revoked / rejected) and queued LCRs for its settlementBIC
POST {{baseUrl}}/lcrDetails/:senderBIC
The lcrList request allows the STEP2 Preferred Agent to retrieve details of a single LCR for a specific settlementBIC (mandatory to set up the request).
PUT {{baseUrl}}/revokeLcr/:senderBIC
The revokeLcr request allows the STEP2 Preferred Agent to revoke a single queued LCR or all queued LCRs, resulting in a negative settlement of the LCR(s) that will be rejected back to the relevant STEP2 Service
POST {{baseUrl}}/listFiles/:senderBIC
The listFiles request allows the STEP2 Preferred Agent to retrieve the list of LMR and LNR output files generated by the module
POST {{baseUrl}}/fileDetails/:senderBIC
The fileDetails request allows the STEP2 Preferred Agent to retrieve details of LMR and LNR output files generated by the module
POST {{baseUrl}}/retransmitOutFiles/:senderBIC
The retransmitOutFiles request allows the STEP2 Preferred Agent to ask for the resending of files for which the Preferred Agent was the receiver. The retransmission of files can be requested for a single file in the suitable status
POST {{baseUrl}}/resendAll/:senderBIC
The resendAll request allows the STEP2 Preferred Agent to ask for the resending of files for which the Preferred Agent was the receiver. The retransmission of files can be requested for all of files with status TSG (Transmitting) or ERR (Error), according to filter criteria and rules on date foreseen in CGS
POST {{baseUrl}}/listAlerts/:senderBIC
The listAlerts request allows the STEP2 Preferred Agent to retrieve the list of alerts produced by the module for its BIC
POST {{baseUrl}}/listCommands/:senderBIC
The listCommands request allows the STEP2 Preferred Agent to retrieve the status of Commands that were submitted by the Participant
POST {{baseUrl}}/commandDetails/:senderBIC
The commandDetails request allows the STEP2 Preferred Agent to retrieve the status of a single command submitted by the Participant
POST {{baseUrl}}/listOperation/:senderBIC
The listOperation allows the STEP2 Preferred Agent to retrieve participant operations stored in the Settlement BICs routing table, based on customized search criteria.
POST {{baseUrl}}/operationDetails/:senderBIC
The operationDetails request allows the STEP2 Preferred Agent to retrieve details of specific routing table operations.
PUT {{baseUrl}}/rejectParticipantOperation/:senderBIC
The rejectParticipantOperation request allows the STEP2 Preferred Agent to reject a specific change operation submitted and not yet authorized.
ENDPOINTS