VOvopay
Scheduled Payments

Cancel Scheduled Payment

Cancel a scheduled payment and all its future occurrences.

post/scheduled-payment/cancel

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/scheduled-payment/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

ScheduledPaymentsIDinteger required

The ID of the scheduled payment to cancel

Response

Scheduled payment cancelled successfully

Successboolean required

Indicates whether the cancellation was successful

ErrorMessagestring required

Error message if the cancellation failed

Status'cancelled' required

The status of the scheduled payment

Example response

{
  "Success": true
}

Changes

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