Canopy API - Latest

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

account_id string Required

ID of the Account

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 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
  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
  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
  total_balance_cents integer Required
  
  The total balance (in cents) associated with the account.
• 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://<your_environment_name>-uat-api.canopyservicing.com/accounts/can_52322/statements/list \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response example (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
    }
  }
]