Canopy Servicing Core API

API Overview
Canopy allows you to easily manage credit, installment, or other more complex lending programs 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 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.

Canopy additionally surfaces information around all of your lending activity through its intuitive UI which provides a customer support interface as well as at-a-glance data needed for compliance and insights.

Simply configure your product’s policies through our Create Product API endpoint, and then you can immediately begin adding customer accounts and relying on Canopy for accurate servicing information.

This is the documentation for version 1.1.1 of the API. Last update on Jun 17, 2021.

Base URL
https://sandbox-api.canopyservicing.com

API structure has changed on
  • Updated: POST /accounts
API structure has changed on
  • Added: PUT /accounts/{account_id}/payment_processor_config
  • Removed: PUT /accounts/{account_id}/payment_processor_config
API structure has changed on
  • Updated: GET /customers/accounts
  • Response modified: 200
  • Updated: POST /customers
  • Updated: PUT /accounts/{account_id}/customers/{customer_id}/cards
  • Body attribute added: spend_limit
  • Response modified: 200
  • Body attribute added: spend_limit
  • Updated: POST /accounts/{account_id}/customers/{customer_id}/cards
  • Body attribute added: spend_limit
  • Response modified: 200
  • Body attribute added: spend_limit
  • Updated: POST /accounts
  • Body attribute added: discounts
  • Response modified: 200
  • Body attribute added: discounts
  • Updated: GET /accounts/{account_id}
  • Query parameter added: external
  • Response modified: 200
  • Body attribute added: discounts
  • Added: DELETE /accounts/{account_id}
  • Updated: PUT /accounts/{account_id}/payment_processor_config
  • Body attributes added: autopay_enabled, default_payment_processor_method
  • Body attribute removed: general_configs
  • Response modified: 200
  • Body attributes added: autopay_enabled, default_payment_processor_method
  • Body attribute removed: general_configs
  • Added: GET /accounts/{account_id}/credit_reports/list
  • Added: GET /accounts/{account_id}/credit_reports/{credit_report_id}
  • Added: PUT /organization/credit_reporting
  • Updated: GET /organization
  • Response modified: 200
API structure has changed on
  • Updated: GET /customers/accounts
  • Response modified: 200
  • Added: PUT /accounts/{account_id}/customers/{customer_id}/cards
  • Updated: POST /accounts
  • Body attribute added: external_account_id
  • Response modified: 200
  • Body attribute added: external_account_id
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Body attribute added: external_account_id
  • Updated: GET /accounts/{account_id}/line_items
  • Response modified: 200
  • Updated: GET /accounts/{account_id}/line_items/{line_item_id}
  • Response modified: 200
  • Updated: PUT /accounts/{account_id}/line_items/{line_item_id}
  • Response modified: 200
  • Updated: POST /accounts/{account_id}/line_items/charges
  • Response modified: 200
  • Updated: POST /accounts/{account_id}/line_items/payments
  • Response modified: 200
  • Updated: POST /accounts/{account_id}/line_items/payment_reversals/{line_item_id}
  • Body attribute removed: effective_at
  • Added: POST /accounts/{account_id}/line_items/fee_waiver/{line_item_id}
  • Updated: GET /accounts/{account_id}/statements/{statement_id}
  • Response modified: 200
  • Updated: PUT /accounts/{account_id}/payment_processor_config
  • Body attributes added: ach, debit_card, general_configs
  • Body attributes removed: payment_processor_name, autopay_enabled, repay_config
  • Response modified: 200
  • Body attributes added: ach, debit_card, general_configs
  • Body attributes removed: payment_processor_name, autopay_enabled, repay_config
API structure has changed on
  • Updated: GET /customers/accounts
  • Response modified: 200
  • Updated: POST /customers
  • Removed: PUT /accounts/{account_id}/customers/{customer_id}/cards
  • Added: POST /accounts/{account_id}/customers/{customer_id}/cards
  • Updated: POST /accounts
  • Response modified: 200
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Updated: GET /accounts/{account_id}/line_items
  • Response modified: 200
  • Updated: GET /accounts/{account_id}/line_items/{line_item_id}
  • Response modified: 200
  • Updated: PUT /accounts/{account_id}/line_items/{line_item_id}
  • Response modified: 200
  • Updated: POST /accounts/{account_id}/line_items/charges
  • Response modified: 200
  • Updated: POST /accounts/{account_id}/line_items/payments
  • Response modified: 200
  • Added: POST /accounts/{account_id}/line_items/payment_reversals/{line_item_id}
  • Updated: GET /accounts/{account_id}/notes
  • Response modified: 200
  • Body attribute modified: message
  • Updated: POST /accounts/{account_id}/notes
  • Response modified: 200
  • Body attribute modified: message
  • Updated: GET /accounts/{account_id}/statements/{statement_id}
  • Response modified: 200
  • Updated: PUT /organization/issuer_processors
  • Body attribute added: lithic_config
  • Body attribute removed: privacy_config
  • Response modified: 200
  • Body attribute added: lithic_config
  • Body attribute removed: privacy_config
  • Added: PUT /accounts/{account_id}/payment_processor_config
  • Updated: GET /organization
  • Response modified: 200
  • Body attribute added: config
