Get Account Statements

Use the Get Account Statements API endpoint to retrieve a paginated list of billing cycle statements for a customer's line of credit account.

📘
Early Access
Credit API endpoints are currently being finalised as part of ongoing product development. While we do not anticipate significant changes, some interfaces, behaviours, and documentation may be refined before general availability.

The Get Account Statements endpoint enables you to retrieve a paginated list of billing cycle statements for a customer's line of credit account. Each statement includes billing cycle dates, balances, and payment information. Results are returned in descending order, with the most recent statement first.

To download a PDF copy of a specific statement, pass its statementId to the Get Statement Download URL endpoint.

📘
More Information
For more information about the Explorer endpoints, see: Credit Explorer.

Example Request

Retrieve account statements by making a GET request to the Get Account Statements endpoint.

GET {{baseUrl}}/api/v1/credit/explorer/accounts/{account_id}/statements

Path Parameters

Parameter	Description
`account_id`	string. Required. The unique identifier of the account.

Query Parameters

Parameter	Description
`pageSize`	integer. Optional. The number of results to return per page. Defaults to `50`.
`pageToken`	string. Optional. The cursor token for the next page of results. Pass the `nextPageToken` value returned in the previous response.
`fromDate`	string. Optional. The start date of the date range, in `YYYY-MM-DD` format.
`toDate`	string. Optional. The end date of the date range, in `YYYY-MM-DD` format.

Example Response

A successful request returns a 200 HTTP status code with a paginated list of statements.

{
  "results": [
    {
      "accountId": "acc_123456",
      "statementId": "stmt_001",
      "cycleNumber": 12,
      "currency": "USD",
      "cycleStartDate": "2025-01-01",
      "cycleEndDate": "2025-01-31",
      "dueDate": "2025-02-15",
      "startingBalance": 1000.00,
      "endingBalance": 1200.00,
      "minimumPayment": 25.00
    }
  ],
  "nextPageToken": "cursor_abc123"
}

{
  "detail": "Account with the specified ID does not exist"
}

Response Fields

Statement Response Object

Attribute	Description
`results`	array. A list of billing cycle statements. See Statement Object.
`nextPageToken`	string or null. The cursor token to retrieve the next page of results. Pass this value as the `pageToken` query parameter in the next request. `null` if there are no further pages.

Statement Object

Attribute	Description
`accountId`	string. The unique identifier of the account.
`statementId`	string. The unique identifier of the statement. Pass this value to the Get Statement Download URL endpoint to retrieve a PDF download link.
`cycleNumber`	integer or null. The billing cycle number.
`currency`	string. The currency of the account.
`cycleStartDate`	string or null. The start date of the billing cycle.
`cycleEndDate`	string or null. The end date of the billing cycle.
`dueDate`	string or null. The payment due date for the billing cycle.
`startingBalance`	number or null. The account balance at the start of the billing cycle.
`endingBalance`	number or null. The account balance at the end of the billing cycle.
`minimumPayment`	number or null. The minimum payment amount due for the billing cycle.

Error Messages

If there is a problem with the request, the response returns one of the following errors:

404 — The account_id provided does not match an existing account.
422 — A query parameter value is invalid, for example an incorrectly formatted date. The response includes details of the validation failure.

Updated 8 days ago

Did this page help you?