It allows to inquire the bulks contained in a file sent or received by the Participant.
POST {{baseUrl}}/listBulks/:senderBIC
The listBulks allows a participant to retrieve the list of bulks contained in its files (sent or received). If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
Request Body
{"dateTime"=>"2019-06-21T23:20:50.000001", "searchCriteria"=>{"fileType"=>"IDF", "messageType"=>"Pacs.003", "fileReference"=>"TESTFILEREF01234", "bulkStatus"=>"ACCP", "bulkReference"=>"TESTBULKREF135000000000000000000123", "settlementDate"=>"2019-06-21", "cycle"=>"01", "lac"=>"0", "cgs"=>true}, "offset"=>"AAaa88ss2345fggGGDDaaaHH"}
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,"bulks":[{"bulkReference":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"bulkStatus":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateTime":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"fileReference":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"fileType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"messageType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"reasonCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"senderReceiverBIC":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"settlementDate":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"cycle":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lac":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"offset":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"bulkReference":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"bulkStatus":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateTime":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"fileReference":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"fileType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"messageType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"reasonCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"senderReceiverBIC":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"settlementDate":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"cycle":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lac":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"offset":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}