account/client-accounts/transfer-withdraw

post

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

This endpoint will transfer money from the debitor client account to the recipient client account, and then immediately withdraw the money from the recipient client account into their default bank account.

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

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.

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.

IdempotencyKey

string

A unique key to prevent duplicate transactions. If a previous request with the same idempotency key was successful, the current request will return the same response as the previous successful request.

Currency

string

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

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 transactions

Notes

string

An optional note to associate with the transactions.

TransactionLabel

string

The TransactionLabel overrides the originator short name on statements

Response

200