Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Account Endpoints

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.

post/account/withdraw-my-account/schedule

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

Amountnumber required

The dollar amount of the schedule transaction

ScheduledTransactionIDinteger required

ID of the schedule Transaction.

Frequencystring required

The frequency of the transaction

Descriptionstring required

Description of the schedule transaction

ScheduleStartDatestring date required

Date from which the transaction will be started

Statusstring required

A message indicating the current transaction status. Statuses are: cancelled, completed or in progress

Example response

{
  "Success": true,
  "Frequency": "single",
  "ScheduleStartDate": "2020-01-01",
  "Status": "in progress"
}