Upcoming Release

Get a list of all current and prior statements for a specific account

GET /accounts/{account_id}/statements/list

List of statements for the account. To view line items for a specific statement, use the /accounts/{account_id}/statements route

Path parameters

Query parameters

  • offset integer

    The zero-indexed starting point for paginated statements list requests sorted by reverse statement date.

  • limit integer

    The maximum number of accounts to be returned. Defaults to 100.

Responses

  • 200
    Hide response attributes Show response attributes array[object]
    • account_id string Required

      The Canopy-generated ID for the account

    • statement_id string Required

      The Canopy-generated ID for the statement

    • cycle_summary object
      Hide cycle_summary attributes Show cycle_summary attributes object
      • cycle_inclusive_start string(date-time) | null Required

        The inclusive starting Date-Time that defines which transactions are part of this statement.

      • cycle_exclusive_end string(date-time) | null Required

        The inclusive ending Date-Time that defines which transactions are part of this statement.

    • min_pay_due_cents object
      Hide min_pay_due_cents attributes Show min_pay_due_cents attributes object
      • min_pay_cents integer Required

        Total amount due for the billing cycle, summing cycle principal, interest, deferred interest, and fees outstanding.

      • min_pay_due_at string(date-time) Required

        The Date-Time the payment for this billing cycle is due.

    • balance_summary object
      Hide balance_summary attribute Show balance_summary attribute object
  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    Statements not found

  • 429

    Too many requests.

  • default

    Unexpected Error.

GET /accounts/{account_id}/statements/list 
curl \
 -X GET https://sandbox-api.canopyservicing.com/accounts/31mNprzLd2bKl6koVna68ARM/statements/list \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "account_id": "31mNprzLd2bKl6koVna68ARM",
    "statement_id": "31mNprzLd2bKl6koVna68ARM",
    "cycle_summary": {
      "cycle_inclusive_start": "2023-05-04T09:42:00+00:00",
      "cycle_exclusive_end": "2023-05-04T09:42:00+00:00"
    },
    "min_pay_due_cents": {
      "min_pay_cents": 160000,
      "min_pay_due_at": "2019-10-18T23:04:48.321+00:00"
    },
    "balance_summary": {
      "total_balance_cents": 400000
    }
  }
]
Response examples (200) 
[
  {
    "account_id": "31mNprzLd2bKl6koVna68ARM",
    "statement_id": "31mNprzLd2bKl6koVna68ARM",
    "cycle_summary": {
      "cycle_inclusive_start": "2025-05-04T09:42:00Z",
      "cycle_exclusive_end": "2025-05-04T09:42:00Z"
    },
    "min_pay_due_cents": {
      "min_pay_cents": 160000,
      "min_pay_due_at": "2019-10-18T23:04:48.321+00:00"
    },
    "balance_summary": {
      "total_balance_cents": 400000
    }
  }
]