Swift API Sandbox Collections API Documentation
It allows to get the details of a specific file sent or received by the Participant.
POST {{baseUrl}}/fileDetails/:senderBIC
The fileDetails request allows participants to get the details of a specific file (sent or received). 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": {},
"fileDNF": {
"businessDate": {},
"cycle": "01",
"dateTimeSent": {},
"fileReference": "TESTFILEREF01234",
"fileStatus": "TSD",
"fileType": "IDF",
"lastStatusUpdated": {},
"network": "SWT",
"networkFileName": "S202SCTTESTITMM_F800AAA.I",
"numDebitsContained": 1000,
"numPCRContained": 1000,
"numRejectsContained": 1000,
"numReturnsContained": 1000,
"numReversalContained": 1000,
"receiverBIC": "TESTIT88",
"totNumBulks": 1000,
"valDebitsContained": 10000.01,
"valPCRContained": 10000.01,
"valRejectsContained": 10000.01,
"valReturnsContained": 10000.01,
"valReversalContained": 10000.01
},
"fileDRR": {
"businessDate": {},
"dateTimeSent": {},
"fileReference": "TESTFILEREF01234",
"fileStatus": "TSD",
"fileType": "IDF",
"lastStatusUpdated": {},
"network": "SWT",
"networkFileName": "S202SCTTESTITMM_F800AAA.I",
"receiverBIC": "TESTIT88",
"cycle": "01"
},
"fileDVF": {
"IDFFileRefeference": "TESTFILEREF01234",
"IDFNetworkFileName": "S202SCTTESTITMM_F800AAA.I",
"businessDate": {},
"cycle": "01",
"dateTimeSent": {},
"fileReference": "TESTFILEREF01234",
"fileStatus": "TSD",
"fileType": "IDF",
"lastStatusUpdated": {},
"network": "SWT",
"networkFileName": "S202SCTTESTITMM_F800AAA.I",
"numBulksAccepted": 1000,
"numBulksRejected": 1000,
"numDebitsAccepted": 1000,
"numDebitsRejected": 1000,
"numPCRAccepted": 1000,
"numPCRRejected": 1000,
"numRejectsAccepted": 1000,
"numRejectsRejected": 1000,
"numReturnsAccepted": 1000,
"numReturnsRejected": 1000,
"numReversalAccepted": 1000,
"numReversalRejected": 1000,
"reasonCode": "A01",
"receiverBIC": "TESTIT88",
"valDebitsAccepted": 10000.01,
"valDebitsRejected": 10000.01,
"valPCRAccepted": 10000.01,
"valPCRRejected": 10000.01,
"valRejectsAccepted": 10000.01,
"valRejectsRejected": 10000.01,
"valReturnsAccepted": 10000.01,
"valReturnsRejected": 10000.01,
"valReversalAccepted": 10000.01,
"valReversalRejected": 10000.01
},
"fileIDF": {
"DVFFileReference": "TESTFILEREF01234",
"DVFNetworkFileName": "S202SCTTESTITMM_F800AAA.I",
"businessDate": {},
"cycle": "01",
"dateTimeReceived": {},
"fileStatus": "TSD",
"fileType": "IDF",
"network": "SWT",
"networkFileName": "S202SCTTESTITMM_F800AAA.I",
"numBulksContained": 1000,
"numBulksRejected": 1000,
"numDebitsContained": 1000,
"numDebitsRejected": 1000,
"numPCRContained": 1000,
"numPCRRejected": 1000,
"numRejectsContained": 1000,
"numRejectsRejected": 1000,
"numReturnsContained": 1000,
"numReturnsRejected": 1000,
"numReversalContained": 1000,
"numReversalRejected": 1000,
"processingTime": {},
"reasonCode": "A01",
"senderBIC": "TESTIT88",
"valDebitsContained": 10000.01,
"valDebitsRejected": 10000.01,
"valPCRContained": 10000.01,
"valPCRRejected": 10000.01,
"valRejectsContained": 10000.01,
"valRejectsRejected": 10000.01,
"valReturnsContained": 10000.01,
"valReturnsRejected": 10000.01,
"valReversalContained": 10000.01,
"valReversalRejected": 10000.01,
"fileReference": "TESTFILEREF01234"
},
"fileMSR": {
"businessDate": {},
"cycle": "01",
"dateTimeSent": {},
"fileReference": "TESTFILEREF01234",
"fileStatus": "TSD",
"fileType": "IDF",
"lastStatusUpdated": {},
"network": "SWT",
"networkFileName": "S202SCTTESTITMM_F800AAA.I",
"receiverBIC": "TESTIT88"
},
"filePSR": {
"businessDate": {},
"dateTimeSent": {},
"fileReference": "TESTFILEREF01234",
"fileStatus": "TSD",
"fileType": "IDF",
"lastStatusUpdated": {},
"network": "SWT",
"networkFileName": "S202SCTTESTITMM_F800AAA.I",
"receiverBIC": "TESTIT88",
"cycle": "01",
"lac": "15"
},
"fileRSF": {
"businessDate": {},
"dateTimeSent": {},
"fileReference": "TESTFILEREF01234",
"fileStatus": "TSD",
"fileType": "IDF",
"lastStatusUpdated": {},
"network": "SWT",
"networkFileName": "S202SCTTESTITMM_F800AAA.I",
"numDebitsCancelled": 1000,
"numDebitsSettled": 1000,
"numReturnsCancelled": 1000,
"numReturnsSettled": 1000,
"numReversalCancelled": 1000,
"numReversalSettled": 1000,
"receiverBIC": "TESTIT88",
"totNumBulks": 1000,
"valDebitsCancelled": 10000.01,
"valDebitsSettled": 10000.01,
"valReturnsCancelled": 10000.01,
"valReturnsSettled": 10000.01,
"valReversalCancelled": 10000.01,
"valReversalSettled": 10000.01,
"cycle": "01",
"lac": "5"
},
"fileRTF": {
"businessDate": {},
"cycle": "01",
"dateTimeSent": {},
"fileReference": "TESTFILEREF01234",
"fileStatus": "TSD",
"fileType": "IDF",
"lastStatusUpdated": {},
"network": "SWT",
"networkFileName": "S202SCTTESTITMM_F800AAA.I",
"receiverBIC": "TESTIT88"
},
"fileIGF": {
"IGFNetworkFileName": "S202SCTTESTITMM_F800AAA.I",
"IGFfileRef": "TESTFILEREF01234",
"OGFFileRef": "TESTFILEREF01234",
"OGFNetworkFileName": "S202SCTTESTITMM_F800AAA.I",
"businessDate": {},
"dateTimeReceived": {},
"fileStatus": "TSD",
"fileType": "IDF",
"network": "cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift",
"processingTime": {},
"reasonCode": "A01",
"senderBIC": "TESTIT88",
"numGetAccountValidated": 1000,
"numGetAccountRejected": 1000,
"numGetTransactionValidated": 1000,
"numGetTransactionRejected": 1000
},
"fileOGF": {
"IGFFileRef": "TESTFILEREF01234",
"IGFNetworkFileName": "S202SCTTESTITMM_F800AAA.I",
"OGFNetworkFileName": "S202SCTTESTITMM_F800AAA.I",
"OGFfileRef": "TESTFILEREF01234",
"businessDate": {},
"dateTimeSent": {},
"fileStatus": "TSD",
"fileType": "IDF",
"lastStatusUpdated": {},
"network": "SWT",
"reasonCode": "A01",
"receiverBIC": "TESTIT88",
"numGetAccountValidated": 1000,
"numGetAccountRejected": 1000,
"numGetTransactionValidated": 1000,
"numGetTransactionRejected": 1000
}
} |
Curl
curl -X POST 'https://sandbox.swift.com/ebacl-step2-cor/v1/fileDetails/: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","fileRef":{"fileType":"IDF","fileStatus":"TSD","fileReference":"TESTFILEREF01234","dateTime":"2019-06-21T23:20:50.000001","networkFileName":"S202SCTTESTITMM_F800AAA.I","cgs":true}}'
ENDPOINTS