SwiftRef API

SwiftRef API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from swift-developer-support.

SwiftRef API | Swift API Sandbox Collections Workspace | API documentation

Accept

Get the BIC for an IBAN national ID.

(Required) The 2-character ISO 3166-1 country code of the country that issued the IBAN National ID

country_code

Corresponding BIC found

Added as a part of security scheme: bearer

Get the BIC for an IBAN national ID. Success SwiftRef API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from swift-developer-support.

Get the BIC for an IBAN national ID. Success SwiftRef API | Swift API Sandbox Collections Workspace | API documentation

Success

Success SwiftRef API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from swift-developer-support.

Success SwiftRef API | Swift API Sandbox Collections Workspace | API documentation

Refresh Token

Setup

Create Trade Finance Undertaking

Get Trade Finance Undertaking

Get Specific Trade Finance Undertaking

Replace Trade Finance Undertaking

Update Trade Finance Undertaking

Request Payment

Trade Finance Undertaking

Revoke Token

Teardown

Bank Guarantee API

Payment Data: 2019-01-05

Trade Data: 2019-01-05

Treasury Data: 2019-01-05

Activity Share

v1-Success Scenarios

Mandatory Parameter Missing

v1-Error Scenarios

Payment data: Sample 2

Trade data: Sample 2

Treasury data: Sample 2

v2-Market

Information related to Swift Totals: Sample 2

v2-Activity Share

Banking  Analytics Premium API

2019-05 DIRE_SENT

v1-Get Institution Review dashboard data.-Success

Invalid Pattern: 'group_id'

v1-Get Institution Review dashboard data.-Error

2019-07-12 BE-SENT

v1-Get activity share per country.-Success

Invalid 'direction' Parameter

v1-Get activity share per country.-Error

Compliance Analytics API

[listSettlementBICs]:It allows the Participant to inquire the Settlement BICs list.

[settlementBICDetails]: It allows the Participant to inquire the details of a Settlement BIC.

[updateSettlementBIC]: It allows the Participant to update the configuration of the Settlement BIC in CGS routing table

[currentPosition]: It allows STEP2 Preferred Agent to inquire its current position

[positionLac]: It allows STEP2 Preferred Agent to inquire the position at a specific LAC.

[setDefaultAgenda]: It allows STEP2 Preferred Agent to set and/or change the default thresholds related to its position.

[getDefaultAgenda]: It allows STEP2 Preferred Agent to inquire the default thresholds related to its position.

[setCalendar]: It allows STEP2 Preferred Agent to change one or more of the default values set in the Liquidity Agenda for specific LAC(s) of a specific day of the year, including the current one.

[listCalendar]: It allows STEP2 Preferred Agent to inquire the changed values in the Agenda set for specific LAC(s) of a specific day of the year.

[liquidityManagement]: It allows STEP2 Preferred Agent to fund/defund liquidity from its position. As soon as the command is authorized, the Settlement BIC’s position is debited of the defunded amount and a LAF file is generated for T2I.

[listFundingDefunding]: It allows STEP2 Preferred Agent to retrieve detail information related to liquidity instructions (funding/defunding).:

[interestMonthlyReport]: It allowsSTEP2 Preferred Agent to retrieve monthly information resulting from the “Interest Calculation Process” of a specific month

[interestDailyReport]: It allows STEP2 Preferred Agent to retrieve daily information resulting from the “Interest Calculation Process”.

[lcrList]: It allows STEP2 Preferred Agent to inquire queued and processed (settled / cancelled / revoked / rejected) LCRs.

[lcrDetails]: It allows STEP2 Preferred Agent to retrieve details of queued and processed (settled / cancelled / revoked / rejected) LCRs.

[Revoke LCR]: It allows STEP2 Preferred Agent to revoke queued LCRs resulting in a negative settlement of the LCR that is rejected back to the relevant STEP2 Service.

[listFiles]: It allows STEP2 Preferred Agent to retrieve the list of LMR and LNR output files generated by the Module.

[fileDetails]: It allows STEP2 Preferred Agent to retrieve details of LMR and LNR output files generated by the Module.

[retransmitOutFiles]: It allows to ask for the resending of a single file for which the Participant was the receiver.

[resendAll]: It allows the Participant to ask the comprehensive re-transmission of  output files for which the Participant was the receiver.

[listAlerts]: It allows the Participant to enquire the list of alerts generated by the module for its BIC.

