account/transfer-to

post

https://earthnode-dev.vopay.com/api/v2/account/transfer-to

This endpoint allows you to transfer funds between VoPay accounts and/or 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

ID of the client account transferring the funds

RecipientClientAccountID

string

ID of the client account receiving the funds

Amount

number

required

The transfer amount.

Currency

string

3 character currency code for the currency to fetch transactions for. If this is not specified the transaction will use the account's local currency (generally CAD).

RecipientAccountID

string

required

Account ID of the account for which you want to transfer funds to.

ClientReferenceNumber

string

An optional reference number to associate with the transfer

Notes

string

An optional note to associate with the transaction.

ParentTransactionID

string

The parent transaction where the transfer-to will be linked to, can become a split payment with multiple transfers. When funds of the parent transaction have been released the system will generate the distributions of these funds automatically.

IdempotencyKey

string

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

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200