VOvopay
EFT Endpoint

eft/withdraw/schedule/cancel

This endpoint is used to cancel a scheduled transaction and all remaining payments belonging to that scheduled tranaction. Only scheduled transactions with the status in progress can be cancelled.

For additional details of the scheduled transactions, please visit https://docs.vopay.com/docs/schedule-a-payment

post/eft/withdraw/schedule/cancel

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/eft/withdraw/schedule/cancel
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ScheduledTransactionIDinteger required

ID of the schedule transaction to cancel

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

Statusstring required

A message indicating the current transaction status. cancelled

Example response

{
  "Success": true,
  "Status": "cancelled"
}

Changes

No recorded changes to this operation across all 1 revision of this API.