Qodex.ai
Qodex.ai
Introduction
Instant Cash Reporting API
Setup
Refresh Token
getTransactionSummary
Retrieve transaction summary for an account.
getCashAccounts
Retrieve accounts and balances.
getAccountStatement
Get statement with transaction.
getCashAccount
[SC Acc 2]: Retrieve balances for an account. Copy
getStatementLines
Get statement entries with statement batch
Teardown
Revoke Token
Swift Messaging API
Authorization
Refresh Token
v1-distributions-{id}
Retrieve a single available distribution from Alliance Cloud.ACK a distribution.NAK a distribution.
v1-distributions
Retrieve the list of available distributions from Alliance Cloud.Update the status of multiple distributions in Alliance Cloud.
v1-fin-messages
Download one or several FIN messages ready to be distributed.Send a FIN message to Alliance Cloud.Send a batch of FIN messages to Alliance Cloud.Download a FIN message ready to be distributed.
v1-fin-transmission-reports
Download one or several FIN transmission reports ready to be distributed.Download a FIN transmission report ready to be distributed.
v1-fin-delivery-reports
Download one or several FIN delivery reports ready to be distributed.Download a FIN Delivery report ready to be distributed.
v1-fin-delivery-notifications
Download one or several FIN delivery notifications ready to be distributed.Download a FIN Delivery notification ready to be distributed.
v1-interact-messages
Download one or several InterAct messages ready to be distributed.Send an InterAct message to Alliance Cloud.Send a batch of InterAct messages to Alliance Cloud.Download an InterAct message ready to be distributed.
v1-interact-transmission-reports
Download one or several InterAct transmission reports ready to be distributed.Download an InterAct transmission report ready to be distributed.
v1-interact-delivery-reports
Download one or several InterAct delivery reports ready to be distributed.Download an InterAct delivery report ready to be distributed.
v1-interact-delivery-notifications
Download one or several InterAct delivery notifications ready to be distributed.Download an InterAct delivery notification ready to be distributed.
v1-fileact-messages
This operation initiates the sending of a FileAct message.This operation completes the whole sending process for a FileAct message.This operation initiates the download of a FileAct message.Mock DownloadMock Upload
v1-fileact-transmission-reports
Download one or several FileAct transmission reports ready to be distributed.Download a FileAct transmission report ready to be distributed.
v1-fileact-delivery-reports
Download one or several FileAct delivery reports ready to be distributed.Download a FileAct delivery report ready to be distributed.
v2-distributions-{id}
Retrieve a single available distribution from Alliance Cloud.ACK a distribution.NAK a distribution.
v2-distributions
Retrieve the list of available distributions from Alliance Cloud.Update the status of multiple distributions in Alliance Cloud.
v2-fin-messages
Download one or several FIN messages ready to be distributed.Send a FIN message to Alliance Cloud.Send a batch of FIN messages to Alliance Cloud.Download a FIN message ready to be distributed.
v2-fin-transmission-reports
Download one or several FIN transmission reports ready to be distributed.Download a FIN transmission report ready to be distributed.
v2-fin-delivery-reports
Download one or several FIN delivery reports ready to be distributed.Download a FIN Delivery report ready to be distributed.
v2-fin-delivery-notifications
Download one or several FIN delivery notifications ready to be distributed.Download a FIN Delivery notification ready to be distributed.
v2-fin-archives
Download one or several FIN archives ready to be distributed.Download a FIN archive ready to be distributed.
v2-fin-exports
Download one or several FIN message exports ready to be distributed.Download a FIN export ready to be distributed.
v2-interact-messages
Download one or several InterAct messages ready to be distributed.Send an InterAct message to Alliance Cloud.Send a batch of InterAct messages to Alliance Cloud.Download an InterAct message ready to be distributed.
v2-interact-transmission-reports
Download one or several InterAct transmission reports ready to be distributed.Download an InterAct transmission report ready to be distributed.
v2-interact-delivery-reports
Download one or several InterAct delivery reports ready to be distributed.Download an InterAct delivery report ready to be distributed.
v2-interact-delivery-notifications
Download one or several InterAct delivery notifications ready to be distributed.Download an InterAct delivery notification ready to be distributed.
v2-interact-archives
Download one or several InterAct archives ready to be distributed.Download an InterAct archive ready to be distributed.
v2-interact-exports
Download one or several InterAct message exports ready to be distributed.Download an InterAct export ready to be distributed.
v2-fileact-transfers
This operation initiates the transfer of a FileAct message.This operation completes the whole sending process for a FileAct message.Mock Upload
v2-fileact-messages
This operation initiates the download of a FileAct message.Mock Download
v2-fileact-transmission-reports
Download one or several FileAct transmission reports ready to be distributed.Download a FileAct transmission report ready to be distributed.
v2-fileact-delivery-reports
Download one or several FileAct delivery reports ready to be distributed.Download a FileAct delivery report ready to be distributed.
v2-fileact-archives
This operation initiates the download of a FileAct archive.
v2-fileact-exports
Download one or several FileAct message exports ready to be distributed.Download an FileAct export ready to be distributed.
Teardown
Revoke Token
Transaction Screening API
Authorization
Refresh Token
Submits a batch of screening requests.
Submits a batch of screening requests 2.
Retrieves the statuses of screening requests.
Retrieves the statuses of screening requests 2.
Teardown
Revoke Token
Bank Guarantee API
Setup
Refresh Token
Trade Finance Undertaking
Create Trade Finance UndertakingGet Trade Finance UndertakingGet Specific Trade Finance UndertakingReplace Trade Finance UndertakingUpdate Trade Finance UndertakingRequest Payment
Teardown
Revoke Token
Payment Initiation API
Setup
Refresh Token
payment-initiation-instructions-{uetr}
Clearing System Identification Request RawClearing System Identification Request Raw
payment-initiation-instructions
Get Request Raw
direct-debit-initiation-instruction-{uetr}
Create Direct Debit Initiation Request RawDirect Debit Initiation Request
direct-debit-initiation-instruction
Direct Debit Initiation Request Collection Raw
Teardown
Revoke Token
Securities Settlement View API
Authorization
Refresh Token
v1-Securities Settlement View
Settlement View Report Raw Response
v1-Settlement Instruction Audit Events
Settlement Instruction Audit Event Raw Response
v1-Instruction Status Summary Report
Settlement Instruction Status Report Raw Response
Teardown
Revoke Token
Payment Pre-Validation Consumer API
Setup
Refresh Token
Success Scenario-accounts
Account matches but name does not match - Verify that a beneficiary account could be able to receive incoming fundsValidates the instructed institution as Payment Pre-validation Data Provider.
Success Scenario-payment
Validates the account format.Validates the instructed institution as financial institution.Validates the purpose code.Validates the payment purpose.Validates the category purpose.Validates the instructed amount.Verify the payment for Rulebook eligibility and obtain payment predictability.Validates the payment instruction.
Error Scenario
Bad Request: invalid x-bic formatBad Request: request body missing account_identification param
Teardown
Revoke Token
GPI Transaction Details API
Authorization
Refresh Token
v5-Get Payment Transaction Details-Success
Payment Transaction Details including FX, partial confirmation and cover
v5-Get Payment Transaction Details-Error
Return HTTP error codes 5XX
v5-Get Changed Payment Transactions-Success
Get second page
v5-Get Changed Payment Transactions-Error
Get next page with other params defined
Teardown
Revoke Token
GPI Universal Confirmations API
Authorization
Refresh Token
Success
Request to update the status of a transaction to ACSP/G001
Error
5XX Errors
Teardown
Revoke Token
GPI Financial Institutions Transfer API
Authorization
Refresh Token
Success Scenarios
Status Confirmations(if transaction_status =ACSPand transaction_status_reason=G002)
Error Scenarios
error500s
Teardown
Revoke Token
EBA STEP2 SEPA Credit transfer
It allows the Participant to inquire the Direct Participants list.It allows the Participant to inquire the details of a Direct Participants.It allows the Participant to inquire the Reachable BICs list.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 insert a new BPO relationship.It allows the Participant to remove a BPO relationship.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 update a specific Default Threshold.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 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 enquire the list of the 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 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 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 message for which the Participant was 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 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 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 to ask for the creation of the original xml of the message (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 Direct Debit B2B
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 receiverIt allows Participants to enquire the details of a single message for which they are sender or receiverIt 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.
KYC Registry API (limited)
Setup
Refresh Token
Accounts-My Listing
My Listing
Accounts-Counterparty Listing
Counterparty Listing
Accounts-Data Retrieval
BIC=BITIAAAXXXXBIC=BITIBBBGXXXBIC=RSWCSSSGXXXBIC=RSWCUUUUXXX
Accounts-Document Retrieval
Document By Id
Accounts-Profile Retrieval
Entity Folders Profile By Bic
Teardown
Revoke Token
GPI PMI API
Authorization
Refresh Token
Status Confirmation
Status Confirmation: Internal Server Error
Teardown
Revoke Token
Swift Go API
Authorization
Refresh Token
v5-Success Scenarios
Status Confirmations(if transaction_status =ACSP/G001-if charge_bearer is not SHAR)
v5-Error Scenarios
Status Confirmations(MandatoryFieldMissing)
v4-Success
Status confirmation update(if transaction_status is ACSP)
v4-Error
InvalidRequest(if body is null)
Teardown
Revoke Token
Banking Analytics Premium API
Setup
Refresh Token
v1-Success Scenarios
Payment Data: 2019-01-05Trade Data: 2019-01-05Treasury Data: 2019-01-05Activity Share
v1-Error Scenarios
Mandatory Parameter Missing
v2-Market
Payment data: Sample 2Trade data: Sample 2Treasury data: Sample 2
v2-Activity Share
Information related to Swift Totals: Sample 2
Teardown
Revoke Token
Observer Analytics API
Setup
Refresh Token
uetrs-Speed-e2e-GCCT transaction ; speed-related information-Success Scenarios
GCCT transaction -USD
uetrs-Speed-e2e-GCCT transaction ; speed-related information-Error Scenarios
GCCT transaction -Invalid Parameter
uetrs-Speed-e2e-GCCT transaction's participations ; speed related information-Success Screnarios
GCCT transaction's participations-DEMOUS33
uetrs-Speed-e2e-GCCT transaction's participations ; speed related information-Error Screnarios
GCCT transaction's participations-Invalid Parameter
uetrs-Routes-GCCT routes-Success Scenarios
GCCT transaction ; route-related information-DEMOUS33
uetrs-Routes-GCCT routes-Error Scenarios
GCCT transaction ; route-related information-Invalid Parameter
uetrs-Routes-GCOV routes-Success Scenarios
GCOV transaction ; route-related information-DEMOUS33
uetrs-Routes-GCOV routes-Error Scenarios
GCOV transaction ; route-related information-Invalid Parameter
totals/monthly-gcct-e2e-Transaction speed-Success Screnarios
Transaction speed
totals/monthly-gcct-e2e-Transaction speed-Error Screnarios
Transaction speed-Mandatory field Missing
totals/monthly-gcct-e2e-Transaction activity share-Success Screnarios
Transaction activity share
totals/monthly-gcct-e2e-Transaction activity share-Error Screnarios
Transaction activity share -Invalid Parameter
totals/monthly-gcct-GCCT country fwd speed-Success Screnrios
GCCT country fwd speed
totals/monthly-gcct-GCCT country fwd speed-Error Screnrios
GCCT country fwd speed -Invalid parameter
totals/monthly-gcct-GCCT message conf speed-Success Scenarios
GCCT message conf speed
totals/monthly-gcct-GCCT message conf speed-Error Scenarios
GCCT message conf speed-Invalid Parameter
totals/monthly-gcov-GCOV country fwd speed-Success Scenarios
GCOV country fwd speed
totals/monthly-gcov-GCOV country fwd speed-Error Scenarios
GCOV country fwd speed-Invalid Parameter
totals/monthly-gcov-GCOV message conf speed-Success Screnarios
GCOV message conf speed
totals/monthly-gcov-GCOV message conf speed-Error Screnarios
GCOV message conf speed-Invalid Parameter
Teardown
Revoke Token
EBA Continuous Gross Settlement
[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
Fee Statistics API (Payment Experience PoV)
Authorization
Refresh Token
v1
Example with creditor agent using a domestic identification
Teardown
Revoke Token
GPI Case resolution API
Setup
Refresh Token
v6-Success Scenarios
Cancel case request.Assignee of the case accepts the request.Conclude case.Create case request.Get changed case details.Get cases details.Get parties in a payment transaction and their case and/or stop and recall reachability status.
v6-Error Scenarios
Bad Request: Invalid uetr parameterBad Request: Missing uetr valueNot Found: Invalid uetrNot Found: Invalid case_identification
v5-Success Scenarios
Cancel case request.Assignee of the case accepts the request.Conclude case.Create case request.Get changed case details.Get cases details.
v5-Error Scenarios
from_date_time is greater than to_date_timeInvalid requestMandatory Field Missing
v4-Success
Create unable to apply caseassign caseconclude unable to apply casecases detailschanged case details
v4-Error
from_date_time is greater than to_date_time
Teardown
Revoke Token
GPI Cover Payments API
Authorization
Refresh Token
Success
Request to update the status of the transaction to ACSP/G000
Error
5XX Errors
Teardown
Revoke Token
GPI Stop and Recall API
Authorization
Refresh Token
v6-Success Scenarios
Stop and Recall request.Stop and Recall Response.Stop And Recall Details.Get parties in a payment transaction and their case and/or stop and recall reachability status.Changed Stop And Recall Details.
v6-Error Scenarios
Bad Request: Missing from valueNot Found
v5-Cancel Transaction-Success
Request to cancel a transaction
v5-Cancel Transaction-Error
Return HTTP error code 5XX
v5-Transaction Cancellation Status-Success
Update the status of a cancelled transaction status RJCR CUST
v5-Transaction Cancellation Status-Error
Unknown UETR
Teardown
Revoke Token
Compliance Analytics API
Setup
Refresh Token
v1-Get Institution Review dashboard data.-Success
2019-05 DIRE_SENT
v1-Get Institution Review dashboard data.-Error
Invalid Pattern: 'group_id'
v1-Get activity share per country.-Success
2019-07-12 BE-SENT
v1-Get activity share per country.-Error
Invalid 'direction' Parameter
Teardown
Revoke Token
GPI Customer Credit Transfer
Authorization
Refresh Token
v5-Sucess Scenarios-Status Confirmations
Request to update the status of the transaction to RJCT/AC04
v5-Error Scenarios
Error 500s
Teardown
Revoke Token
EBA STEP2 Direct Debit CORE
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 receiverIt allows Participants to enquire the details of a single message for which they are sender or receiverIt 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 COR Service.It allows the Participant to retrieve details for a specific LCR.
GPI g4C API
Authorization
Refresh Token
v7-Inbound payments
End to end identification search
v7-Outbound payments
End to end identification search
v6-Inbound payments
Time window search with EventFilter and StatusFilter
v6-Outbound payments
Time window search with EventFilter and StatusFilter
v4-Pay and Trace Time-Window Search-success scenarios
Get next page
v4-Pay and Trace Time-Window Search-error scenarios
from_date_time is greater than 7 days
v4-Pay and Trace UETR Search-success scenarios
Settlement completed shared chargesReturns a specific inbound paymentSettlement completed foreign exchange
v4-Pay and Trace UETR Search-error scenarios
Missing Mandatory FieldInvalid UETRError 5XX Codes
v4-Inbound Tracking Time-Window Search-success scenarios
status ACSP
v4-Inbound Tracking Time-Window Search-error scenarios
from_date_time is greater than 7 days
v4-Inbound Tracking UETR Search-success scenarios
Transaction ACSCTransaction ACSPTransaction ACCC
v4-Inbound Tracking UETR Search-error scenarios
Invalid UETRErrorCode 500s
v4 - Filter-Static Filters-Returns the Details of Created Static Filters-success scenarios
ASBICUS33XX - 2 filters
v4 - Filter-Static Filters-Returns the Details of Created Static Filters-error scenarios
Next used with other parameters
v4 - Filter-Static Filters-Modifies a Static Filter-success scenarios
Failed to modify 1 filter record
v4 - Filter-Static Filters-Modifies a Static Filter-error scenarios
Missing Field in body
v4 - Filter-Static Filters-Create a Static Filter-success scenarios
3 Successful, 2 Failed
v4 - Filter-Static Filters-Create a Static Filter-error scenarios
Missing Field in Body
v4 - Filter-Static Filters-Deletes a Static Filter-success scenarios
Delete 1 Static Filter
v4 - Filter-Static Filters-Deletes a Static Filter-error scenarios
Missing Field in Body
v4 - Filter-Dynamic Filters-Create a Dynamic Filter-success scenarios
3 Successful Records Created
v4 - Filter-Dynamic Filters-Create a Dynamic Filter-error scenarios
Missing Header Value
Teardown
Revoke Token
Swift OAuth Token API
Password Grant Type-Sandbox
Refresh Token - SandboxRevoke Token - Sandbox
Password Grant Type-Live
Refresh Token - LiveRevoke Token - Live
JWT Bearer Grant Type-Sandbox
Refresh Token - SandboxRevoke Token - Sandbox
SwiftRef API
Authorization
Refresh Token
Success-ibans-{iban}
Get details for an IBAN.Check validity of an IBAN, with SEPA-only option.Get the BIC for an IBAN.
Success-ibans
IBAN constructor.
Success-bics/{bic}
Get details of a BIC.Check validity of a BIC.Get the LEI for a BIC.Get National IDs for a BIC.Validate SEPA reachability of a BIC.Get SSIs for a BIC.Get connected BIC.
Success-bbans
Get the IBAN from a BBAN.Get BBAN elements of an IBAN country.
Success-leis/{lei}
Get details of a LEI.Get the BIC for an LEI.Check validity of a LEI.
Success-national ids/{national id}
Get details of a National ID.Check the Validity of a National ID.Get BICs of a National ID.
Success-country codes/{country code}
Get details of a country code.Check validity of a country code.
Success-currency codes/{currency code}
Get details of a currency code.Check validity of a currency code.Check validity of a currency amount.
Success-pmis-participants
Search for PMI participants.Get PMI participant details.
Success-pmis-{service id}
Get PMI details.Get PMI participant structure.
Success-pmis
Search for Payment Market Infrastructures.
Success
Get the BIC for an IBAN national ID.Check validity of account number formats, including IBANs.
Teardown
Revoke Token
Notification Service for Subscriber API
Setup
Refresh Token
subscriptions-category list-success scenarios
Get list of all categories for a service.
subscriptions-category list-error scenarios
InvalidServiceNameNoNotifRole
subscriptions-subscribe-success scenarios
Subscribe to a category(Queue) for notifications.
subscriptions-subscribe-error scenarios
InvalidCategoryName
subscriptions-{subscription-id}-get notifications-success scenarios
Get notifications for a subscription.
subscriptions-{subscription-id}-get notifications-error scenarios
NoNotifRoleInvalidSubscriptionId
subscriptions-{subscription-id}-update subscription-success scenarios
Update existing subscription.
subscriptions-{subscription-id}-update subscription-error scenarios
NoNotifRoleInvalidSubscriptionId
subscriptions-{subscription-id}-get subscription information-success scenarios
Get subscription information for a subscription.
subscriptions-{subscription-id}-get subscription information-error scenarios
NoNotifRoleInvalidSubscriptionId
subscriptions-{subscription-id}-unsubscribe-success scenarios
Unsubscribe from a category.
subscriptions-{subscription-id}-unsubscribe-error scenarios
NoNotifRoleInvalidSubscriptionId
Teardown
Revoke Token
EBA RT1 SEPA Credit Transfer INST
Authorization
Refresh TokenRevoke Token
Success Scenarios
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 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.
Error Scenarios
Bad Request 2: Missing bicAp fieldNot Found 1: bicAp not mapped to resourceNot Found 2: no such path
Introduction
Instant Cash Reporting API
Setup
Refresh Token
getTransactionSummary
Retrieve transaction summary for an account.
getCashAccounts
Retrieve accounts and balances.
getAccountStatement
Get statement with transaction.
getCashAccount
[SC Acc 2]: Retrieve balances for an account. Copy
getStatementLines
Get statement entries with statement batch
Teardown
Revoke Token
Swift Messaging API
Authorization
Refresh Token
v1-distributions-{id}
Retrieve a single available distribution from Alliance Cloud.ACK a distribution.NAK a distribution.
v1-distributions
Retrieve the list of available distributions from Alliance Cloud.Update the status of multiple distributions in Alliance Cloud.
v1-fin-messages
Download one or several FIN messages ready to be distributed.Send a FIN message to Alliance Cloud.Send a batch of FIN messages to Alliance Cloud.Download a FIN message ready to be distributed.
v1-fin-transmission-reports
Download one or several FIN transmission reports ready to be distributed.Download a FIN transmission report ready to be distributed.
v1-fin-delivery-reports
Download one or several FIN delivery reports ready to be distributed.Download a FIN Delivery report ready to be distributed.
v1-fin-delivery-notifications
Download one or several FIN delivery notifications ready to be distributed.Download a FIN Delivery notification ready to be distributed.
v1-interact-messages
Download one or several InterAct messages ready to be distributed.Send an InterAct message to Alliance Cloud.Send a batch of InterAct messages to Alliance Cloud.Download an InterAct message ready to be distributed.
v1-interact-transmission-reports
Download one or several InterAct transmission reports ready to be distributed.Download an InterAct transmission report ready to be distributed.
v1-interact-delivery-reports
Download one or several InterAct delivery reports ready to be distributed.Download an InterAct delivery report ready to be distributed.
v1-interact-delivery-notifications
Download one or several InterAct delivery notifications ready to be distributed.Download an InterAct delivery notification ready to be distributed.
v1-fileact-messages
This operation initiates the sending of a FileAct message.This operation completes the whole sending process for a FileAct message.This operation initiates the download of a FileAct message.Mock DownloadMock Upload
v1-fileact-transmission-reports
Download one or several FileAct transmission reports ready to be distributed.Download a FileAct transmission report ready to be distributed.
v1-fileact-delivery-reports
Download one or several FileAct delivery reports ready to be distributed.Download a FileAct delivery report ready to be distributed.
v2-distributions-{id}
Retrieve a single available distribution from Alliance Cloud.ACK a distribution.NAK a distribution.
v2-distributions
Retrieve the list of available distributions from Alliance Cloud.Update the status of multiple distributions in Alliance Cloud.
v2-fin-messages
Download one or several FIN messages ready to be distributed.Send a FIN message to Alliance Cloud.Send a batch of FIN messages to Alliance Cloud.Download a FIN message ready to be distributed.
v2-fin-transmission-reports
Download one or several FIN transmission reports ready to be distributed.Download a FIN transmission report ready to be distributed.
v2-fin-delivery-reports
Download one or several FIN delivery reports ready to be distributed.Download a FIN Delivery report ready to be distributed.
v2-fin-delivery-notifications
Download one or several FIN delivery notifications ready to be distributed.Download a FIN Delivery notification ready to be distributed.
v2-fin-archives
Download one or several FIN archives ready to be distributed.Download a FIN archive ready to be distributed.
v2-fin-exports
Download one or several FIN message exports ready to be distributed.Download a FIN export ready to be distributed.
v2-interact-messages
Download one or several InterAct messages ready to be distributed.Send an InterAct message to Alliance Cloud.Send a batch of InterAct messages to Alliance Cloud.Download an InterAct message ready to be distributed.
v2-interact-transmission-reports
Download one or several InterAct transmission reports ready to be distributed.Download an InterAct transmission report ready to be distributed.
v2-interact-delivery-reports
Download one or several InterAct delivery reports ready to be distributed.Download an InterAct delivery report ready to be distributed.
v2-interact-delivery-notifications
Download one or several InterAct delivery notifications ready to be distributed.Download an InterAct delivery notification ready to be distributed.
v2-interact-archives
Download one or several InterAct archives ready to be distributed.Download an InterAct archive ready to be distributed.
v2-interact-exports
Download one or several InterAct message exports ready to be distributed.Download an InterAct export ready to be distributed.
v2-fileact-transfers
This operation initiates the transfer of a FileAct message.This operation completes the whole sending process for a FileAct message.Mock Upload
v2-fileact-messages
This operation initiates the download of a FileAct message.Mock Download
v2-fileact-transmission-reports
Download one or several FileAct transmission reports ready to be distributed.Download a FileAct transmission report ready to be distributed.
v2-fileact-delivery-reports
Download one or several FileAct delivery reports ready to be distributed.Download a FileAct delivery report ready to be distributed.
v2-fileact-archives
This operation initiates the download of a FileAct archive.
v2-fileact-exports
Download one or several FileAct message exports ready to be distributed.Download an FileAct export ready to be distributed.
Teardown
Revoke Token
Transaction Screening API
Authorization
Refresh Token
Submits a batch of screening requests.
Submits a batch of screening requests 2.
Retrieves the statuses of screening requests.
Retrieves the statuses of screening requests 2.
Teardown
Revoke Token
Bank Guarantee API
Setup
Refresh Token
Trade Finance Undertaking
Create Trade Finance UndertakingGet Trade Finance UndertakingGet Specific Trade Finance UndertakingReplace Trade Finance UndertakingUpdate Trade Finance UndertakingRequest Payment
Teardown
Revoke Token
Payment Initiation API
Setup
Refresh Token
payment-initiation-instructions-{uetr}
Clearing System Identification Request RawClearing System Identification Request Raw
payment-initiation-instructions
Get Request Raw
direct-debit-initiation-instruction-{uetr}
Create Direct Debit Initiation Request RawDirect Debit Initiation Request
direct-debit-initiation-instruction
Direct Debit Initiation Request Collection Raw
Teardown
Revoke Token
Securities Settlement View API
Authorization
Refresh Token
v1-Securities Settlement View
Settlement View Report Raw Response
v1-Settlement Instruction Audit Events
Settlement Instruction Audit Event Raw Response
v1-Instruction Status Summary Report
Settlement Instruction Status Report Raw Response
Teardown
Revoke Token
Payment Pre-Validation Consumer API
Setup
Refresh Token
Success Scenario-accounts
Account matches but name does not match - Verify that a beneficiary account could be able to receive incoming fundsValidates the instructed institution as Payment Pre-validation Data Provider.
Success Scenario-payment
Validates the account format.Validates the instructed institution as financial institution.Validates the purpose code.Validates the payment purpose.Validates the category purpose.Validates the instructed amount.Verify the payment for Rulebook eligibility and obtain payment predictability.Validates the payment instruction.
Error Scenario
Bad Request: invalid x-bic formatBad Request: request body missing account_identification param
Teardown
Revoke Token
GPI Transaction Details API
Authorization
Refresh Token
v5-Get Payment Transaction Details-Success
Payment Transaction Details including FX, partial confirmation and cover
v5-Get Payment Transaction Details-Error
Return HTTP error codes 5XX
v5-Get Changed Payment Transactions-Success
Get second page
v5-Get Changed Payment Transactions-Error
Get next page with other params defined
Teardown
Revoke Token
GPI Universal Confirmations API
Authorization
Refresh Token
Success
Request to update the status of a transaction to ACSP/G001
Error
5XX Errors
Teardown
Revoke Token
GPI Financial Institutions Transfer API
Authorization
Refresh Token
Success Scenarios
Status Confirmations(if transaction_status =ACSPand transaction_status_reason=G002)
Error Scenarios
error500s
Teardown
Revoke Token
EBA STEP2 SEPA Credit transfer
It allows the Participant to inquire the Direct Participants list.It allows the Participant to inquire the details of a Direct Participants.It allows the Participant to inquire the Reachable BICs list.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 insert a new BPO relationship.It allows the Participant to remove a BPO relationship.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 update a specific Default Threshold.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 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 enquire the list of the 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 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 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 message for which the Participant was 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 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 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 to ask for the creation of the original xml of the message (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 Direct Debit B2B
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 receiverIt allows Participants to enquire the details of a single message for which they are sender or receiverIt 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.
KYC Registry API (limited)
Setup
Refresh Token
Accounts-My Listing
My Listing
Accounts-Counterparty Listing
Counterparty Listing
Accounts-Data Retrieval
BIC=BITIAAAXXXXBIC=BITIBBBGXXXBIC=RSWCSSSGXXXBIC=RSWCUUUUXXX
Accounts-Document Retrieval
Document By Id
Accounts-Profile Retrieval
Entity Folders Profile By Bic
Teardown
Revoke Token
GPI PMI API
Authorization
Refresh Token
Status Confirmation
Status Confirmation: Internal Server Error
Teardown
Revoke Token
Swift Go API
Authorization
Refresh Token
v5-Success Scenarios
Status Confirmations(if transaction_status =ACSP/G001-if charge_bearer is not SHAR)
v5-Error Scenarios
Status Confirmations(MandatoryFieldMissing)
v4-Success
Status confirmation update(if transaction_status is ACSP)
v4-Error
InvalidRequest(if body is null)
Teardown
Revoke Token
Banking Analytics Premium API
Setup
Refresh Token
v1-Success Scenarios
Payment Data: 2019-01-05Trade Data: 2019-01-05Treasury Data: 2019-01-05Activity Share
v1-Error Scenarios
Mandatory Parameter Missing
v2-Market
Payment data: Sample 2Trade data: Sample 2Treasury data: Sample 2
v2-Activity Share
Information related to Swift Totals: Sample 2
Teardown
Revoke Token
Observer Analytics API
Setup
Refresh Token
uetrs-Speed-e2e-GCCT transaction ; speed-related information-Success Scenarios
GCCT transaction -USD
uetrs-Speed-e2e-GCCT transaction ; speed-related information-Error Scenarios
GCCT transaction -Invalid Parameter
uetrs-Speed-e2e-GCCT transaction's participations ; speed related information-Success Screnarios
GCCT transaction's participations-DEMOUS33
uetrs-Speed-e2e-GCCT transaction's participations ; speed related information-Error Screnarios
GCCT transaction's participations-Invalid Parameter
uetrs-Routes-GCCT routes-Success Scenarios
GCCT transaction ; route-related information-DEMOUS33
uetrs-Routes-GCCT routes-Error Scenarios
GCCT transaction ; route-related information-Invalid Parameter
uetrs-Routes-GCOV routes-Success Scenarios
GCOV transaction ; route-related information-DEMOUS33
uetrs-Routes-GCOV routes-Error Scenarios
GCOV transaction ; route-related information-Invalid Parameter
totals/monthly-gcct-e2e-Transaction speed-Success Screnarios
Transaction speed
totals/monthly-gcct-e2e-Transaction speed-Error Screnarios
Transaction speed-Mandatory field Missing
totals/monthly-gcct-e2e-Transaction activity share-Success Screnarios
Transaction activity share
totals/monthly-gcct-e2e-Transaction activity share-Error Screnarios
Transaction activity share -Invalid Parameter
totals/monthly-gcct-GCCT country fwd speed-Success Screnrios
GCCT country fwd speed
totals/monthly-gcct-GCCT country fwd speed-Error Screnrios
GCCT country fwd speed -Invalid parameter
totals/monthly-gcct-GCCT message conf speed-Success Scenarios
GCCT message conf speed
totals/monthly-gcct-GCCT message conf speed-Error Scenarios
GCCT message conf speed-Invalid Parameter
totals/monthly-gcov-GCOV country fwd speed-Success Scenarios
GCOV country fwd speed
totals/monthly-gcov-GCOV country fwd speed-Error Scenarios
GCOV country fwd speed-Invalid Parameter
totals/monthly-gcov-GCOV message conf speed-Success Screnarios
GCOV message conf speed
totals/monthly-gcov-GCOV message conf speed-Error Screnarios
GCOV message conf speed-Invalid Parameter
Teardown
Revoke Token
EBA Continuous Gross Settlement
[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
Fee Statistics API (Payment Experience PoV)
Authorization
Refresh Token
v1
Example with creditor agent using a domestic identification
Teardown
Revoke Token
GPI Case resolution API
Setup
Refresh Token
v6-Success Scenarios
Cancel case request.Assignee of the case accepts the request.Conclude case.Create case request.Get changed case details.Get cases details.Get parties in a payment transaction and their case and/or stop and recall reachability status.
v6-Error Scenarios
Bad Request: Invalid uetr parameterBad Request: Missing uetr valueNot Found: Invalid uetrNot Found: Invalid case_identification
v5-Success Scenarios
Cancel case request.Assignee of the case accepts the request.Conclude case.Create case request.Get changed case details.Get cases details.
v5-Error Scenarios
from_date_time is greater than to_date_timeInvalid requestMandatory Field Missing
v4-Success
Create unable to apply caseassign caseconclude unable to apply casecases detailschanged case details
v4-Error
from_date_time is greater than to_date_time
Teardown
Revoke Token
GPI Cover Payments API
Authorization
Refresh Token
Success
Request to update the status of the transaction to ACSP/G000
Error
5XX Errors
Teardown
Revoke Token
GPI Stop and Recall API
Authorization
Refresh Token
v6-Success Scenarios
Stop and Recall request.Stop and Recall Response.Stop And Recall Details.Get parties in a payment transaction and their case and/or stop and recall reachability status.Changed Stop And Recall Details.
v6-Error Scenarios
Bad Request: Missing from valueNot Found
v5-Cancel Transaction-Success
Request to cancel a transaction
v5-Cancel Transaction-Error
Return HTTP error code 5XX
v5-Transaction Cancellation Status-Success
Update the status of a cancelled transaction status RJCR CUST
v5-Transaction Cancellation Status-Error
Unknown UETR
Teardown
Revoke Token
Compliance Analytics API
Setup
Refresh Token
v1-Get Institution Review dashboard data.-Success
2019-05 DIRE_SENT
v1-Get Institution Review dashboard data.-Error
Invalid Pattern: 'group_id'
v1-Get activity share per country.-Success
2019-07-12 BE-SENT
v1-Get activity share per country.-Error
Invalid 'direction' Parameter
Teardown
Revoke Token
GPI Customer Credit Transfer
Authorization
Refresh Token
v5-Sucess Scenarios-Status Confirmations
Request to update the status of the transaction to RJCT/AC04
v5-Error Scenarios
Error 500s
Teardown
Revoke Token
EBA STEP2 Direct Debit CORE
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 receiverIt allows Participants to enquire the details of a single message for which they are sender or receiverIt 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 COR Service.It allows the Participant to retrieve details for a specific LCR.
GPI g4C API
Authorization
Refresh Token
v7-Inbound payments
End to end identification search
v7-Outbound payments
End to end identification search
v6-Inbound payments
Time window search with EventFilter and StatusFilter
v6-Outbound payments
Time window search with EventFilter and StatusFilter
v4-Pay and Trace Time-Window Search-success scenarios
Get next page
v4-Pay and Trace Time-Window Search-error scenarios
from_date_time is greater than 7 days
v4-Pay and Trace UETR Search-success scenarios
Settlement completed shared chargesReturns a specific inbound paymentSettlement completed foreign exchange
v4-Pay and Trace UETR Search-error scenarios
Missing Mandatory FieldInvalid UETRError 5XX Codes
v4-Inbound Tracking Time-Window Search-success scenarios
status ACSP
v4-Inbound Tracking Time-Window Search-error scenarios
from_date_time is greater than 7 days
v4-Inbound Tracking UETR Search-success scenarios
Transaction ACSCTransaction ACSPTransaction ACCC
v4-Inbound Tracking UETR Search-error scenarios
Invalid UETRErrorCode 500s
v4 - Filter-Static Filters-Returns the Details of Created Static Filters-success scenarios
ASBICUS33XX - 2 filters
v4 - Filter-Static Filters-Returns the Details of Created Static Filters-error scenarios
Next used with other parameters
v4 - Filter-Static Filters-Modifies a Static Filter-success scenarios
Failed to modify 1 filter record
v4 - Filter-Static Filters-Modifies a Static Filter-error scenarios
Missing Field in body
v4 - Filter-Static Filters-Create a Static Filter-success scenarios
3 Successful, 2 Failed
v4 - Filter-Static Filters-Create a Static Filter-error scenarios
Missing Field in Body
v4 - Filter-Static Filters-Deletes a Static Filter-success scenarios
Delete 1 Static Filter
v4 - Filter-Static Filters-Deletes a Static Filter-error scenarios
Missing Field in Body
v4 - Filter-Dynamic Filters-Create a Dynamic Filter-success scenarios
3 Successful Records Created
v4 - Filter-Dynamic Filters-Create a Dynamic Filter-error scenarios
Missing Header Value
Teardown
Revoke Token
Swift OAuth Token API
Password Grant Type-Sandbox
Refresh Token - SandboxRevoke Token - Sandbox
Password Grant Type-Live
Refresh Token - LiveRevoke Token - Live
JWT Bearer Grant Type-Sandbox
Refresh Token - SandboxRevoke Token - Sandbox
SwiftRef API
Authorization
Refresh Token
Success-ibans-{iban}
Get details for an IBAN.Check validity of an IBAN, with SEPA-only option.Get the BIC for an IBAN.
Success-ibans
IBAN constructor.
Success-bics/{bic}
Get details of a BIC.Check validity of a BIC.Get the LEI for a BIC.Get National IDs for a BIC.Validate SEPA reachability of a BIC.Get SSIs for a BIC.Get connected BIC.
Success-bbans
Get the IBAN from a BBAN.Get BBAN elements of an IBAN country.
Success-leis/{lei}
Get details of a LEI.Get the BIC for an LEI.Check validity of a LEI.
Success-national ids/{national id}
Get details of a National ID.Check the Validity of a National ID.Get BICs of a National ID.
Success-country codes/{country code}
Get details of a country code.Check validity of a country code.
Success-currency codes/{currency code}
Get details of a currency code.Check validity of a currency code.Check validity of a currency amount.
Success-pmis-participants
Search for PMI participants.Get PMI participant details.
Success-pmis-{service id}
Get PMI details.Get PMI participant structure.
Success-pmis
Search for Payment Market Infrastructures.
Success
Get the BIC for an IBAN national ID.Check validity of account number formats, including IBANs.
Teardown
Revoke Token
Notification Service for Subscriber API
Setup
Refresh Token
subscriptions-category list-success scenarios
Get list of all categories for a service.
subscriptions-category list-error scenarios
InvalidServiceNameNoNotifRole
subscriptions-subscribe-success scenarios
Subscribe to a category(Queue) for notifications.
subscriptions-subscribe-error scenarios
InvalidCategoryName
subscriptions-{subscription-id}-get notifications-success scenarios
Get notifications for a subscription.
subscriptions-{subscription-id}-get notifications-error scenarios
NoNotifRoleInvalidSubscriptionId
subscriptions-{subscription-id}-update subscription-success scenarios
Update existing subscription.
subscriptions-{subscription-id}-update subscription-error scenarios
NoNotifRoleInvalidSubscriptionId
subscriptions-{subscription-id}-get subscription information-success scenarios
Get subscription information for a subscription.
subscriptions-{subscription-id}-get subscription information-error scenarios
NoNotifRoleInvalidSubscriptionId
subscriptions-{subscription-id}-unsubscribe-success scenarios
Unsubscribe from a category.
subscriptions-{subscription-id}-unsubscribe-error scenarios
NoNotifRoleInvalidSubscriptionId
Teardown
Revoke Token
EBA RT1 SEPA Credit Transfer INST
Authorization
Refresh TokenRevoke Token
Success Scenarios
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 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.
Error Scenarios
Bad Request 2: Missing bicAp fieldNot Found 1: bicAp not mapped to resourceNot Found 2: no such path
HomeSwiftRef APITeardown

Teardown

Number of APIs: 1

  1. Revoke Token POST https://sandbox.swift.com/oauth2/v1/revoke
Previous
Check validity of account number formats, including IBANs.
Next
Revoke Token