---
title: "account/withdraw-my-account/schedule"
method: POST
path: "/account/withdraw-my-account/schedule"
tags: ["Account Endpoints"]
---

# account/withdraw-my-account/schedule

`POST /account/withdraw-my-account/schedule`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/account/withdraw-my-account/schedule`
- Auth: none declared

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.

## Request body `application/x-www-form-urlencoded`

- object
  - `AccountID` string, required: Your account ID
  - `Key` string, required: API key for the account
  - `Signature` string, required: Hashed signature for the request
  - `Amount` number, required: The amount to schedule in the transactions
  - `Frequency` string, required: The frequency of the scheduled transaction: single or recurring.
  - `NameOfFrequency` 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.
  - `ScheduleStartDate` string, required: Date from which the schedule will be started
  - `ScheduleEndDate` string, required: Date when the transaction processing will end (Only for recurring option), Either provide ScheduleEndDate or EndingAfterPayments
  - `EndingAfterPayments` integer, required: Number of payments after which the transaction processing will end (Only for recurring option), Either provide ScheduleEndDate or EndingAfterPayments
  - `SemiMonthlyFrequencyType` integer: Type of semi-monthly frequency. This field is only required when NameOfFrequency is set to semi-monthly. The possible values are: SemiMonthFirstAndFifteenth, SemiMonthFifteenthAndLast
  - `Description` string, required: Description of the schedule transaction
  - `ClientReferenceNumber` string: An optional reference number to associate with the transaction.
  - `IdempotencyKey` string: A unique key which the server can use to recognize and reject subsequent retries of the same request.

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `Amount` number, required: The dollar amount of the schedule transaction
  - `ScheduledTransactionID` integer, required: ID of the schedule Transaction.
  - `Frequency` string, required: The frequency of the transaction
  - `Description` string, required: Description of the schedule transaction
  - `ScheduleStartDate` string, date, required: Date from which the transaction will be started
  - `Status` string, required: A message indicating the current transaction status. Statuses are: cancelled, completed or in progress

---

[API](https://skmtc.dev/vopay/apis/accounts.md) - [All operations](https://skmtc.dev/vopay/apis/accounts/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/accounts/revisions/71f251deb318?raw)