🚀 VaultsPay API v1 is live. See what's new →
AccountsGet Account Ledger

Get Account Ledger

GET{baseUrl}/be/api/v1/account-ledger/{id}

Path Parameter

ParameterTypeRequiredDescription
idIntegerYesAccount ID whose ledger is requested.

Query Parameters

ParameterTypeRequiredDescription
userIdIntegerNoFilter ledger entries by user ID.
startDateString (ISO 8601)NoFilter where date is ≥ this value.
endDateString (ISO 8601)NoFilter where date is ≤ this value.
transactionIdIntegerNoFilter by transaction ID.

Response

FieldTypeDescription
idIntegerLedger row ID.
transactionIdIntegerInternal transaction ID.
transactionRefIdNumberGateway/reference ID.
debitNumberDebit amount.
creditNumberCredit amount.
balanceNumberRunning balance after the entry.
narrationStringDescription of the entry.
dateStringTimestamp (ISO 8601).
200 — SUCCESS
{
  "data": [
    {
      "id": 80,
      "transactionId": 81,
      "transactionRefId": 13432435435242,
      "debit": 0,
      "credit": 10000.00000000,
      "balance": 10658503.00000000,
      "narration": "REFUND AMT 100.00 AED",
      "date": "2024-10-03T07:23:15.928+00:00"
    },
    {
      "id": 77,
      "transactionId": 77,
      "transactionRefId": 13432435435242,
      "debit": 100.00000000,
      "credit": 0,
      "balance": 10648503.00000000,
      "narration": "POS AT Sains Online PIN+Cashb - London, GBR CARD NO *2962 REF NO 8499816893999692000",
      "date": "2024-10-03T07:23:02.284+00:00"
    }
  ]
}