[listCommands]: It allows the STEP2 Preferred Agent to inquire the list of submitted commands.

[commandDetails]: It allows the STEP2 Preferred Agent to retrieve the details of a single command submitted.

[listOperation]: It allows the STEP2 Preferred Agent to inquire the status of operations submitted.

[operationDetails]: It allows the STEP2 Preferred Agent to inquire the details of a single operation submitted.

[rejectParticipantOperation]: It allows the STEP2 Preferred Agent to reject an operation previously submitted via API

EBA Continuous Gross Settlement

Authorization

A Participant can inquiry real time liquidity position.

A Participant can set default values (Base, Lower, and Upper).

A Participant can inquiry default values (Base, Lower, and Upper).

A Participant can set exception position values (Base, Lower, and Upper).

A Participant can inquiry exception position values (Base, Lower, and Upper).

A Participant can defund a position.

A Participant can issue a request for funding its position.

A Participant can transfer a specific amount from one Participant to another Participant within a Pool.

A Participant can inquiry one specific or the list of Funding and Defunding Instructions issued in TIPS for a BIC.

A Participant can inquiry the details of a specific liquidity instruction related to a funding/defunding exchanged with TIPS.

A Participant can inquiry one specific or the list of messages exchanged with TIPS.

A Participant can inquiry the detail of a specific message exchanged with TIPS.

A Participant can request the generation of an Outbound LTO.

A Participant can request the generation of a Payment Status Query.

A Participant can request the generation of a get Account Balance to inquiry its DCA account.

A Participant can inquiry its Beneficiary PSPs.

A Participant can manage its Beneficiary PSPs.

Searches the participants.

A Participant can inquiry the details of a single BIC and the parameter modification history with details.

A Participant can update its own configuration.

A Participant can inquiry the list of all the AP.

A Participant can inquiry the details of a single AP and its parameter modification history.

A Participant can update the configuration of one of its AP.

A Participant can set one of its APs in R-Only or Disable status.

A Participant can insert one AP, linked to him.

A Participant can communicate his temporary unavailability.

A Participant can inquiry the list of unavailable Participants.

A Participant can inquiry the list of its Participants’ Operation.

A Participant can inquiry the detail of a specific Participant Operation command.

A Participant can reject a Participant Operation command.

A Participant can inquiry the list of pacs.008 in which he is or the instructing or the instructed agent.

A Participant can inquiry the detail of a single payment.

A Participant can inquiry the list of pacs.004, pacs.002, pacs.028, camt.056, camt.029 in which he is or the instructing or the instructed agent.

A Participant can inquiry the details of a single pacs.004, pacs.002, pacs.028, camt.056, camt.029 message.

A Participant can inquiry the files received, homogeneous per file type (i.e. all the PSR for one day).

A Participant can inquiry the details of a single file.

A Participant can inquiry the list of all commands issued by its staff via GUI or via API that fall under Dual Control.

A Participant can inquiry the details of a specific command submitted to the system.

A Participant can delete a specific command that was submitted to the system and that has not been authorized yet by EBA CLEARING staff.

A Participant can inquiry the alerts that were generated by the SCT Inst for that Participant.

The Participant can inquiry interest calculation performed by the system for each day of the required month.

Success Scenarios

Bad Request 2: Missing bicAp field

Not Found 1: bicAp not mapped to resource

Not Found 2: no such path

Error Scenarios

EBA RT1 SEPA Credit Transfer INST

It allows the Participant to inquire the Direct Participants list.

It allows the Participant to retrieve the details of a Direct Participant.

It allows the Participant to inquire the Reachable BICs list.

It allows the Participant to retrieve the details of a Reachable BIC.

It allows the Participant to enquire the list of its BPO relationships.

It allows the Participant to insert a new BPO relationship.

It allows the Participant to remove a BPO relationship.

It allows the Participant to set its Reachable BICs in R-Only or Remove status or to revoke a previously set R-Only status.

It allows the Participant to insert a new Reachable BIC.

It allows the Participant to update its DP BIC.

It allows the Participant to update its Reachable BICs.

It allows the Participant to reject an operation previously issued via API.

It allows the Participant to enquire the list of its routing operations.

It allows the Participant to retrieve the details of one of its operations.

It allows the Participant to enquire the Default Thresholds list.

It allows the Participant to update a specific Default Threshold.

