Initiate the cancellation of active payment processes, belonging to the same bulk. If successful, payments eligible for cancellation will be cancelled and have a final state with status = Cancelled.

put

https://www.bankingcircleconnect.com/api/v1/payments/bulks/{payment-bulk-id}/cancel

When you initiate a cancellation, the system will attempt to cancel each individual payment in the bulk, applying the same cancellation rules as for single payments (see cancelling a payment).

If some payments have already been processed, partial cancellation is allowed. After processing, the system returns a summary indicating which payments were successfully cancelled.

Responses

200

Language

Credentials

Bearer

Loading…

Response

Choose an example:

application/json

400Bad request. Request is not correctly formulated. Goes for both Header, Query and Body. Verify the error description and properties.

403Forbidden. The server understood the request, but is refusing it or the access is not allowed, i.e. if resource exists but calling user does not have rights to access it.

404Not found. There is no resource behind the URL, i.e. requesting data on an account that does not exist.