Logo
Swift API Sandbox Collections API Documentation

Securities Settlement View API

Number of APIs: 5


The API supports retrieval of previously created Securities Settlement Instruction by the Participant. Securities Settlement Instruction is used by the Instructing party to request a transfer of securities, relating to a securities settlement with or without a cash payment. In a securities settlement lifecycle both sides, meaning the asset manager and broker dealer will initiate the process from each side, and these instructions will be pushed downstream by the various intermediaries to meet in the middle with the Central Securities Depository (the so-called CSD).

The API supports following type of instruction:

  • Consolidate view of delivery and receive post trade settlement instructions
  • Audit events in a chain of settlement instructions

Error Responses

The API uses common HTTP status codes in the response header to indicate success or failure. Specific error code and description will be returned in the custom error schema.

Query Parameters

Each URL query parameter specifies an API query parameter that must be URL encoded.

Contact Support: Name: Standards & Developer Hub Email: developer-support@swift.com


1. Authorization - Refresh Token

POST https://sandbox.swift.com/oauth2/v1/token



2. v1-Securities Settlement View - Settlement View Report Raw Response

GET {{baseUrl}}/swift-securities-view/v1/securities-settlement-views



3. v1-Settlement Instruction Audit Events - Settlement Instruction Audit Event Raw Response

GET {{baseUrl}}/swift-securities-view/v1/securities-settlement-instructions/:instruction-identifier/settlement-instruction-audit-events



4. v1-Instruction Status Summary Report - Settlement Instruction Status Report Raw Response

GET {{baseUrl}}/swift-securities-view/v1/settlement-instruction-status-summary-report?bic=GZY4WTNS&from-date-time=2023-10-31T16:32:28.808Z



5. Teardown - Revoke Token

POST https://sandbox.swift.com/oauth2/v1/revoke



ENDPOINTS