Swift API Sandbox Collections API Documentation
It allows Participants to enquire the list of messages for which they are sender or receiver
POST {{baseUrl}}/listMessages/:senderBIC
The listMessages request allows a participant to retrieve the list of its messages (sent or received). 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. cn=<SSO+BIC+UserId+T>,o=BIC8,o=swift. SSO is a fixed string, last char 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,
"messages": [
{
"dateTime": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"lastStatusUpdate": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"messageRef": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"messageType": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"network": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"reasonCode": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"messageStatus": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"originalMessageRef": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"IGFFileRef": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"OGFFileRef": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
{
"dateTime": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"lastStatusUpdate": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"messageRef": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"messageType": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"network": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"reasonCode": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"messageStatus": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"originalMessageRef": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"IGFFileRef": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"OGFFileRef": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
}
],
"senderReceiverBIC": "TESTIT88",
"offset": "AAaa88ss2345fggGGDDaaaHH"
} |
Curl
curl -X POST 'https://sandbox.swift.com/ebacl-step2-cor/v1/listMessages/:senderBIC' -H 'ivUserKey: laborum adipisicing amet velit qui' -H 'ivUserBic: TESTIT88' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"dateTime":"2019-06-21T23:20:50.000001","searchCriteria":{"fileType":"IDF","messageType":"Camt.003","senderReceiverBIC":"TESTIT88","dateTimeFrom":"2019-06-21T23:20:50.000001","dateTimeTo":"2019-06-21T23:20:50.000001","messageRef":"string","originalMessageRef":"string","messageStatus":"VAL","reasonCode":"stri","IGFFileRef":"TESTFILEREF01234","OGFFileRef":"TESTFILEREF01234","network":"SWT"},"offset":"AAaa88ss2345fggGGDDaaaHH"}'
ENDPOINTS