API structure has changed on
  • Updated: GET /customers/accounts
  • Query parameter added: search_parameters
API structure has changed on
  • Added: PUT /organization/issuer_processors
API structure has changed on
  • Updated: GET /products
  • Response modified: 200
  • Updated: POST /products
  • Response modified: 200
  • Updated: GET /customers/accounts
  • Response modified: 200
  • Updated: POST /accounts
  • Response modified: 200
  • Body attribute added: issuer_processor_details
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Body attribute added: issuer_processor_details
  • Updated: GET /accounts/{account_id}/line_items
  • Response modified: 200
  • Body attribute added:
  • Updated: GET /accounts/{account_id}/line_items/{line_item_id}
  • Response modified: 200
  • Body attribute added:
  • Updated: GET /accounts/{account_id}/statements/{statement_id}
  • Response modified: 200
API structure has changed on
  • Updated: POST /accounts
  • Response modified: 200
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Updated: POST /accounts/{account_id}/line_items/charges
API structure has changed on
  • Updated: GET /products
  • Response modified: 200
  • Body attribute removed: paging
  • Updated: POST /products
  • Body attribute added: admin
  • Response modified: 200
  • Body attributes added: admin,
  • Added: PUT /accounts/{account_id}/customers/{customer_id}/cards
  • Updated: GET /accounts/{account_id}/line_items
  • URL parameters added: starting_after, ending_before
  • URL parameter removed: offset
  • Response modified: 200
  • Body attributes added: results, paging
  • Body attributes removed: account_id, line_item_id, effective_at, created_at, product_id, line_item_overview, line_item_summary, merchant_data, issuer_processor_metadata, external_fields
  • Updated: GET /accounts/{account_id}/line_items/{line_item_id}
  • URL parameters added: limit, starting_after, ending_before
  • Response modified: 200
  • Body attributes added: results, paging
  • Body attributes removed: account_id, line_item_id, effective_at, created_at, product_id, line_item_overview, line_item_summary, merchant_data, issuer_processor_metadata, external_fields
  • Added: PUT /products/{product_id}/migration_mode
API structure has changed on
  • Updated: GET /products
  • URL parameters added: starting_after, ending_before
  • URL parameters removed: direction, id, effective_at
  • Response modified: 200
  • Updated: GET /customers/accounts
  • URL parameters added: starting_after, ending_before
  • URL parameter removed: offset
  • Response modified: 200
  • Body attribute added: paging
  • Added: PUT /organization/subscribe
  • Added: PUT /organization/payment_processors
  • Removed: PUT /organization/subscribe
  • Removed: PUT /organization/payment_processors
API structure has changed on
  • Updated: GET /products
  • URL parameters added: direction, id, effective_at
  • URL parameter removed: offset
  • Response modified: 200
  • Body attributes added: results, paging
  • Body attributes removed: product_id, created_at, effective_at, external_product_id, product_overview, product_lifecycle_policies, promotional_policies, post_promotional_policies, product_summary
  • Updated: POST /products
  • Updated: GET /accounts/{account_id}
  • URL parameter modified: account_id
  • Updated: GET /accounts/{account_id}/line_items
  • URL parameter modified: account_id
  • Response modified: 200
  • Body attributes modified: account_id, line_item_id
  • Updated: GET /accounts/{account_id}/line_items/{line_item_id}
  • URL parameters modified: account_id, line_item_id
  • Response modified: 200
  • Body attributes modified: account_id, line_item_id
  • Updated: POST /accounts/{account_id}/line_items/charges
  • URL parameter modified: account_id
  • Updated: POST /accounts/{account_id}/line_items/payments
  • URL parameter modified: account_id
  • Updated: GET /accounts/{account_id}/notes
  • URL parameter modified: account_id
  • Updated: POST /accounts/{account_id}/notes
  • URL parameter modified: account_id
  • Updated: GET /accounts/{account_id}/statements/list
  • URL parameter modified: account_id
  • Updated: GET /accounts/{account_id}/statements/{statement_id}
  • URL parameter modified: account_id
  • Response modified: 200
  • Updated: GET /accounts/{account_id}/amortization_schedule
  • URL parameter modified: account_id
