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
-
accountNumberMaster Account Number.
-
dateBusiness date, ISO-8601 calendar date.
-
page1-based page number.
-
pageSizeRows per page, 1-500.
Request body (optional)
This endpoint accepts a body with no declared schema.
Response 200
-
successA string indicating the outcome of the request.
-
dataAn object containing the end-of-day statement data.
-
accountNumberThe account number associated with the statement.
-
businessDateThe date of the business day for which the statement is generated.
-
currencyThe currency of the statement.
-
openingBalanceDateThe date of the opening balance for the statement.
-
closingBalanceDateThe date of the closing balance for the statement.
-
openingBalanceAmountThe opening balance amount for the statement.
-
closingBalanceAmountThe closing balance amount for the statement.
-
detailsAn array of transaction details for the statement.
-
systemReferenceA unique reference for the transaction within the system.
-
originalSystemReferenceThe original reference for the transaction from the originating system.
-
directionThe direction of the transaction (e.g. credit or debit).
-
transactionTypeThe type of transaction (e.g. payment or refund).
-
amountThe amount of the transaction.
-
currencyThe currency of the transaction.
-
completedTimeThe time at which the transaction was completed.
-
beneficiaryAccountNumberThe account number of the beneficiary for the transaction.
-
beneficiaryNameThe name of the beneficiary.
-
beneficiaryBankNameThe name of the beneficiary's bank.
-
beneficiaryBankSwiftCodeThe SWIFT code of the beneficiary's bank.
-
payerNameThe name of the payer.
-
payerAccountNumberThe account number of the payer.
-
payerBankNameThe name of the payer's bank.
-
payerBankSwiftCodeThe SWIFT code of the payer's bank.
-
payerAddressThe address of the payer.
-
remarkA remark or description of the transaction.
-
valueDateThe date of the transaction.
-
-
currentPageThe current page number of the collection middleware statement.
-
totalPagesThe total number of pages in the collection middleware statement.
-
totalRecordsThe total number of records in the collection middleware statement.
-
hasMoreA boolean indicating whether there are more records to retrieve.
-
netMovementAmountThe net movement amount of the collection middleware statement.
-
balanceReconciledA boolean indicating whether the balance has been reconciled.
-
-
errorAn object containing error information.
-
codeThe error code.
-
messageThe error message returned if an error occurs.
-
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 |