Swift API Sandbox Collections API Documentation
It allows the Participant to enquire the list of its BPO relationships.
POST {{baseUrl}}/listBPORelationships/:senderBIC
The listBPORelationships request allows a participant to retrieve the list of its BPO relationships. 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,
"relationships": [
{
"activationDate": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"counterpartBICCode": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"counterpartName": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"requestorUser": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"removalDate": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"authorizerUser": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
{
"activationDate": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"counterpartBICCode": {
"value": "<Error: Too many level Curl curl -X POST 'https://sandbox.swift.com/ebacl-step2-cor/v1/listBPORelationships/: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":{"counterpartBICCode":"TESTIT88","counterpartName":"Merrill Lynch","activationDateFrom":"2019-06-21","activationDateTo":"2019-06-21","removalDateFrom":"2019-06-21","removalDateTo":"2019-06-21","requestorUser":"APIUSER1","authorizerUser":"APIUSER1"},"offset":"AAaa88ss2345fggGGDDaaaHH"}' ENDPOINTS |