Swift API Sandbox Collections API Documentation
It allows to get the details of a specific bulk contained in a file sent or received by the Participant.
POST {{baseUrl}}/bulkDetails/:senderBIC
The bulkDetails request allows participants to get the details of a specific bulk contained in a file for which they are sender or receiver. 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. 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": {},
"bulk": {
"BICInstructing": "TESTIT88",
"bulkCurrency": "EUR",
"bulkReasonCode": "A01",
"bulkReference": "TESTBULKREF135000000000000000000123",
"bulkStatus": "ACCP",
"businessDate": {},
"fileReference": "TESTFILEREF01234",
"fileType": "IDF",
"messageType": "Pacs.003",
"settlementDate": {},
"totAmountTransactionRejected": 10000.01,
"totAmountTransactionValid": 10000.01,
"totAmountTransactionsContained": 10000.01,
"totNumTransactionsContained": 1000,
"totTransactionRejected": 1000,
"totTransactionValid": 1000,
"originalBulk": "TESTBULKREF135000000000000000000123",
"BICInstructed": "TESTIT88"
}
} |
Curl
curl -X POST 'https://sandbox.swift.com/ebacl-step2-b2b/v1/bulkDetails/:senderBIC' -H 'ivUserKey: dolor exercitation' -H 'ivUserBic: TESTIT88' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"dateTime":"2019-06-21T23:20:50.000001","bulkRef":{"fileType":"IDF","messageType":"Pacs.003","fileReference":"TESTFILEREF01234","bulkReference":"TESTBULKREF135000000000000000000123","dateTime":"2019-06-21T23:20:50.000001","cgs":true}}'
ENDPOINTS