VOvopay
Client Account Transfer Endpoints

account/client-accounts/fund-transfer-withdraw

This endpoint will fund the debitor client account using their default bank account, and then transfer the money to the recipient client account once the funds have been cleared. Once the funds are transferred, a withdraw transaction will be triggered to send the funds to the recipient client account's default bank account.

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

post/account/client-accounts/fund-transfer-withdraw

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/client-accounts/fund-transfer-withdraw
  • 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 required

ID of the client account transferring the funds

RecipientClientAccountIDstring required

ID of the client account receiving the funds

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

Amountnumber required

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

FundingRailstring

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.

WithdrawRailstring

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.

IdempotencyKeystring

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.

Currencystring

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

ReverseOnFailureboolean

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

ClientReferenceNumberstring

An optional reference number to associate with the transactions

Notesstring

An optional note to associate with the transactions.

TransactionLabelstring

The TransactionLabel overrides the originator short name on statements

GLCodestring

An optional unique identification general ledger code.

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

FundingTransactionIDinteger required

The unique ID of the funding transaction that was just created. This ID should be saved as it is required order to look up the status information on the transaction.

WithdrawTransactionIDinteger required

The unique ID of the withdrawal transaction that was just created. This ID should be saved as it is required order to look up the status information on the transaction.

AccountTransferIDinteger required

The unique ID of the account transfer that was just created. This ID should be saved as it is required order to look up the status information on the transaction.

Example response

{
  "Success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.