Logo
Swift API Sandbox Collections API Documentation

It allows the Participant to ask the cancellation of a bulk processed in Bulk Processing mode before the settlement takes place.

PUT {{baseUrl}}/bulkCancellation/:senderBIC

The bulkCancellation request allows a participant to ask the cancellation of a bulk processed in Bulk Processing mode, before the settlement of the included DD collections takes place. Only pacs.003 (DD bulk messages) not yet settled can be cancelled. The bulk cancellation request can be carried out only if the following conditions are met: - None of the transactions in the bulk is either settled or cancelled at settlement; and - At least one of the transactions in the bulk is either validated or notified to the counterpart. 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

{ "commandRef": "F010190208113908", "dateTime": {} }



Curl
curl -X PUT 'https://sandbox.swift.com/ebacl-step2-cor/v1/bulkCancellation/: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","bulkRef":{"fileReference":"TESTFILEREF01234","bulkReference":"TESTBULKREF135000000000000000000123"}}'

ENDPOINTS