VOvopay
Scheduled Payments

Edit Upcoming Payment

Modify a single upcoming scheduled payment by updating the amount and/or date. This only affects the specific upcoming occurrence.

post/scheduled-payment/upcoming-payment/edit

Request

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

ScheduledPaymentDetailsIDinteger required

The ID of the specific upcoming payment to edit

Amountnumber

The new transaction amount. If omitted, amount remains unchanged.

Datestring date-time

The new payment date and time. If omitted, date remains unchanged.

Response

Upcoming payment edited successfully

Successboolean required

Indicates whether the edit was successful

ErrorMessagestring required

Error message if the edit failed

Example response

{
  "Success": true
}

Changes

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