API structure has changed on
  • Updated: GET /products
  • Response modified: 200
  • Updated: POST /products
  • Response modified: 200
  • Updated: GET /customers/accounts
  • Response modified: 200
  • Updated: POST /accounts
  • Response modified: 200
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Updated: GET /accounts/{account_id}/statements/list
  • Response modified: 200
  • Body attribute removed: effective_as_of_date
  • Updated: GET /accounts/{account_id}/statements/{statement_id}
  • Response modified: 200
  • Body attribute added: line_items
  • Body attribute removed: effective_as_of_date
  • Added: GET /organization
  • Added: PUT /organization/subscribe
  • Added: GET /organization/subscribe/test
API structure has changed on
  • Updated: GET /products
  • Response modified: 200
  • Body attribute modified: product_id
  • Updated: POST /products
  • Response modified: 200
  • Body attribute modified: product_id
  • Updated: GET /customers/accounts
  • Response modified: 200
  • Updated: POST /customers
  • Response modified: 200
  • Body attribute modified: customer_id
  • Updated: POST /accounts
  • Body attribute added: cycle_type
  • Body attribute modified: product_id
  • Response modified: 200
  • Body attribute added: cycle_type
  • Body attribute modified: account_id
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Body attribute added: cycle_type
  • Body attribute modified: account_id
  • Added: PUT /accounts/{account_id}/line_items/{line_item_id}
  • Updated: POST /accounts/{account_id}/line_items/charges
  • Body attribute added: line_item_status
  • Response modified: 200
  • Body attributes modified: account_id, line_item_id, product_id
  • Updated: POST /accounts/{account_id}/line_items/payments
  • Response modified: 200
  • Body attributes modified: account_id, line_item_id, product_id
  • Updated: GET /accounts/{account_id}/notes
  • Response modified: 200
  • Body attributes modified: note_id, account_id
  • Updated: POST /accounts/{account_id}/notes
  • Response modified: 200
  • Body attributes modified: note_id, account_id
  • Updated: GET /accounts/{account_id}/statements/list
  • Response modified: 200
  • Body attributes modified: account_id, statement_id
  • Updated: GET /accounts/{account_id}/statements/{statement_id}
  • Response modified: 200
  • Body attributes modified: account_id, statement_id
API structure has changed on
  • Updated: GET /products
  • Response modified: 200
  • Body attribute modified: created_at
  • Updated: POST /products
  • Body attribute added: external_product_id
  • Response modified: 200
  • Body attribute modified: created_at
  • Updated: GET /customers/accounts
  • Response modified: 200
  • Updated: POST /customers
  • Body attribute added: business_details
  • Response modified: 200
  • Body attribute added: business_details
  • Updated: POST /accounts
  • Body attribute added: payment_processor_config
  • Response modified: 200
  • Body attribute added: payment_processor_config
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Body attribute added: payment_processor_config
  • Updated: GET /accounts/{account_id}/line_items
  • Response modified: 200
  • Body attribute added: issuer_processor_metadata
  • Body attributes modified: effective_at, created_at
  • Updated: GET /accounts/{account_id}/line_items/{line_item_id}
  • Response modified: 200
  • Body attribute added: issuer_processor_metadata
  • Body attributes modified: effective_at, created_at
  • Updated: POST /accounts/{account_id}/line_items/charges
  • Body attribute added: issuer_processor_metadata
  • Response modified: 200
  • Body attribute added: issuer_processor_metadata
  • Updated: POST /accounts/{account_id}/line_items/payments
  • Response modified: 200
  • Body attribute added: issuer_processor_metadata
  • Added: PUT /organization/payment_processors
