VOvopay
Journal Entry Endpoints

journal-entry/add

This endpoint allows you to add journal entry into the VoPay platform. Journals do not represent real funds. They are considered offbook funds, and are designed to represent transactions that have occured outside the VoPay platform.

post/journal-entry/add

Request

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

Currencystring required

3 character currency code for the currency to mark the currency that was used for the journal entry.

CreditAmountstring required

The credit amount for the journal entry. Either one of CreditAmount or DebitAmount must be provided.

DebitAmountstring required

The debit amount for the journal entry. Either one of CreditAmount or DebitAmount must be provided.

TransactionDatestring date required

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

FullNamestring required

Full name of the indivdual or business for whom the journal entry is being created.

Statusstring required

The transaction status for the journal entry.

Notesstring

An optional note to associate with the journal entry.

ClientReferenceNumberstring

An optional reference number to associate with the journal entry.

ClientAccountIDstring int32

The Client Account ID that the journal entry belong to.

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 just created. This ID should be saved as it is required in order to look up or edit the journal entry.

Example response

{
  "Success": true
}

Changes

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