Swift API Sandbox Collections API Documentation
It allows the Participant to inquire the Direct Participants list.
POST {{baseUrl}}/listParticipants/:senderBIC
The listParticipants request allows participants to inquire the Direct Participants list. 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": {},
"participants": [
{
"BICCode": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"ROnlyDate": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"endValidity": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"initValidity": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"name": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"newRole": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"settlementBIC": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"status": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"newBIC": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
{
"BICCode": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"ROnlyDate": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"endValidity": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"initValidity": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"name": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"newRole": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"settlementBIC": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"status": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"newBIC": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
}
]
} |
Curl
curl -X POST 'https://sandbox.swift.com/ebacl-step2-cor/v1/listParticipants/: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":{"BICCode":"TESTIT88","name":"Merrill Lynch","initParticipantValidity":"2019-06-21","endParticipantValidity":"2019-06-21","status":"ENB","CAIUserGroup":true,"batchProcessingMode":true,"technicalBIC":true,"cgs":true,"NLOUserGroup":true,"ICMUserGroup":true}}'
ENDPOINTS