Canopy Servicing Core API

API Overview
Canopy allows you to easily manage credit products from a servicing and compliance perspective - whether newly launched or migrated from existing systems. Using Canopy, you can track balances and transactions for each customer of your product, both in real-time and historically. You can access and track information related to disputes, see how various policy and product changes would impact your customers, and readily generate compliance reports and minimize your risk with all real-time information always on hand.

Simply configure your product’s policies through our Policy Management Dashboard, and then you can immediately begin adding customer accounts and relying on Canopy for accurate servicing information.

This is the documentation for version 1.3 of the API. Last update on Nov 16, 2020.

Base URL
https://sandbox.canopyservicing.com

API structure has changed on
  • Updated: GET /accounts/{account_id}/notes
  • Response modified: 200
  • Body attributes added: note_id, account_id, author, message, created_date
  • Body attribute removed: activity
API structure has changed on
  • Updated: GET /customers/accounts
  • Response modified: 200
  • Updated: POST /customers
  • Response modified: 200
  • Body attribute removed: accounts
API structure has changed on
  • Removed: GET /customers
  • Removed: GET /accounts
  • Updated: GET /accounts/{account_id}/notes
  • Response modified: 200
  • Updated: POST /accounts/{account_id}/notes
  • Response modified: 200
  • Body attribute added: author
  • Body attribute removed:
API structure has changed on
  • Removed: GET /accounts/{account_id}/statements
  • Added: GET /accounts/{account_id}/statements
API structure has changed on
  • Added: POST /accounts/{account_id}/line_items/charges
  • Added: POST /accounts/{account_id}/line_items/payments
API structure has changed on
  • Updated: GET /accounts
  • Response modified: 200
  • Updated: POST /accounts
  • Response modified: 201
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Updated: GET /accounts/{account_id}/statements
  • Response modified: 200
  • Body attributes added: available_credit_balance, total_balance, account_id, min_pay_due_date, min_pay_amount_cents, billing_cycle_start_date, billing_cycle_end_date, line_items
  • Body attributes removed: accounts_overview, total_credit_issued_cents, utilization_rate, product_id
  • Updated: GET /products
  • Response modified: 200
  • Updated: POST /products
  • Updated: GET /products/{product_id}
  • Response modified: 200
  • Updated: PUT /products/{product_id}
API structure has changed on
  • Updated: GET /accounts
  • Response modified: 200
  • Updated: POST /accounts
  • Response modified: 201
  • Body attribute removed: effective_as_of_date
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Body attribute removed: effective_as_of_date
API structure has changed on
  • Updated: GET /accounts
  • Response modified: 200
  • Updated: POST /accounts
  • Response modified: 201
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Updated: GET /products
  • Response modified: 200
  • Updated: GET /products/{product_id}
  • Response modified: 200
API structure has changed on
  • Updated: GET /accounts
  • Response modified: 200
  • Updated: POST /accounts
  • Response modified: 201
  • Body attributes added: available_credit_balance, effective_as_of_date
  • Updated: GET /accounts/{account_id}
  • URL parameter added: effective_as_of_date
  • Response modified: 200
  • Body attributes added: available_credit_balance, effective_as_of_date
  • Removed: GET /accounts/{account_id}/summaries
API structure has changed on
  • Added: GET /accounts/{account_id}/line_items/{line_item_id}
API structure has changed on
  • Updated: GET /accounts/{account_id}/line_items
  • Response modified: 200
  • Body attributes added: total_interest_accrued_cents, total_paid_down_cents
API structure has changed on
  • Updated: GET /accounts
  • Response modified: 200
  • Updated: POST /accounts
  • Response modified: 201
  • Body attribute added: product
  • Body attribute removed: product_id
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Body attribute added: product
  • Body attribute removed: product_id
API structure has changed on
  • Updated: GET /products
  • Response modified: 200
  • Body attribute removed: current_accounts
  • Updated: GET /products/{product_id}
  • Response modified: 200
  • Body attribute removed: current_accounts
  • Added: GET /products/{product_id}/accounts
