WalletEntryPage

A page of wallet entries in posting order

entries object[]

Entries on this page, oldest first

Array [

entryIdstring<uuid>

Unique identifier of the entry

statusstring

Entry status

Possible values: [POSTED]

directionstring

Whether the entry credits or debits the wallet

Possible values: [CREDIT, DEBIT]

amountstring

Entry amount as an exact decimal string

Example: 250.00

currencystring

Currency code

Example: AED

postedAtstring<date-time>

When the entry was posted

bookingDatestring<date>

Booking date of the transaction

updatedAtstring<date-time>

When the transaction was last updated

descriptionstring

Statement description, or null when none is available

categorystring

Entry category

Possible values: [FUNDING, COLLECTION, PAYMENT, FEE, FX, RETURN, TRANSFER, ADJUSTMENT, OPENING_BALANCE, OTHER]

journalIdstring<uuid>

Identifier of the journal the entry belongs to

hubpayReferencestring

Hubpay transaction reference

transactionTypestring

Hubpay transaction type

sourceTransactionIdstring<uuid>

Identifier of the source transaction

sourceTransactionTypestring

Type of the source transaction

relatedEntryIdsstring<uuid>[]

Other entries on this wallet with the same hubpayReference

providerTransactionIdstring

Payment provider's transaction identifier, where one exists

counterparty object

Counterparty details, where known

namestring

Counterparty name

ibanstring

Counterparty IBAN

bankReferencestring

Bank reference

paymentReferencestring

Payment reference

]

nextCursorstring

Opaque cursor to pass as cursor on the next request. Equals the request cursor when the page is empty

balanceAfterstring

Wallet balance from the start of history to nextCursor inclusive

Example: 1250.00

entryCountThroughinteger<int64>

Number of entries from the start of history to nextCursor inclusive

visibleThroughstring<date-time>

Entries posted up to this instant are visible

WalletEntryPage

{
  "entries": [
    {
      "entryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "POSTED",
      "direction": "CREDIT",
      "amount": "250.00",
      "currency": "AED",
      "postedAt": "2024-07-29T15:51:28.071Z",
      "bookingDate": "2024-07-29",
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "description": "string",
      "category": "FUNDING",
      "journalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "hubpayReference": "string",
      "transactionType": "string",
      "sourceTransactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "sourceTransactionType": "string",
      "relatedEntryIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "providerTransactionId": "string",
      "counterparty": {
        "name": "string",
        "iban": "string",
        "bankReference": "string",
        "paymentReference": "string"
      }
    }
  ],
  "nextCursor": "string",
  "balanceAfter": "1250.00",
  "entryCountThrough": 0,
  "visibleThrough": "2024-07-29T15:51:28.071Z"
}