CSL Pay Developers

End-Of-Day Statement For A Virtual Account

GET /collection-middleware/statement/end-of-day

Returns ledger movements on the given master account for a single business day, with the opening and closing balance for that day. Consecutive days reconcile end to end: the closing balance of one day is exactly the opening balance of the next. The merchant is resolved from the bearer token's partnerCode claim and must own the account.

Query parameters

  • accountNumber string
    Master Account Number.
  • date string
    Business date, ISO-8601 calendar date.
  • 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 string
    A string indicating the outcome of the request.
  • data object14 fields
    An object containing the end-of-day statement data.
    • accountNumber string
      The account number associated with the statement.
    • businessDate string
      The date of the business day for which the statement is generated.
    • currency string
      The currency of the statement.
    • openingBalanceDate string
      The date of the opening balance for the statement.
    • closingBalanceDate string
      The date of the closing balance for the statement.
    • openingBalanceAmount number
      The opening balance amount for the statement.
    • closingBalanceAmount number
      The closing balance amount for the statement.
    • details array18 fields
      An array of transaction details for the statement.
      • systemReference string
        A unique reference for the transaction within the system.
      • originalSystemReference string
        The original reference for the transaction from the originating system.
      • direction string
        The direction of the transaction (e.g. credit or debit).
      • transactionType string
        The type of transaction (e.g. payment or refund).
      • amount number
        The amount of the transaction.
      • currency string
        The currency of the transaction.
      • completedTime string
        The time at which the transaction was completed.
      • beneficiaryAccountNumber string
        The account number of the beneficiary for the transaction.
      • 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 of the transaction.
    • currentPage integer
      The current page number of the collection middleware statement.
    • totalPages integer
      The total number of pages in the collection middleware statement.
    • totalRecords integer
      The total number of records in the collection middleware statement.
    • hasMore boolean
      A boolean indicating whether there are more records to retrieve.
    • netMovementAmount number
      The net movement amount of the collection middleware statement.
    • balanceReconciled boolean
      A boolean indicating whether the balance has been reconciled.
  • error object2 fields
    An object containing error information.
    • code string
      The error code.
    • message string
      The error message returned if an error occurs.

Errors

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