API structure has changed on
  • Updated: GET /products
  • Response modified: 200
  • Body attributes added: product_id, name, description, created_at, type, status, policies, product_summary, default_attributes, current_accounts
API structure has changed on
  • Updated: GET /accounts/{account_id}/statements
  • Response modified: 200
  • Body attributes added: accounts_overview, total_credit_issued, utilization, product_id
  • Body attributes removed: available_credit_balance, total_balance, account_id, min_pay_due_date, min_pay_amount_cents, billing_cycle_start_date, billing_cycle_end_date, line_items
  • Updated: GET /products
  • Response modified: 200
  • Body attributes removed: product_id, name, description, created_at, type, status, policies, default_attributes, current_accounts
  • Updated: GET /products/{product_id}
  • Response modified: 200
  • Body attribute added: product_summary
API structure has changed on
  • Updated: GET /accounts
  • Response modified: 200
  • Updated: POST /accounts
  • Response modified: 201
  • Body attribute added: total_balance
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Body attribute added: total_balance
API structure has changed on
  • Updated: GET /accounts/{account_id}/summaries
  • Response modified: 200
  • Body attributes added: credit_limit_cents, rate
  • Updated: GET /products
  • Response modified: 200
  • Body attribute added: status
  • Updated: GET /products/{product_id}
  • Response modified: 200
  • Body attribute added: status
  • Updated: GET /products/{product_id}/summaries
  • Response modified: 200
  • Body attribute added: accounts_overview
  • Body attribute removed: total_account_count
API structure has changed on
  • Updated: POST /products
  • Body attribute added: status
  • Body attribute modified: type
  • Updated: PUT /products/{product_id}
  • Body attribute added: status
  • Body attribute modified: type
API structure has changed on
  • Updated: GET /accounts/{account_id}/line_items
  • URL parameter added: line_item_type
  • Updated: POST /accounts/{account_id}/line_items/charges
  • Body attribute added: rate
  • Body attributes modified: amount_cents, effective_at, reference_id
  • Removed: GET /accounts/{account_id}/summary
  • Removed: GET /accounts/{account_id}/statement
  • Added: GET /accounts/{account_id}/summaries
  • Added: GET /accounts/{account_id}/statements_list
  • Added: GET /accounts/{account_id}/statements
  • Removed: GET /products/{product_id}/summary
  • Added: GET /products/{product_id}/summaries
API structure has changed on
  • Updated: GET /accounts/{account_id}/line_items
  • Response modified: 200
  • Body attributes added: account_id, line_item_status, type, merchant_data, product_id, reference_id, dispute_id, external_ids
  • Body attribute removed: status
  • Added: POST /accounts/{account_id}/line_items/{line_item_id}/disputes
  • Added: GET /accounts/{account_id}/statement
API structure has changed on
  • Updated: POST /accounts/{account_id}/line_items/payments
  • Body attribute added: reference_id
  • Body attribute removed: user_id
API structure has changed on
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Body attributes added: account_id, account_status, account_status_subtype, effective_at, created_at, product_id, external_account_ids, credit_limit_cents, rate
  • Updated: PUT /accounts/{account_id}
  • Body attributes added: rate, credit_limit_cents
  • Body attributes removed: default_rate, default_credit_limit_cents
  • Updated: POST /accounts/{account_id}/line_items/charges
  • Response modified: 204
  • Body attribute added: line_item_id
  • Updated: POST /accounts/{account_id}/line_items/payments
  • Response modified: 204
  • Body attribute added: line_item_id
  • Updated: GET /accounts/{account_id}/summary
  • Response modified: 200
  • Body attributes added: available_credit_balance, total_balance, account_id, effective_as_of_date
  • Updated: GET /products/{product_id}/summary
  • Response modified: 200
  • Body attributes added: total_account_count, total_credit_issued, utilization, product_id, effective_as_of_date
API structure has changed on
  • Updated: POST /accounts
  • Response modified: 201
  • Body attributes added: account_id, account_status, account_status_subtype, effective_at, created_at, product_id, external_account_ids, credit_limit_cents, rate
API documentation has been created on