Bank statement report

The Bank Statement Report provides a PDF-formatted account statement that includes company details and transaction information for audit and regulatory purposes. This report is designed for formal documentation requirements and external reporting needs.

Access Methods

Reports on Request (Asynchronous)

Endpoint: POST /api/v3/reports/requests/bank-statement-report
Format: PDF only
Method: Asynchronous report generation with polling for completion

Note: This report is only available through the asynchronosus reports-on-request endpoint due to the PDF generation requirements.

Request Parameters

Parameter	Required	Description
reportFormatType	Mandatory	Must be set to `"pdf"`
accountId	Mandatory	GUID of the account for which the statement should be generated
fromDate	Mandatory	Format: YYYY-MM-DD. Start date for transaction filtering (transaction date)
toDate	Mandatory	Format: YYYY-MM-DD. End date for transaction filtering (transaction date)
reportVersion	Mandatory	Must be set to `2` for the enhanced version with transaction date filtering
name	Optional	Custom name for the generated report

Error Handling: If an invalid report version is specified, the following error will be returned:

{
  "errors": [
    {
      "errorCode": "InvalidReportVersion",
      "errorDescription": "Invalid report version",
      "errorDetail": [
        {
          "name": "ValidReportVersion",
          "value": "2"
        }
      ]
    }
  ]
}

Request Example

Endpoint: POST /api/v3/reports/requests/bank-statement-report

{
  "reportFormatType": "pdf",
  "accountId": "78343563-F427-4F4F-09E1-2863145BE9AD",
  "fromDate": "2024-11-01",
  "toDate": "2024-11-08",
  "reportVersion": 2,
  "name": "Monthly Statement November 2024"
}

PDF Report Format

The generated PDF report includes the following sections:

Header Information

Official letterhead with company details and branding
Account holder information
Statement period (from/to dates)
Account number (IBAN format)

Transaction Details

The enhanced version (reportVersion: 2) includes:

Transaction Date: When the transaction was processed
Value Date: When the transaction takes effect
Description: Transaction type and details
Reference: Unique transaction identifier
Debit/Credit Amount: Transaction amounts in account currency
Counterparty Information: Details of the other party involved

Sample PDF Layouts

Note: the letterhead information will be dependent on the branch the account is associated with. The example below is for Banking Circle S.A.