VOvopay
Account Endpoints

account/auto-balance-transfer/report

Changed on

This endpoint returns the list of transactions associated with an auto balance transfer.

The sum of all debits/credits matches the amount of the auto-balance transfer.

A transfer created by a run of the auto-balance cron also returns the fields of that run. When SplitByCounterparty is enabled, the cron creates one transfer per counterparty (the contact whose funding makes up the balance) plus, when needed, one transfer labelled Unattributed for the remainder that has no single counterparty. The report of such a transfer only lists the transactions of its counterparty, and Reconciled/Difference tell whether they add up to RawNet. A report that does not reconcile is still returned (Reconciled is false). Transfers created before runs existed are reported from the date of the previous transfer and fail when they do not reconcile.

get/account/auto-balance-transfer/report

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/auto-balance-transfer/report
  • Auth
    none declared

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

TransactionIDstring required

Transaction ID of the auto-balance transfer 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

RunIDinteger

The ID of the auto-balance run that created the transfer.

SplitByCounterpartyboolean

True when the run split the balance by counterparty.

Amountstring

The amount of the transfer.

RawNetstring

Net of the counterparty's transactions in the window (credits minus debits). This is what the listed transactions add up to.

CarriedAmountstring

Amount of earlier failed transfers of the same counterparty that this transfer takes over.

Adjustmentstring

Amount minus RawNet minus CarriedAmount: what was added or removed to make the transfers add up to the available balance.

Reconciledboolean

True when the listed transactions add up to RawNet (Amount when the run is not split).

Differencestring

The listed transactions minus the expected amount; 0.00 when reconciled.

Example response

{
  "Success": true,
  "Transactions": {
    "0": {
      "TransactionType": "EFT Funding",
      "TransactionDate": "2024-08-01 12:34:56",
      "FullName": "John Smith",
      "ReferenceNo": "ABCD-1234",
      "ClientAccountID": "CA-1001"
    }
  },
  "RunID": 501,
  "SplitByCounterparty": true,
  "Amount": "300.00",
  "RawNet": "300.00",
  "CarriedAmount": "0.00",
  "Adjustment": "0.00",
  "Reconciled": true,
  "Difference": "0.00",
  "RelatedTransactionIDs": {
    "0": 1235
  },
  "Counterparty": {
    "ClientAccountID": "CA-1001",
    "Name": "John Smith"
  }
}

Changes

  • 71f251deb318Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property // to the response with the status