VOvopay
Journal Entry Endpoints

journal-entry/transfer

This endpoint allows you to transfer offbook funds between VoPay accounts and/or Client accounts. This endpoint will create two journal entries, one to debit the source account and one to credit the destination account.

post/journal-entry/transfer

Request

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

RecipientAccountIDstring

Account ID of the account for which you want to transfer funds to. If you are transfering funds between client accounts, this field should be empty. One of RecipientAccountID or RecipientClientAccountID is required.

DebitorClientAccountIDstring

ID of the client account transferring the funds

RecipientClientAccountIDstring

ID of the client account receiving the funds

Amountnumber required

The transfer amount.

Currencystring required

3 character currency code for the currency to mark the currency of the transfered funds.

TransactionDatestring date required

The transaction date for the transfer. Must be specified in YYYY-MM-DD format.

Statusstring required

The transaction status for the transfer.

ClientReferenceNumberstring

An optional reference number to associate with the transfer

Notesstring

An optional note to associate with the transaction.

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

JournalEntryIDinteger required

The unique ID of the journal entry that was created for transfer.

Example response

{
  "Success": true
}

Changes

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