List statements
Returns a paginated list of statements for the authenticated merchant grouped by month.
The response includes month-based pagination where each page contains all statements for a specific month.
The response includes cursor-based pagination with previous and next cursors
that can be used to navigate through months.
month
string
Optional. Month to retrieve statements for in YYYY-MM format (default: current month)
| Attribute | Description |
|---|---|
previousobject
|
Cursor for the previous month. Contains 'before' (YYYY-MM format) parameter. Use these values in the 'month' parameter of the next request to get the previous month. |
pagearray
|
The current month's statements, ordered by day (newest first). |
nextobject
|
Cursor for the next month. Contains 'after' (YYYY-MM format) parameter. Use these values in the 'month' parameter of the next request to get the next month. |
invalid_month
Invalid month format. Expected YYYY-MM format (e.g., '2024-12')
UNHANDLED_ERROR
This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.
INVALID_ARGUMENTS
This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.
BAD_VERSION
This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.