VOvopay
Account Endpoints

account/transfer-to

This endpoint allows you to transfer funds between VoPay accounts and/or Client accounts.

post/account/transfer-to

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/transfer-to
  • 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

DebitorClientAccountIDstring

ID of the client account transferring the funds

RecipientClientAccountIDstring

ID of the client account receiving the funds

Amountnumber required

The transfer amount.

Currencystring

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

RecipientAccountIDstring required

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

ClientReferenceNumberstring

An optional reference number to associate with the transfer

Notesstring

An optional note to associate with the transaction.

ParentTransactionIDstring

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.

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

TransactionIDinteger required

The unique ID of the debit transaction associated with this transfer.

Example response

{
  "Success": true
}

Changes

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