Swift API Sandbox Collections API Documentation
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
The endpoint will retrieve summary report of securities settlement instruction status by the criteria provided
Body
PARAM
| Key | Datatype | Required | Description |
bic
|
string | Specify the BIC of the participant involved in the settlement instruction. Usage - The response will be filtered by the BIC. If the BIC is not in scope of the requester, an error response will be returned. | |
from-date-time
|
string | (Required) Specify the start date time from when changed transaction are to be reported. `Usage -` The parameter is mandatory. The date must be in the past and before the to-date-time. Response includes records that have been updated by tracker on or after from date time. Expressed in the YYYY-MM-DDThh:mm:ss.sssZ format. | |
to-date-time
|
string | Specify the end date time up to which changed transaction are to be reported. If the parameter is omitted, the result will included any event up to the request time if there are any. `Usage -` The parameter is optional. If parameter is not provided, then current datetime will be used. Records included between the two interval inclusive. Expressed in the YYYY-MM-DDThh:mm:ss.sssZ format. | |
limit
|
string | The maximum number of items to return in a page. If unspecified, the default limit will be returned. If the limit specified is greater than the maximum permitted by the API, the API will return the maximum permitted limit. Each API should define *maximum and *default limit. | |
next-page-token
|
string | A token that can be sent as `page_token` to retrieve the next page providing the user with a page token that may be used to retrieve the next page. |
HEADERS
| Key | Datatype | Required | Description |
X-Request-ID
|
Curl curl -X GET 'https://sandbox.swift.com/swift-securities-view/v1/settlement-instruction-status-summary-report?bic=GZY4WTNS&from-date-time=2023-10-31T16:32:28.808Z?bic=GZY4WTNS&from-date-time=2023-10-31T16:32:28.808Z&to-date-time=<dateTime>&limit=<integer>&next-page-token=<string>' -H 'X-Request-ID: <string>' -H 'RBACRole: <string>' -H 'Accept: application/json' ENDPOINTS |