Swift API Sandbox Collections API Documentation
[listCommands]: It allows the STEP2 Preferred Agent to inquire the list of submitted commands.
POST {{baseUrl}}/listCommands/:senderBIC
The listCommands request allows the STEP2 Preferred Agent to retrieve the status of Commands that were submitted by the Participant
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
ivUserKey
|
string | The subscription key of a Participant. Following the format cn=<SSO+BIC+UserId+T>,o=BIC8,o=swift. SSO is a fixed string, last character is for environment (P for production and T for test) eg SSOUNCRITMMAPI12345P, o=uncritmm,o=swift | |
ivUserBic
|
string | ||
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status OK
| {
"commands": [
{
"commandRef": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"commandStatus": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"commandType": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"requestDateTime": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"userIssuer": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"authRejectDateTime": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"userAuthReject": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
{
"commandRef": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"commandStatus": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"commandType": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"requestDateTime": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"userIssuer": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"authRejectDateTime": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"userAuthReject": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
}
],
"dateTime": "2019-06-21T23:20:50.000001",
"endOfList": true,
"offset": "deserunt anim Duis minim eu"
} |
Curl
curl -X POST 'https://sandbox.swift.com/ebacl-step2-cgs/v1/listCommands/:senderBIC' -H 'ivUserKey: nostrud cupidatat quis sunt' -H 'ivUserBic: <string>' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"dateTime":"2019-06-21T23:20:50.000001","searchCriteria":{"commandType":"L02","commandStatus":"TO BE AUTHORIZED","requestDateTimeFrom":"2019-06-21T23:20:50.000001","requestDateTimeTo":"2019-06-21T23:20:50.000001","authRejectDateTimeFrom":"2019-06-21T23:20:50.000001","authRejectDateTimeTo":"2019-06-21T23:20:50.000001","userIssuer":"dolore ","userAuthReject":"ad ir"},"offset":"cillu"}'
ENDPOINTS