Swift API Sandbox Collections API Documentation
[lcrList]: It allows STEP2 Preferred Agent to inquire queued and processed (settled / cancelled / revoked / rejected) LCRs.
POST {{baseUrl}}/lcrList/:senderBIC
The lcrList request allows the STEP2 Preferred Agent to retrieve processed (settled / cancelled / revoked / rejected) and queued LCRs for its settlementBIC
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": "2019-06-21T23:20:50.000001",
"endOfList": false,
"lcrs": [
{
"amount": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"businessDateTime": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"instdAgt": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"instdSttlmBIC": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"instgAgt": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"instgSttlmBIC": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"lacNumber": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"lcrReference": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"lcrStatus": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"originalBulkReferenceId": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"originalInputFileReferenceId": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"service": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"settlementDate": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"dbrCrdFlag": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
{
"amount": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"businessDateTime": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"instdAgt": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"instdSttlmBIC": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"instgAgt": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"instgSttlmBIC": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"lacNumber": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"lcrReference": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"lcrStatus": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"originalBulkReferenceId": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"originalInputFileReferenceId": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"service": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"settlementDate": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"dbrCrdFlag": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
}
],
"offset": "anim ullamco elit aliqua"
} |
Curl
curl -X POST 'https://sandbox.swift.com/ebacl-step2-cgs/v1/lcrList/: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":{"settlementDateFrom":"2019-06-21","settlementDateTo":"2019-06-21","settlementBIC":"IPSDID21XXX","instgAgt":"\u003cstring\u003e","instdAgt":"\u003cstring\u003e","instgSttlmBIC":"IPSDID21XXX","instdSttlmBIC":"IPSDID21XXX","dateTimeFrom":"2019-06-21T23:20:50.000001","dateTimeTo":"2019-06-21T23:20:50.000001","lcrReference":"magna ","lacNumber":"72","lcrStatus":"QUEU","service":"SCT"},"offset":"et"}'
ENDPOINTS