Canopy API changelog

Last update:

Subscribe to the Canopy API changelog to be up to date on recent changes.

• RSS Feed

API structure has changed

Breaking change
  • Updated: GET /customers/accounts
  • Response modified: 200
  • Updated: POST /customers
  • Body attributes added: address_country_code, international_customer_id
  • Body attribute modified: ssn
  • Response modified: 200
  • Body attributes added: address_country_code, international_customer_id
  • Updated: POST /accounts
  • Response modified: 200
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • [Breaking] Removed: POST /accounts/{account_id}/line_items/manual_fee
  • Added: POST /accounts/{account_id}/line_items/manual_fees

API structure has changed

Breaking change
  • Updated: PUT /api_users/password
  • [Breaking] Body attributes removed: current_password, new_password, token
  • Updated: PUT /api_users/register
  • Body attribute added: password
  • [Breaking] Body attribute removed: new_password
  • Updated: GET /products
  • Response modified: 200
  • Updated: POST /products
  • Response modified: 200
  • Added: GET /accounts/{account_id}/temp_promos
  • Added: POST /accounts/{account_id}/temp_promos
  • Added: POST /accounts/{account_id}/line_items/credit_offsets
  • Added: POST /accounts/{account_id}/line_items/manual_fee
  • Added: PUT /organization/plaid_config

API structure has changed

  • Updated: GET /accounts/{account_id}/statements/{statement_id}
  • Response modified: 200
  • Body attribute added: pdf_url
  • Added: PUT /organization/address

API structure has changed

  • Updated: GET /customers/accounts
  • Response modified: 200
  • Updated: POST /accounts
  • Body attribute added: plaid_config
  • Response modified: 200
  • Body attribute added: plaid_config
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Body attribute added: plaid_config
  • Updated: POST /accounts/{account_id}/line_items/payments
  • Body attribute added: line_item_status
  • Updated: PUT /organization/payment_processors
  • Body attributes added: payment_processor_name, merchant_config
  • Body attribute removed: repay_config
  • Response modified: 200
  • Body attributes added: payment_processor_name, merchant_config
  • Body attribute removed: repay_config

API structure has changed

  • Updated: GET /customers/accounts
  • Response modified: 200
  • Updated: POST /accounts
  • Response modified: 200
  • Updated: GET /accounts/{account_id}
  • Response modified: 200
  • Updated: PUT /accounts/{account_id}/payment_processor_config
  • Response modified: 200
  • Updated: PUT /accounts/{account_id}/line_items/{line_item_id}
  • Response modified: 200
  • Body attribute added: Additional properties are allowed
  • Body attributes removed: effective_at, created_at, line_item_overview, line_item_summary, merchant_data, issuer_processor_metadata, external_fields
  • Updated: POST /accounts/{account_id}/line_items/charges
  • Response modified: 200
  • Body attribute added: Additional properties are allowed
  • Body attributes removed: effective_at, created_at, line_item_overview, line_item_summary, merchant_data, issuer_processor_metadata, external_fields
  • Updated: POST /accounts/{account_id}/line_items/payments
  • Response modified: 200
  • Body attribute added: Additional properties are allowed
  • Body attributes removed: effective_at, created_at, line_item_overview, line_item_summary, merchant_data, issuer_processor_metadata, external_fields
  • Added: POST /accounts/{account_id}/line_items/debit_offsets
  • Updated: GET /accounts/{account_id}/credit_reports/{credit_report_id}
  • Response modified: 200
  • Body attributes added: activity_date, date_created, program_date, program_revision_date, reporter_name, reporter_address, reporter_telephone_number, consumer_account_number, portfolio_type, account_type, date_opened, credit_limit, highest_credit, terms_duration, terms_frequency, scheduled_monthly_payment_amount, actual_payment_amount, account_status, payment_rating, payment_history_profile, special_comment_code, compliance_condition_code, current_balance, amount_past_due, original_charge_off_amount, date_of_account_info, first_delinquency_date, date_closed, last_payment_date, consumer_primary
  • Added: GET /accounts/{account_id}/audit_trails/account_status_changes

API structure has changed

  • Updated: POST /accounts

API structure has changed

  • Added: PUT /accounts/{account_id}/payment_processor_config
  • Removed: PUT /accounts/{account_id}/payment_processor_config

API structure has changed

  • 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

  • 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

  • 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

  • Updated: GET /customers/accounts
  • Query parameter added: search_parameters

API structure has changed

  • Added: PUT /organization/issuer_processors

API structure has changed

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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