account/client-accounts/transfer-withdraw/schedule

post

https://earthnode-dev.vopay.com/api/v2/account/client-accounts/transfer-withdraw/schedule

This endpoint is used to schedule a transfer-withdraw between two client accounts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

AccountID

string

required

Your account ID

Key

string

required

API key for the account

Signature

string

required

Hashed signature for the request

DebitorClientAccountID

string

required

ID of the client account transferring the funds

RecipientClientAccountID

string

required

ID of the client account receiving the funds

RecipientClientAccountIDSplit

string

required

A JSON formatted string specifying the details for a split payment. This must fit to the following format where the amount identifier is either Amount or Percentage, [{"ClientAccountID":"client_account_id_1","Amount": "5"},{"ClientAccountID":"client_account_id_2","Amount": "10"}]

Amount

number

required

The amount to debit from the customer's bank account.

Currency

string

3 character currency code for the currency. If this is not specified the transaction will use the account's local currency.

FundingRail

string

Specifies the rail to use for the funding transaction. If this is not specified eft will be used for Canadian accounts and ach for US accounts.

WithdrawRail

string

Specifies the rail to use for the withdraw transaction. If this is not specified eft will be used for Canadian accounts and ach for US accounts.

ReverseOnFailure

boolean

Setting this to true will reverse both the fund and transfer should either fail. This is set to false, by default.

ClientReferenceNumber

string

An optional reference number to associate with the transfers

Notes

string

An optional note to associate with the transfers.

TransactionLabel

string

The TransactionLabel overrides the originator short name on statements

Frequency

string

required

The frequency of the scheduled transfer. Valid options are: single, weekly, monthly, semi-monthly, and yearly.

ScheduleStartDate

string

required

Date from which the schedule will be started

ScheduleEndDate

string

required

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

EndingAfterPayments

integer

required

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

SemiMonthlyFrequencyType

integer

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

Description

string

Description of the schedule transfer

GLCode

string

An optional unique identification general ledger code.

Response

200