For the complete documentation index, see llms.txt. This page is also available as Markdown.

Account Statement

Generates and retrieves account statements for a specific user within a defined time period. Supports multiple export formats for financial reporting and record-keeping.

Endpoint

GET/v2/report/statement

Link

Request

Authentication

An API key is required for authentication. Include it in the Authorization header.

  • Header: Authorization

  • Value: Your API key token

Query Parameters

Parameter
Type
Description & Values
Required
Example

suid

string

User identifier for statement generation.

Yes

user_123abc

period.from

string

Start date (ISO 8601 format).

Yes

2024-01-01T00:00:00Z

period.to

string

End date (ISO 8601 format).

Yes

2024-03-31T23:59:59Z

option.format

string

Export format: - PDF - XLSX - Unknown (system default)

No

PDF

Headers

Key
Value
Required

Authorization

Bearer <JWT>

Yes

Accept

application/json

Yes


Response (200 OK)

Returns the generated statement with filename and file data. The data field contains base64-encoded statement content.

Response Fields

Field
Type
Description
Example

data

string

Statement data (base64-encoded).

"JVBERi0xLjcKJe..."

name

string

Statement filename.

"statement_Q1_2024.pdf"

Example Response:


Examples

Basic Request (PDF Format)

Request for Excel Format

Request with System Default Format


Common Statement Formats

  • PDF: Printable document format, ideal for official records and sharing

  • XLSX: Excel spreadsheet format, suitable for data analysis and accounting software

  • Unknown: System default format (typically PDF)


Error Responses

  1. Missing Required Parameters:

  2. Invalid Date Format:

  3. User Not Found:

  4. Unauthorized:


Notes

  • Date Range: The maximum period for a single statement may be limited (e.g., 1 year)

  • File Size: Large statements may take longer to generate and return

  • Data Freshness: Statements reflect data as of the generation time

  • Timezone: Date parameters should use UTC timezone

Typical Use Cases:

  • Monthly/quarterly financial reporting

  • Audit and compliance documentation

  • Customer account statements

  • Tax preparation and accounting

  • Transaction history reviews

Best Practices:

  • Always specify the desired format using option.format

  • Use appropriate date ranges to avoid very large files

  • Handle base64 decoding on the client side for file reconstruction

  • Check filename extension (name field) to determine file type before processing

Request sample

Response sample:

Last updated