API Reference

account/withdraw-my-account/schedule

post
https://earthnode-dev.vopay.com/api/v2/account/withdraw-my-account/schedule

This endpoint will create a scheduled transaction to credit your default bank account by withdarwing funds from your VoPay account.

To set a default bank account, please use the /bank-account/set-my-bank-account endpoint.

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

number
required

The amount to schedule in the transactions

string
required

The frequency of the scheduled transaction: single or recurring.

string
required

Name of frequency of the scheduled transaction (Only for recurring option), the posibles values are: weekly, biweekly, semi-monthly, monthly, bimonthly, 3 months, 6 months, yearly.

string
required

Date from which the schedule will be started

string
required

Date when the transaction processing will end (Only for recurring option), Either provide ScheduleEndDate or EndingAfterPayments

integer
required

Number of payments after which the transaction processing will end (Only for recurring option), Either provide ScheduleEndDate or EndingAfterPayments

integer

Type of semi-monthly frequency. This field is only required when NameOfFrequency is set to semi-monthly. The possible values are: SemiMonthFirstAndFifteenth, SemiMonthFifteenthAndLast

string
required

Description of the schedule transaction

string

An optional reference number to associate with the transaction.

string

A unique key which the server can use to recognize and reject subsequent retries of the same request.

Response

Updated 2 months ago

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

Updated 2 months ago