API structure has changed on
  • Added: GET /api_users
  • Added: POST /api_users
  • Added: POST /api_users/login
  • Added: PUT /api_users/password
  • Added: PUT /api_users/register
  • Added: GET /api_users/summary
  • Updated: GET /customers/accounts
  • Response modified: 200
  • Updated: POST /accounts
  • Response modified: 200
  • Body attribute added: additional_statement_min_pay_details
  • Body attribute removed: additional_min_pay_details
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Body attribute added: additional_statement_min_pay_details
  • Body attribute removed: additional_min_pay_details
  • Updated: GET /accounts/{account_id}/line_items
  • Response modified: 200
  • Updated: GET /accounts/{account_id}/line_items/{line_item_id}
  • Response modified: 200
  • Updated: GET /accounts/{account_id}/notes
  • Response modified: 200
  • Updated: POST /accounts/{account_id}/notes
  • Response modified: 200
  • Updated: GET /accounts/{account_id}/statements/{statement_id}
  • Response modified: 200
  • Updated: GET /accounts/{account_id}/amortization_schedule
  • Response modified: 200
  • Body attributes added: am_start_principal_balance_cents, am_end_principal_balance_cents
  • Removed: GET /api_users
  • Removed: POST /api_users
  • Removed: POST /api_users/login
  • Removed: PUT /api_users/password
  • Removed: PUT /api_users/register
  • Removed: GET /api_users/summary
API structure has changed on
  • Updated: GET /products
  • Responses added: 401, 403, 429, default
  • Response modified: 200
  • Updated: POST /products
  • Responses added: 401, 403, 429, default
  • Response modified: 200
  • Updated: GET /customers/accounts
  • Responses added: 401, 403, 429, default
  • Response modified: 200
  • Updated: POST /customers
  • Responses added: 401, 403, 429, default
  • Updated: POST /accounts
  • Responses added: 401, 403, 429, default
  • Response modified: 200
  • Updated: GET /accounts/{account_id}
  • Responses added: 401, 403, 429, default
  • Response modified: 200
  • Updated: GET /accounts/{account_id}/line_items
  • Responses added: 401, 403, 429, default
  • Response modified: 200
  • Updated: GET /accounts/{account_id}/line_items/{line_item_id}
  • Responses added: 401, 403, 429, default
  • Response modified: 200
  • Updated: POST /accounts/{account_id}/line_items/charges
  • Responses added: 401, 403, 429, default
  • Updated: POST /accounts/{account_id}/line_items/payments
  • Responses added: 401, 403, 429, default
  • Updated: GET /accounts/{account_id}/notes
  • Responses added: 401, 403, 429, default
  • Updated: POST /accounts/{account_id}/notes
  • Responses added: 401, 403, 429, default
  • Updated: GET /accounts/{account_id}/statements/list
  • Responses added: 401, 403, 429, default
  • Updated: GET /accounts/{account_id}/statements/{statement_id}
  • Responses added: 401, 403, 429, default
  • Updated: GET /accounts/{account_id}/amortization_schedule
  • Responses added: 401, 403, 429, default
  • Response modified: 200
  • Body attributes added: line_item_id, cycle_exclusive_end, am_cycle_payment_cents, am_interest_cents, am_deferred_cents, am_principal_cents, am_start_total_balance_cents, am_end_total_balance_cents, paid_on_time
  • Body attributes removed: amount_paid_cents, interest_allocation_cents, deferred_interest_allocation_cents, principal_allocation_cents, end_balance_cents
  • Body attribute modified: am_min_pay_cents
  • Updated: GET /api_users
  • Responses added: 401, 403, 429, default
  • Updated: POST /api_users
  • Responses added: 401, 403, 429, default
  • Updated: POST /api_users/login
  • Responses added: 401, 403, 429, default
  • Updated: PUT /api_users/password
  • Responses added: 401, 403, 429, default
  • Updated: PUT /api_users/register
  • Responses added: 401, 403, 429, default
  • Updated: GET /api_users/summary
  • Responses added: 401, 403, 429, default
