Intraday Statement For A Virtual Account

GET /collection-middleware/statement/intraday

Returns ledger movements on the given master account within a half-open [startTime, endTime) window, with the account balance at each edge. The merchant is resolved from the bearer token's partnerCode claim and must own the account. Timestamps are RFC-3339, for example 2025-05-16T00:00:00Z.

Query parameters

accountNumber string

Master account number.
startTime string

Window start, inclusive. RFC-3339.
endTime string

Window end, exclusive. RFC-3339.
page integer

1-based page number.
pageSize integer

Rows per page, 1-500.

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

success boolean

A string indicating the success status of the request.
data object14 fields

An object containing the collection middleware statement data.
- accountNumber string
  
  The account number associated with the collection middleware statement.
- businessDate string
  
  The business date of the collection middleware statement.
- currency string
  
  The currency of the collection middleware statement.
- openingBalanceDate string
  
  The date of the opening balance of the collection middleware statement.
- closingBalanceDate string
  
  The date of the closing balance of the collection middleware statement.
- openingBalanceAmount number
  
  The opening balance amount of the collection middleware statement.
- closingBalanceAmount number
  
  The closing balance amount of the collection middleware statement.
- details array18 fields
  
  An array of details for the collection middleware statement transactions.
  - systemReference string
    
    The system reference of a transaction in the collection middleware statement.
  - originalSystemReference string
    
    The original system reference of a transaction in the collection middleware statement.
  - direction string
    
    The direction of a transaction in the collection middleware statement.
  - transactionType string
    
    The type of a transaction in the collection middleware statement.
  - amount number
    
    The amount of a transaction in the collection middleware statement.
  - currency string
    
    The currency of a transaction in the collection middleware statement.
  - completedTime string
    
    The time a transaction in the collection middleware statement was completed.
  - beneficiaryAccountNumber string
    
    The beneficiary account number of a transaction in the collection middleware statement.
  - beneficiaryName string
    
    The name of the beneficiary.
  - beneficiaryBankName string
    
    The name of the beneficiary's bank.
  - beneficiaryBankSwiftCode string
    
    The SWIFT code of the beneficiary's bank.
  - payerName string
    
    The name of the payer.
  - payerAccountNumber string
    
    The account number of the payer.
  - payerBankName string
    
    The name of the payer's bank.
  - payerBankSwiftCode string
    
    The SWIFT code of the payer's bank.
  - payerAddress string
    
    The address of the payer.
  - remark string
    
    A remark or description of the transaction.
  - valueDate string
    
    The date the transaction was processed.
- currentPage integer
  
  The current page number of the statement.
- totalPages integer
  
  The total number of pages in the statement.
- totalRecords integer
  
  The total number of records in the statement.
- hasMore boolean
  
  A boolean indicating whether there are more records to retrieve.
- netMovementAmount number
  
  The net movement amount of the account.
- balanceReconciled boolean
  
  A boolean indicating whether the balance is reconciled.
error object2 fields

An object containing error information.
- code string
  
  The error code.
- message string
  
  A message describing the error that occurred.

Errors

Status	Meaning
400	Malformed or out-of-bounds query parameters
403	Token is not bound to a merchant
404	No such virtual account for this merchant