VOvopay
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

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

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

Amountnumber required

The amount to schedule in the transactions

Frequencystring required

The frequency of the scheduled transaction: single or recurring.

NameOfFrequencystring 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.

ScheduleStartDatestring required

Date from which the schedule will be started

ScheduleEndDatestring required

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

EndingAfterPaymentsinteger required

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

SemiMonthlyFrequencyTypeinteger

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

Descriptionstring required

Description of the schedule transaction

ClientReferenceNumberstring

An optional reference number to associate with the transaction.

IdempotencyKeystring

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

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"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.