This endpoint allows you to attempt to cancel an in progress bulk payout transaction. Note that the cancellation request will fail if the recipient has already deposited the funds, and successful cancellation using this endpoint will incur an Interac network cancellation fee.

A requested or pending bulk payout that has already been exported into an Interac batch is refused with ErrorCode INVALID_TRANSACTION_STATUS, because the batch may already be with the bank; retry once it is in progress. A bulk payout in any other state that can be neither cancelled nor have a cancellation requested is also refused with INVALID_TRANSACTION_STATUS.

{
  "Success": true,
  "TransactionStatus": "cancellation requested",
  "Timestamp": "2019-11-26 12:00:00"
}