API structure has changed on
  • Updated: GET /products
  • Response modified: 200
  • Body attributes added: product_id, created_at, effective_at, external_product_id, product_overview, product_lifecycle_policies, promotional_policies, post_promotional_policies, product_summary
  • Updated: POST /products
  • Body attributes added: effective_at, product_overview, product_lifecycle_policies, promotional_policies, post_promotional_policies
  • Response modified: 200
  • Body attributes added: product_id, created_at, effective_at, external_product_id, product_overview, product_lifecycle_policies, promotional_policies, post_promotional_policies, product_summary
  • Updated: GET /customers/accounts
  • Response modified: 200
  • Body attribute added: results
  • Updated: POST /customers
  • Body attributes added: name_prefix, name_first, name_middle, name_last, name_suffix, phone_number, address_line_one, address_line_two, address_city, address_state, address_zip, ssn, email, date_of_birth, assign_to_accounts
  • Response modified: 200
  • Body attributes added: customer_id, name_prefix, name_first, name_middle, name_last, name_suffix, phone_number, address_line_one, address_line_two, address_city, address_state, address_zip, ssn, email, date_of_birth
  • Removed: GET /customers/{customer_id}
  • Removed: PUT /customers/{customer_id}
  • Updated: POST /accounts
  • Body attributes added: effective_at, product_id, external_product_id, external_fields, summary, promo_overview, post_promo_overview, associated_entities, assign_customers
  • Response modified: 200
  • Body attributes added: account_id, created_at, effective_at, account_overview, account_product, external_fields, min_pay_due_cents, additional_min_pay_details, summary, associated_entities, customers
  • Updated: GET /accounts/{account_id}
  • URL parameter modified: account_id
  • Response modified: 200
  • Body attributes added: account_id, created_at, effective_at, account_overview, account_product, external_fields, min_pay_due_cents, additional_min_pay_details, summary, associated_entities, customers
  • Updated: GET /accounts/{account_id}/line_items
  • URL parameter modified: account_id
  • Response modified: 200
  • Body attributes added: account_id, line_item_id, effective_at, created_at, product_id, line_item_overview, line_item_summary, merchant_data, external_fields
  • Updated: GET /accounts/{account_id}/line_items/{line_item_id}
  • URL parameters modified: account_id, line_item_id
  • Response modified: 200
  • Body attributes added: account_id, line_item_id, effective_at, created_at, product_id, line_item_overview, line_item_summary, merchant_data, external_fields
  • Updated: POST /accounts/{account_id}/line_items/charges
  • URL parameter modified: account_id
  • Body attributes added: original_amount_cents, effective_at, merchant_data, external_fields
  • Response modified: 200
  • Body attributes added: account_id, line_item_id, effective_at, created_at, product_id, line_item_overview, line_item_summary, merchant_data, external_fields
  • Updated: POST /accounts/{account_id}/line_items/payments
  • URL parameter modified: account_id
  • Body attributes added: original_amount_cents, effective_at, external_fields
  • Response modified: 200
  • Body attributes added: account_id, line_item_id, effective_at, created_at, product_id, line_item_overview, line_item_summary, merchant_data, external_fields
  • Updated: GET /accounts/{account_id}/notes
  • URL parameter modified: account_id
  • Response modified: 200
  • Body attributes added: note_id, account_id, author, message, created_date
  • Updated: POST /accounts/{account_id}/notes
  • URL parameter modified: account_id
  • Body attribute added: message
  • Response modified: 200
  • Body attributes added: note_id, account_id, author, message, created_date
  • Updated: GET /accounts/{account_id}/statements/list
  • Response modified: 200
  • Body attributes added: account_id, statement_id, effective_as_of_date, cycle_summary, min_pay_due_cents, balance_summary
  • Updated: GET /accounts/{account_id}/statements/{statement_id}
  • URL parameter modified: account_id
  • Response modified: 200
  • Body attributes added: account_id, statement_id, effective_as_of_date, account_overview, open_to_buy, cycle_summary, min_pay_due, additional_min_pay_details, balance_summary, payoff
  • Updated: GET /api_users
  • Response modified: 200
  • Body attributes added: api_user_id, organization_name, name_first, name_last, email, phone, role
  • Updated: POST /api_users
  • Body attributes added: role, email
  • Response modified: 200
  • Body attributes added: email, created_at, expires_at
  • Updated: POST /api_users/login
  • Body attributes added: email, password
  • Response modified: 200
  • Body attributes added: api_user_id, organization_name, first_name, last_name, email, phone, role, token
  • Updated: PUT /api_users/password
  • Body attributes added: current_password, new_password, token
  • Response modified: 200
  • Body attributes added: api_user_id, organization_name, first_name, last_name, email, phone, role, token
  • Updated: PUT /api_users/register
  • Body attributes added: email_confirm, new_password, name_first, name_last, phone, token
  • Response modified: 200
  • Body attributes added: api_user_id, organization_name, name_first, name_last, email, phone, role
  • Updated: GET /api_users/summary
  • Response modified: 200
  • Body attributes added: api_user_id, organization_name, name_first, name_last, email, phone, role
  • Updated: GET /accounts/{account_id}/amortization_schedule
  • URL parameter modified: account_id
  • Response modified: 200
  • Body attributes added: min_pay_due_at, am_min_pay_cents, amount_paid_cents, interest_allocation_cents, deferred_interest_allocation_cents, principal_allocation_cents, end_balance_cents
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