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:
AuthorizationValue: Your API key token
Query Parameters
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
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
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 sharingXLSX: Excel spreadsheet format, suitable for data analysis and accounting softwareUnknown: System default format (typically PDF)
Error Responses
Missing Required Parameters:
Invalid Date Format:
User Not Found:
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.formatUse appropriate date ranges to avoid very large files
Handle base64 decoding on the client side for file reconstruction
Check filename extension (
namefield) to determine file type before processing
Request sample
Response sample:
Last updated

