---
title: "interac/bulk-payout/transaction/request-cancellation"
method: POST
path: "/interac/bulk-payout/transaction/request-cancellation"
tags: ["Interac Endpoints"]
---

# interac/bulk-payout/transaction/request-cancellation

`POST /interac/bulk-payout/transaction/request-cancellation`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/interac/bulk-payout/transaction/request-cancellation`
- Auth: none declared

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.

## Request body `application/x-www-form-urlencoded`

- object
  - `AccountID` string, required: Your account ID
  - `Key` string, required: API key for the account
  - `Signature` string, required: Hashed signature for the request
  - `TransactionID` string, required: The unique ID for the transaction

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `TransactionID` integer, required: The unique ID for the transaction
  - `TransactionStatus` string, required: A message indicating the current transaction status - cancellation requested
  - `Timestamp` string, date-time, required: The timestamp when the transaction status was last modified

---

[API](https://skmtc.dev/vopay/apis/payment-rails.md) - [All operations](https://skmtc.dev/vopay/apis/payment-rails/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/payment-rails/revisions/d6fe8969ddcf?raw)