Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Interac Endpoints

interac/bulk-payout/transaction/request-cancellation

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.

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

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

TransactionIDinteger required

The unique ID for the transaction

TransactionStatusstring required

A message indicating the current transaction status - cancellation requested

Timestampstring date-time required

The timestamp when the transaction status was last modified

Example response

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