It allows the Participant to enquire its debit position against specific Counterparty BIC not configured for settling in CGS.

It allows the Participant to inquire its debit position against a specific Counterparty BIC configured for settling in CGS.

It allows to inquire the Transactions sent or received by the Participant.

It allows to get the details of a specific transaction sent or received by the Participant.

It allows to inquire the bulks contained in a file sent or received by the Participant.

It allows to get the details of a specific bulk contained in a file sent or received by the Participant.

It allows to inquire the list of files sent or received by the Participant.

It allows to get the details of a specific file sent or received by the Participant.

It allows to ask for the creation of the original xml of the message (valid only for the transactions processed in bulk processing mode).

It allows Participants to enquire the list of messages for which they are sender or receiver

It allows Participants to enquire the details of a single message for which they are sender or receiver

It allows to ask for the resending of a single file for which the Participant was the receiver.

It allows the Participant to ask the comprehensive re-transmission of output files for which the Participant was the receiver.

It allows to ask for the resending of a single file message which the Participant is the receiver.

It allows the Participant to ask the cancellation of a bulk processed in Bulk Processing mode before the settlement takes place.

It allows the Participant to ask the cancellation of a bulk processed in Batch Processing mode before the settlement takes place.

It allows to ask for the creation of the Third Pole Reconciliation report.

It allows to ask for the list of the Third Pole Reconciliation report generated after the “ThirdPoleReportRequest” API.

It allows to ask for the receiving of the Third Pole Reconciliation report generated after the “ThirdPoleReportRequest” API.

It allows the Participant to inquiry for the list of Commands that were submitted by the Participant.

It allows the Participant to inquiry for the status of a single command submitted by the Participant.

It allows the Participant to inquiry the list of alerts produced by the System for its BIC.

It allows to enquire the list of the LCRs generated for the Participant by B2B Service.

It allows the Participant to retrieve details for a specific LCR.

EBA STEP2 Direct Debit B2B

It allows to enquire the list of the LCRs generated for the Participant by COR Service.

EBA STEP2 Direct Debit CORE

It allows the Participant to inquire the details of a Direct Participants.

It allows the Participant to inquire the details of a Reachable BIC.

It allows the Participant to inquire the list of its BPO relationships.

It allows the Participant to remove its Reachable BICs.

It allows the Participant to insert a new Reachable BIC linked to its same BIC.

It allows the Participant to update its BIC.

It allows the Participant to update a Reachable BIC linked to its same BIC.

It allows the Participant to reject one of its provisioning operation previously inserted via API.

It allows the Participant to enquire the list of its operations.

It allows the Participant to retrieve the details of a specific operation.

It allows the Participant to inquire the Default Thresholds list.

It allows the Participant to inquire its debit position against specific Counterparty BIC not configured for settling in CGS.

It allows the Participant to inquire its debit position against a specific Counterpary BIC configured for settling in CGS.

It allows to enquire the list of the files sent or received by the Participant.

It allows to enquire the list of the messages sent or received by the Participant.

It allows to get the details of a specific message sent or received by the Participant.

It allows the Participant to ask the comprehensive re-transmission of output files  for which the Participant was the receiver.

It allows to ask for the resending of a single message for which the Participant was the receiver.

It allows to ask for the creation of an offline report (valid only for the transactions processed in bulk processing mode).

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).

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).

It allows the Participant to enquire the status of Commands that were submitted by the Participant.

It allows the Participant to retrieve the details of a single command submitted by the Participant.

It allows the Participant to inquire the list of alerts produced by the System for its BIC.

It allows to enquire the list of LCRs generated for the Participant by SCT Service.

It allows the Participant to inquire details of a specific LCR.

EBA STEP2 SEPA Credit transfer

Example with creditor agent using a domestic identification

Fee Statistics API (Payment Experience PoV)

Cancel case request.

Assignee of the case accepts the request.

Conclude case.

Create case request.

Get changed case details.

v6-Success Scenarios

GPI Case resolution API

Swift API Sandbox Collections

Swift API Sandbox Collections projects on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from swift-developer-support.

swift-developer-support APIs | Swift API Sandbox Collections API Integration | QodexAI API Network

Key	Datatype	Required	Description
country_code	string		(Required) The 2-character ISO 3166-1 country code of the country that issued the IBAN National ID

Key	Datatype	Required	Description
Accept	string