VOvopay
EFT Endpoint

eft/withdraw/schedule/edit

This endpoint is used to edit or cancel an upcoming payment (only the amount can be edited).

Notes. If the field amount is set as 0 or it is not provided, we consider the upcoming payment as cancelled.

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

post/eft/withdraw/schedule/edit

Request

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

ScheduledTransactionIDinteger required

ID of the schedule transaction to edit

Amountnumber

The new amount of the upcoming payment to edit, If this value is 0 we consider that upcoming payment as cancelled

UpcomingPaymentstring date required

The date of the upcoming payment. This payment has to belong to the list of upcoming payments of the scheduled transaction to edit.

NewDatestring date required

The new date of the upcoming payment. This will update the UpcomingPayment date for this particular payment. Note that the UpcomingPayment date for all other payments, that belongs to the same scheduled transaction, will not be affected.

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

Example response

{
  "Success": true
}

Changes

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