API Reference

eft/withdraw/schedule/edit

post
https://earthnode-dev.vopay.com/api/v2/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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

int32
required

ID of the schedule transaction to edit

number

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

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.

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

Updated 10 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago