Swift API Sandbox Collections API Documentation
It allows the Participant to inquiry for the list of Commands that were submitted by the Participant.
POST {{baseUrl}}/listCommands/:senderBIC
The listCommands request allows a participant to inquire for the status of its commands. If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
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
| {
"dateTime": {},
"endOfList": true,
"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>"
}
}
],
"offset": "AAaa88ss2345fggGGDDaaaHH"
} |
Curl
curl -X POST 'https://sandbox.swift.com/ebacl-step2-b2b/v1/listCommands/:senderBIC' -H 'ivUserKey: dolor exercitation' -H 'ivUserBic: TESTIT88' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"dateTime":"2019-06-21T23:20:50.000001","searchCriteria":{"commandType":"F01","commandStatus":"001","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":"APIUSER1","userAuthReject":"APIUSER1","commandRef":"F010190208113908"},"offset":"AAaa88ss2345fggGGDDaaaHH"}'
ENDPOINTS