Canopy API Documentation changelog

11 days ago

Added: POST /api_users/password

18 days ago

Added: PUT /accounts/{account_id}/line_items/{line_item_id}
Added: PUT /accounts/{account_id}/line_items/{line_item_id}/schedule
Modified: GET /finance_requests/{finance_request_id}
- finance_request_id path parameter was added
Modified: POST /accounts/{account_id}/line_items/payment_reversals/{line_item_id}
- 409 response was added
Modified: POST /accounts/{account_id}/temp_promos
- account_id path parameter was added
Modified: PUT /accounts/{account_id}/metro2_config
- account_id path parameter was added
Modified: PUT /accounts/{account_id}/payment_processor_config
- account_id path parameter was added
Modified: PUT /customers/{customer_id}/metro2_config
- customer_id path parameter was added
Modified: PUT /organization/credit_reporting
- body was modified
  - transunion_program_identifier, experian_program_identifier, equifax_program_identifier, program_date, reporter_name, reporter_address_line_one, reporter_address_line_two, reporter_address_city, reporter_address_state, reporter_address_zip, reporter_phone_number attributes were removed
    Breaking
- 200 response was modified
  - transunion_program_identifier, experian_program_identifier, equifax_program_identifier, program_date, reporter_name, reporter_address_line_one, reporter_address_line_two, reporter_address_city, reporter_address_state, reporter_address_zip, reporter_phone_number attributes were removed
    Breaking
Modified: PUT /products/{product_id}/metro2_config
- product_id path parameter was added
Modified: PUT /products/{product_id}/migration_mode
- product_id path parameter was added
Removed: PUT /accounts/{account_id}/line_items/{line_item_id}
Breaking

Apr 25, 2023

Modified: GET /accounts/{account_id}
- 200 response was modified
  - customers, metro2_config attributes were modified
Modified: GET /customers/accounts
- 200 response was modified
  - results attribute was modified
Modified: GET /customers/{customer_id}
- 200 response was modified
  - metro2_config attribute was modified
Modified: GET /customers/{customer_id}/product_offerings
- 200 response was modified
  - results attribute was modified
Modified: GET /finance_requests
- 200 response was modified
  - results attribute was modified
Modified: GET /finance_requests/{finance_request_id}
- 200 response was modified
  - product, customer attributes were modified
Modified: GET /products
- 200 response was modified
  - results attribute was modified
Modified: POST /accounts
- body was modified
  - assign_customers, metro2_config attributes were modified
- 200 response was modified
  - customers, metro2_config attributes were modified
Modified: POST /customers
- body was modified
  - assign_to_accounts, metro2_config attributes were modified
- 200 response was modified
  - metro2_config attribute was modified
Modified: POST /customers/{customer_id}/product_offerings
- 200 response was modified
  - product_lifecycle_policies attribute was modified
Modified: POST /finance_requests
- 200 response was modified
  - product, customer attributes were modified
Modified: POST /finance_requests/{finance_request_id}/convert
- 200 response was modified
  - product, customer attributes were modified
Modified: POST /products
- body was modified
  - product_lifecycle_policies attribute was modified
- 200 response was modified
  - product_lifecycle_policies attribute was modified
Modified: PUT /accounts/{account_id}/metro2_config
- body was modified
  - bloom_metadata attribute was modified
- 200 response was modified
  - bloom_metadata attribute was modified
Modified: PUT /accounts/{account_id}/policy
- 200 response was modified
  - customers, metro2_config attributes were modified
Modified: PUT /accounts/{account_id}/status
- 200 response was modified
  - customers, metro2_config attributes were modified
Modified: PUT /customers/{customer_id}
- 200 response was modified
  - metro2_config attribute was modified
Modified: PUT /customers/{customer_id}/metro2_config
- body was modified
  - bloom_metadata attribute was modified
- 200 response was modified
  - bloom_metadata attribute was modified
Modified: PUT /finance_requests/{finance_request_id}
- 200 response was modified
  - product, customer attributes were modified

Mar 28, 2023

Modified: POST /accounts
- body was modified
  - summary attribute was modified

Feb 28, 2023

Added: POST /accounts/{account_id}/line_items/refinances/{line_item_id}
Modified: GET /accounts/{account_id}
- 200 response was modified
  - summary attribute was modified
Modified: GET /customers/accounts
- 200 response was modified
  - results attribute was modified
Modified: GET /customers/{customer_id}/accounts
- 200 response was modified
  - results attribute was modified
Modified: GET /customers/{customer_id}/product_offerings
- 200 response was modified
  - results attribute was modified
Modified: GET /finance_requests
- 200 response was modified
  - results attribute was modified
Modified: GET /finance_requests/{finance_request_id}
- 200 response was modified
  - product attribute was modified
Modified: GET /products
- 200 response was modified
  - results attribute was modified
Modified: POST /accounts
- 200 response was modified
  - summary attribute was modified
Modified: POST /customers/{customer_id}/product_offerings
- 200 response was modified
  - product_lifecycle_policies attribute was modified
Modified: POST /finance_requests
- 200 response was modified
  - product attribute was modified
Modified: POST /finance_requests/{finance_request_id}/convert
- 200 response was modified
  - product attribute was modified
Modified: POST /products
- body was modified
  - product_lifecycle_policies attribute was modified
- 200 response was modified
  - product_lifecycle_policies attribute was modified
Modified: PUT /accounts/{account_id}/policy
- 200 response was modified
  - summary attribute was modified
Modified: PUT /accounts/{account_id}/status
- 200 response was modified
  - summary attribute was modified
Modified: PUT /finance_requests/{finance_request_id}
- 200 response was modified
  - product attribute was modified

Feb 6, 2023

Added: GET /nacha_files/entry_details

Jan 20, 2023

Added: PUT /accounts/{account_id}/policy
Modified: GET /accounts/{account_id}/line_items
- line_item_status, line_item_type, updated_at_after, updated_at_before query parameters were added
- 200 response was modified
  - results attribute was modified
Modified: GET /accounts/{account_id}/line_items/{line_item_id}
- 200 response was modified
  - results attribute was modified
Modified: GET /accounts/{account_id}/statements/{statement_id}
- 200 response was modified
  - line_items attribute was modified
Modified: PUT /accounts/{account_id}/line_items/{line_item_id}
- 200 response was modified
  - line_item_overview attribute was modified

Dec 12, 2022

Added: DELETE /organization/vanity-domain/{domain_name}
Added: GET /organization/vanity-domain
Added: GET /organization/vanity-domain/{domain_name}
Added: POST /accounts/{account_id}/line_items/loans
Added: POST /accounts/{account_id}/line_items/payments
Added: POST /organization/vanity-domain
Added: PUT /payout_entities/{payout_entity_id}
Modified: GET /accounts/{account_id}
- 200 response was modified
  - account_product, payment_processor_config, issuer_processor_details, payout_entities attributes were modified
Modified: GET /accounts/{account_id}/interest_rates
- 200 response was modified
  - line_item_id attribute was added
Modified: GET /accounts/{account_id}/line_items
- 200 response was modified
  - results attribute was modified
Modified: GET /accounts/{account_id}/line_items/{line_item_id}
- 200 response was modified
  - results attribute was modified
Modified: GET /accounts/{account_id}/statements/{statement_id}
- 200 response was modified
  - account_overview, line_items attributes were modified
Modified: GET /customers/accounts
- 200 response was modified
  - results attribute was modified
Modified: GET /customers/{customer_id}/accounts
- 200 response was modified
  - results attribute was modified
Modified: GET /customers/{customer_id}/product_offerings
- 200 response was modified
  - results attribute was modified
Modified: GET /finance_requests
- 200 response was modified
  - results attribute was modified
Modified: GET /finance_requests/{finance_request_id}
- 200 response was modified
  - create_account_details, product attributes were modified
Modified: GET /payout_entities
- 200 response was modified
  - results attribute was modified
Modified: GET /products
- 200 response was modified
  - results attribute was modified
Modified: POST /accounts
- body was modified
  - payment_processor_config, summary attributes were modified
- 200 response was modified
  - account_product, payment_processor_config, issuer_processor_details, payout_entities attributes were modified
Modified: POST /accounts/{account_id}/interest_rates
- 200 response was modified
  - line_item_id attribute was added
Modified: POST /accounts/{account_id}/line_items/payments/payment_transfer
Breaking
Modified: POST /accounts/{account_id}/temp_promos
- 200 response was modified
  - ach attribute was modified
Modified: POST /amortization_schedule
- body was modified
  - installment_interest_applicable_balance attribute was added
Modified: POST /customers/{customer_id}/product_offerings
- 200 response was modified
  - product_lifecycle_policies attribute was modified
Modified: POST /finance_requests
- body was modified
  - create_account_details attribute was modified
- 200 response was modified
  - create_account_details, product attributes were modified
Modified: POST /finance_requests/{finance_request_id}/convert
- 200 response was modified
  - create_account_details, product attributes were modified
Modified: POST /payout_entities
- 200 response was modified
  - company_identification, irs_tin attributes were added
Modified: POST /products
- body was modified
  - product_lifecycle_policies attribute was modified
- 200 response was modified
  - product_lifecycle_policies attribute was modified
Modified: PUT /accounts/{account_id}/interest_rates
- 200 response was modified
  - line_item_id attribute was added
Modified: PUT /accounts/{account_id}/line_items/{line_item_id}
- 200 response was modified
  - valid_at attribute was added
  - line_item_summary attribute was modified
Modified: PUT /accounts/{account_id}/payment_processor_config
- body was modified
  - ach attribute was modified
- 200 response was modified
  - ach attribute was modified
Modified: PUT /accounts/{account_id}/status
- 200 response was modified
  - account_product, payment_processor_config, issuer_processor_details, payout_entities attributes were modified
Modified: PUT /finance_requests/{finance_request_id}
- body was modified
  - create_account_details attribute was modified
- 200 response was modified
  - create_account_details, product attributes were modified

Aug 22, 2022

Added: PUT /accounts/{account_id}/metro2_config
Added: PUT /customers/{customer_id}/metro2_config
Added: PUT /products/{product_id}/metro2_config
Modified: GET /accounts/{account_id}
- 200 response was modified
  - payment_processor_config, issuer_processor_details attributes were modified
Modified: GET /customers/accounts
- 200 response was modified
  - results attribute was modified
Modified: GET /customers/{customer_id}/accounts
- 200 response was modified
  - results attribute was modified
Modified: GET /organization
- 200 response was modified
  - issuer_processors, payment_processors attributes were modified
Modified: POST /accounts
- body was modified
  - payment_processor_config, metro2_config attributes were modified
- 200 response was modified
  - payment_processor_config, issuer_processor_details attributes were modified
Modified: POST /accounts/{account_id}/line_items/payments/payment_transfer
Breaking
Modified: POST /accounts/{account_id}/temp_promos
- 200 response was modified
  - autopay_configs attribute was added
  - ach attribute was modified
Modified: PUT /accounts/{account_id}/payment_processor_config
- body was modified
  - autopay_configs attribute was added
  - ach attribute was modified
- 200 response was modified
  - autopay_configs attribute was added
  - ach attribute was modified
Modified: PUT /accounts/{account_id}/status
- 200 response was modified
  - payment_processor_config, issuer_processor_details attributes were modified
Modified: PUT /organization/issuer_processors
- body was modified
  - galileo_config attribute was added
  - lithic_config attribute was modified
- 200 response was modified
  - galileo_config attribute was added
  - lithic_config attribute was modified
Modified: PUT /organization/payment_processors
- 200 response was modified
  - stripe_config attribute was modified

Aug 8, 2022

Added: DELETE /customers/{customer_id}/product_offerings/{product_id}
Added: GET /accounts/{account_id}/notes
Added: GET /customers
Added: GET /customers/{customer_id}/accounts
Added: GET /customers/{customer_id}/product_offerings
Added: GET /filters
Added: GET /finance_requests
Added: GET /finance_requests/{finance_request_id}
Added: POST /accounts/{account_id}/interest_rates
Added: POST /customers/{customer_id}/product_offerings
Added: POST /finance_requests
Added: POST /finance_requests/{finance_request_id}/convert
Added: POST /notes
Added: PUT /finance_requests/{finance_request_id}
Modified: GET /accounts/{account_id}
- 200 response was modified
  - updated_at, partner_entity, metro2_config attributes were added
  - payment_processor_config, summary, customers attributes were modified
Modified: GET /accounts/{account_id}/amortization_schedule
- 200 response was modified
  - line_item_id attribute was modified
    Breaking
Modified: GET /accounts/{account_id}/line_items
- 200 response was modified
  - results attribute was modified
Modified: GET /accounts/{account_id}/line_items/{line_item_id}
- 200 response was modified
  - results attribute was modified
Modified: GET /accounts/{account_id}/statements/{statement_id}
- 200 response was modified
  - line_items attribute was modified
Modified: GET /customers/accounts
- account_status, account_substatus, product_type, effective_after query parameters were added
- 200 response was modified
  - results attribute was modified
Modified: GET /customers/{customer_id}
- 200 response was modified
  - created_at, updated_at, is_borrower_portal_user, is_active, customer_balances, metro2_config attributes were added
Modified: GET /notes
Breaking
- account_id, product_id, finance_request_id, line_item_id query parameters were added
  Breaking
- account_id path parameter was removed
  Breaking
- 200 response was modified
  Breaking
  - product_id, finance_request_id, line_item_id attributes were added
  - account_id attribute was modified
Modified: GET /products
- is_template, product_status, product_type, search_parameters query parameters were added
- 200 response was modified
  - results attribute was modified
Modified: POST /accounts
- body was modified
  - partner_entity_id, metro2_config attributes were added
  - account_id, payment_processor_config, summary attributes were modified
- 200 response was modified
  - updated_at, partner_entity, metro2_config attributes were added
  - payment_processor_config, summary, customers attributes were modified
Modified: POST /accounts/{account_id}/line_items/payments/payment_transfer
Breaking
Modified: POST /accounts/{account_id}/notes
- 200 response was modified
  - product_id, finance_request_id, line_item_id attributes were added
  - account_id attribute was modified
Modified: POST /accounts/{account_id}/temp_promos
- 200 response was modified
  - ach attribute was modified
Modified: POST /amortization_schedule
- body was modified
  - is_ordinary_annuity attribute was added
  - principal_balance_cents, am_len, cycle_interval, cycle_due_interval attributes were modified
    Breaking
- 200 response was modified
  - line_item_id attribute was modified
    Breaking
Modified: POST /customers
- body was modified
  - customer_parent_id, metro2_config attributes were added
- 200 response was modified
  - created_at, updated_at, is_borrower_portal_user, is_active, customer_balances, metro2_config attributes were added
Modified: POST /products
- body was modified
  - metro2_config attribute was added
  - product_lifecycle_policies attribute was modified
- 200 response was modified
  - updated_at, metro2_config attributes were added
  - product_lifecycle_policies, product_summary attributes were modified
Modified: PUT /accounts/{account_id}/line_items/{line_item_id}
- 200 response was modified
  - updated_at attribute was added
Modified: PUT /accounts/{account_id}/payment_processor_config
- body was modified
  - ach attribute was modified
- 200 response was modified
  - ach attribute was modified
Modified: PUT /accounts/{account_id}/status
- 200 response was modified
  - updated_at, partner_entity, metro2_config attributes were added
  - payment_processor_config, summary, customers attributes were modified
Modified: PUT /customers/{customer_id}
- 200 response was modified
  - created_at, updated_at, is_borrower_portal_user, is_active, customer_balances, metro2_config attributes were added
Modified: PUT /organization/credit_reporting
- body was modified
  - metro2_config attribute was added
- 200 response was modified
  - metro2_config attribute was added
Modified: PUT /organization/payment_processors
- body was modified
  - stripe_config attribute was added
- 200 response was modified
  - stripe_config attribute was added

Apr 26, 2022

Added: DELETE /customers/{customer_id}/beneficial_owners/{beneficial_owner_id}
Added: GET /customers/{customer_id}
Added: GET /customers/{customer_id}/beneficial_owners/{beneficial_owner_id}
Added: POST /accounts/{account_id}/line_items/payments/guest_payment
Added: POST /amortization_schedule
Added: PUT /customers/{customer_id}/beneficial_owners/{beneficial_owner_id}
Modified: GET /accounts/{account_id}
- 200 response was modified
  - account_product attribute was modified
Modified: GET /accounts/{account_id}/amortization_schedule
- 200 response was modified
  - am_fees_cents attribute was added
Modified: GET /accounts/{account_id}/statements/{statement_id}
- 200 response was modified
  - account_overview, additional_min_pay_details attributes were modified
Modified: GET /customers/accounts
- 200 response was modified
  - results attribute was modified
Modified: GET /products
- 200 response was modified
  - results attribute was modified
Modified: POST /accounts
- body was modified
  - summary, promo_overview attributes were modified
- 200 response was modified
  - account_product attribute was modified
Modified: POST /accounts/{account_id}/interest_rates
Breaking
- body was modified
  Breaking
  - interest_rate attribute was added
  - interest_rate_id, Additional properties are NOT allowed attributes were removed
    Breaking
Modified: POST /accounts/{account_id}/line_items/payments/payment_transfer
Breaking
Modified: POST /products
- body was modified
  - promotional_policies attribute was modified
- 200 response was modified
  - is_active attribute was added
  - promotional_policies attribute was modified
Modified: PUT /accounts/{account_id}/status
- 200 response was modified
  - account_product attribute was modified
Removed: DELETE /customers/{customer_id}/beneficial_owners/{beneficial_owner_id}
Breaking
Removed: GET /customers/{customer_id}
Breaking
Removed: GET /customers/{customer_id}/beneficial_owners/{beneficial_owner_id}
Breaking
Removed: PUT /customers/{customer_id}/beneficial_owners/{beneficial_owner_id}
Breaking

Mar 17, 2022

Added: DELETE /customers/{customer_id}/beneficial_owners/{beneficial_owner_id}
Added: GET /accounts/{account_id}/amortization_schedule
Added: GET /accounts/{account_id}/audit_trails/account_status_changes
Added: GET /accounts/{account_id}/cards
Added: GET /accounts/{account_id}/credit_reports/list
Added: GET /accounts/{account_id}/credit_reports/{credit_report_id}
Added: GET /accounts/{account_id}/interest_rates
Added: GET /accounts/{account_id}/line_items
Added: GET /accounts/{account_id}/line_items/{line_item_id}
Added: GET /api_users
Added: GET /api_users/summary
Added: GET /customers/{customer_id}
Added: GET /customers/{customer_id}/beneficial_owners
Added: GET /customers/{customer_id}/beneficial_owners/{beneficial_owner_id}
Added: GET /payout_entities
Added: POST /accounts/{account_id}/cards
Added: POST /accounts/{account_id}/interest_rates
Added: POST /accounts/{account_id}/line_items/charge_reversals/{line_item_id}
Added: POST /accounts/{account_id}/line_items/charges
Added: POST /accounts/{account_id}/line_items/credit_offsets
Added: POST /accounts/{account_id}/line_items/debit_offsets
Added: POST /accounts/{account_id}/line_items/fee_waiver/{line_item_id}
Added: POST /accounts/{account_id}/line_items/manual_fees
Added: POST /accounts/{account_id}/line_items/payment_reversals/{line_item_id}
Added: POST /accounts/{account_id}/line_items/payments
Added: POST /accounts/{account_id}/line_items/payments/payment_record
Added: POST /accounts/{account_id}/line_items/payments/payment_transfer
Added: POST /accounts/{account_id}/line_items/refunds
Added: POST /api_users
Added: POST /customers/{customer_id}/beneficial_owners
Added: POST /payout_entities
Added: POST /register
Added: PUT /accounts/{account_id}/cards
Added: PUT /accounts/{account_id}/interest_rates
Added: PUT /accounts/{account_id}/line_items/{line_item_id}
Added: PUT /accounts/{account_id}/status
Added: PUT /customers/{customer_id}/beneficial_owners/{beneficial_owner_id}
Added: PUT /organization/nacha_config
Added: PUT /organization/subscribe
Added: PUT /products/{product_id}/migration_mode
Modified: GET /accounts/{account_id}
- 200 response was modified
  - additional_min_pay_details, cards attributes were added
  - account_product, min_pay_due_cents, additional_statement_min_pay_details, payment_processor_config, payout_entities, customers attributes were modified
Modified: GET /accounts/{account_id}/statements/{statement_id}
- 200 response was modified
  - inception_to_date_summary, year_to_date_summary attributes were added
  - cycle_summary, additional_min_pay_details, balance_summary attributes were modified
Modified: GET /customers/accounts
- 200 response was modified
  - results attribute was modified
Modified: GET /organization
- 200 response was modified
  - payment_processors attribute was modified
Modified: GET /products
- 200 response was modified
  - results attribute was modified
Modified: POST /accounts
- body was modified
  - account_id attribute was modified
    Breaking
  - payment_processor_config, assign_customers attributes were modified
- 200 response was modified
  - additional_min_pay_details, cards attributes were added
  - account_product, min_pay_due_cents, additional_statement_min_pay_details, payment_processor_config, payout_entities, customers attributes were modified
Modified: POST /accounts/{account_id}/temp_promos
- 200 response was modified
  - ach attribute was modified
Modified: POST /customers
- body was modified
  - passport, customer_type, verification_status, title attributes were added
  - name_first, name_last, business_details, assign_to_accounts attributes were modified
- 200 response was modified
  - passport, customer_type, verification_status, title attributes were added
  - address_line_one, address_city, address_state, address_zip attributes were modified
    Breaking
  - business_details attribute was modified
Modified: POST /products
- body was modified
  - product_lifecycle_policies attribute was modified
- 200 response was modified
  - product_lifecycle_policies attribute was modified
Modified: PUT /accounts/{account_id}/payment_processor_config
- body was modified
  - ach attribute was modified
- 200 response was modified
  - ach attribute was modified
Modified: PUT /customers/{customer_id}
- body was modified
  - address_country_code, customer_type, verification_status, title, international_customer_id, business_details attributes were added
  - address_line_one, address_city, address_state, address_zip attributes were modified
    Breaking
- 200 response was modified
  - passport, customer_type, verification_status, title attributes were added
  - address_line_one, address_city, address_state, address_zip attributes were modified
    Breaking
  - business_details attribute was modified
Modified: PUT /organization/issuer_processors
- body was modified
  - lithic_config attribute was modified
- 200 response was modified
  - lithic_config attribute was modified
Modified: PUT /organization/payment_processors
- body was modified
  - authorize_net_config attribute was modified
- 200 response was modified
  - authorize_net_config attribute was modified
Removed: GET /accounts/{account_id}/amortization_schedule
Breaking
Removed: GET /accounts/{account_id}/audit_trails/account_status_changes
Breaking
Removed: GET /accounts/{account_id}/credit_reports/list
Breaking
Removed: GET /accounts/{account_id}/credit_reports/{credit_report_id}
Breaking
Removed: GET /accounts/{account_id}/line_items
Breaking
Removed: GET /accounts/{account_id}/line_items/{line_item_id}
Breaking
Removed: GET /api_users
Breaking
Removed: GET /api_users/summary
Breaking
Removed: GET /payout_entities
Breaking
Removed: POST /accounts/{account_id}/customers/{customer_id}/cards
Breaking
Removed: POST /accounts/{account_id}/line_items/charge_reversals/{line_item_id}
Breaking
Removed: POST /accounts/{account_id}/line_items/charges
Breaking
Removed: POST /accounts/{account_id}/line_items/credit_offsets
Breaking
Removed: POST /accounts/{account_id}/line_items/debit_offsets
Breaking
Removed: POST /accounts/{account_id}/line_items/fee_waiver/{line_item_id}
Breaking
Removed: POST /accounts/{account_id}/line_items/manual_fees
Breaking
Removed: POST /accounts/{account_id}/line_items/payment_reversals/{line_item_id}
Breaking
Removed: POST /accounts/{account_id}/line_items/payments
Breaking
Removed: POST /accounts/{account_id}/line_items/payments/payment_record
Breaking
Removed: POST /accounts/{account_id}/line_items/payments/payment_transfer
Breaking
Removed: POST /accounts/{account_id}/line_items/refunds
Breaking
Removed: POST /api_users
Breaking
Removed: POST /payout_entities
Breaking
Removed: POST /register
Breaking
Removed: PUT /accounts/{account_id}/customers/{customer_id}/cards
Breaking
Removed: PUT /accounts/{account_id}/line_items/{line_item_id}
Breaking
Removed: PUT /organization/subscribe
Breaking
Removed: PUT /products/{product_id}/migration_mode
Breaking

Mar 11, 2022

Added: DELETE /customers/{customer_id}/beneficial_owners/{beneficial_owner_id}
Added: GET /accounts/{account_id}/amortization_schedule
Added: GET /accounts/{account_id}/audit_trails/account_status_changes
Added: GET /accounts/{account_id}/cards
Added: GET /accounts/{account_id}/credit_reports/list
Added: GET /accounts/{account_id}/credit_reports/{credit_report_id}
Added: GET /accounts/{account_id}/interest_rates
Added: GET /accounts/{account_id}/line_items
Added: GET /accounts/{account_id}/line_items/{line_item_id}
Added: GET /api_users
Added: GET /api_users/summary
Added: GET /customers/{customer_id}
Added: GET /customers/{customer_id}/beneficial_owners
Added: GET /customers/{customer_id}/beneficial_owners/{beneficial_owner_id}
Added: GET /payout_entities
Added: POST /accounts/{account_id}/cards
Added: POST /accounts/{account_id}/interest_rates
Added: POST /accounts/{account_id}/line_items/charge_reversals/{line_item_id}
Added: POST /accounts/{account_id}/line_items/charges
Added: POST /accounts/{account_id}/line_items/credit_offsets
Added: POST /accounts/{account_id}/line_items/debit_offsets
Added: POST /accounts/{account_id}/line_items/fee_waiver/{line_item_id}
Added: POST /accounts/{account_id}/line_items/manual_fees
Added: POST /accounts/{account_id}/line_items/payment_reversals/{line_item_id}
Added: POST /accounts/{account_id}/line_items/payments
Added: POST /accounts/{account_id}/line_items/payments/payment_record
Added: POST /accounts/{account_id}/line_items/payments/payment_transfer
Added: POST /accounts/{account_id}/line_items/refunds
Added: POST /api_users
Added: POST /customers/{customer_id}/beneficial_owners
Added: POST /payout_entities
Added: POST /register
Added: PUT /accounts/{account_id}/cards
Added: PUT /accounts/{account_id}/interest_rates
Added: PUT /accounts/{account_id}/line_items/{line_item_id}
Added: PUT /accounts/{account_id}/status
Added: PUT /customers/{customer_id}/beneficial_owners/{beneficial_owner_id}
Added: PUT /organization/nacha_config
Added: PUT /organization/subscribe
Added: PUT /products/{product_id}/migration_mode
Modified: GET /accounts/{account_id}
- 200 response was modified
  - additional_min_pay_details, cards attributes were added
  - account_product, min_pay_due_cents, additional_statement_min_pay_details, payment_processor_config, payout_entities, customers attributes were modified
Modified: GET /accounts/{account_id}/statements/{statement_id}
- 200 response was modified
  - inception_to_date_summary, year_to_date_summary attributes were added
  - cycle_summary, additional_min_pay_details, balance_summary attributes were modified
Modified: GET /customers/accounts
- 200 response was modified
  - results attribute was modified
Modified: GET /organization
- 200 response was modified
  - payment_processors attribute was modified
Modified: GET /products
- 200 response was modified
  - results attribute was modified
Modified: POST /accounts
- body was modified
  - account_id attribute was modified
    Breaking
  - payment_processor_config, assign_customers attributes were modified
- 200 response was modified
  - additional_min_pay_details, cards attributes were added
  - account_product, min_pay_due_cents, additional_statement_min_pay_details, payment_processor_config, payout_entities, customers attributes were modified
Modified: POST /accounts/{account_id}/temp_promos
- 200 response was modified
  - ach attribute was modified
Modified: POST /customers
- body was modified
  - passport, customer_type, verification_status, title attributes were added
  - name_first, name_last, business_details, assign_to_accounts attributes were modified
- 200 response was modified
  - passport, customer_type, verification_status, title attributes were added
  - address_line_one, address_city, address_state, address_zip attributes were modified
    Breaking
  - business_details attribute was modified
Modified: POST /products
- body was modified
  - product_lifecycle_policies attribute was modified
- 200 response was modified
  - product_lifecycle_policies attribute was modified
Modified: PUT /accounts/{account_id}/payment_processor_config
- body was modified
  - ach attribute was modified
- 200 response was modified
  - ach attribute was modified
Modified: PUT /customers/{customer_id}
- body was modified
  - address_country_code, customer_type, verification_status, title, international_customer_id, business_details attributes were added
  - address_line_one, address_city, address_state, address_zip attributes were modified
    Breaking
- 200 response was modified
  - passport, customer_type, verification_status, title attributes were added
  - address_line_one, address_city, address_state, address_zip attributes were modified
    Breaking
  - business_details attribute was modified
Modified: PUT /organization/issuer_processors
- body was modified
  - lithic_config attribute was modified
- 200 response was modified
  - lithic_config attribute was modified
Modified: PUT /organization/payment_processors
- body was modified
  - authorize_net_config attribute was modified
- 200 response was modified
  - authorize_net_config attribute was modified
Removed: GET /accounts/{account_id}/amortization_schedule
Breaking
Removed: GET /accounts/{account_id}/audit_trails/account_status_changes
Breaking
Removed: GET /accounts/{account_id}/credit_reports/list
Breaking
Removed: GET /accounts/{account_id}/credit_reports/{credit_report_id}
Breaking
Removed: GET /accounts/{account_id}/line_items
Breaking
Removed: GET /accounts/{account_id}/line_items/{line_item_id}
Breaking
Removed: GET /api_users
Breaking
Removed: GET /api_users/summary
Breaking
Removed: GET /payout_entities
Breaking
Removed: POST /accounts/{account_id}/customers/{customer_id}/cards
Breaking
Removed: POST /accounts/{account_id}/line_items/charge_reversals/{line_item_id}
Breaking
Removed: POST /accounts/{account_id}/line_items/charges
Breaking
Removed: POST /accounts/{account_id}/line_items/credit_offsets
Breaking
Removed: POST /accounts/{account_id}/line_items/debit_offsets
Breaking
Removed: POST /accounts/{account_id}/line_items/fee_waiver/{line_item_id}
Breaking
Removed: POST /accounts/{account_id}/line_items/manual_fees
Breaking
Removed: POST /accounts/{account_id}/line_items/payment_reversals/{line_item_id}
Breaking
Removed: POST /accounts/{account_id}/line_items/payments
Breaking
Removed: POST /accounts/{account_id}/line_items/payments/payment_record
Breaking
Removed: POST /accounts/{account_id}/line_items/payments/payment_transfer
Breaking
Removed: POST /accounts/{account_id}/line_items/refunds
Breaking
Removed: POST /api_users
Breaking
Removed: POST /payout_entities
Breaking
Removed: POST /register
Breaking
Removed: PUT /accounts/{account_id}/customers/{customer_id}/cards
Breaking
Removed: PUT /accounts/{account_id}/line_items/{line_item_id}
Breaking
Removed: PUT /organization/subscribe
Breaking
Removed: PUT /products/{product_id}/migration_mode
Breaking

Feb 7, 2022

Added: GET /payout_entities
Added: POST /accounts/{account_id}/line_items/charge_reversals/{line_item_id}
Added: POST /accounts/{account_id}/line_items/payments
Added: POST /accounts/{account_id}/line_items/payments/payment_record
Added: POST /accounts/{account_id}/line_items/payments/payment_transfer
Added: POST /accounts/{account_id}/line_items/refunds
Added: POST /payout_entities
Added: PUT /customers/{customer_id}
Added: PUT /organization/payment_processors
Modified: GET /accounts/{account_id}
- 200 response was modified
  - disbursements_config, payouts_config, payout_entities attributes were added
  - external_account_id attribute was removed
    Breaking
  - account_overview, account_product, payment_processor_config, summary attributes were modified
Modified: GET /accounts/{account_id}/line_items
- 200 response was modified
  - results attribute was modified
Modified: GET /accounts/{account_id}/line_items/{line_item_id}
- 200 response was modified
  - results attribute was modified
Modified: GET /accounts/{account_id}/statements/{statement_id}
- 200 response was modified
  - line_items attribute was modified
Modified: GET /customers/accounts
- 200 response was modified
  - results attribute was modified
Modified: GET /organization
- 200 response was modified
  - features attribute was added
  - payment_processors attribute was modified
Modified: GET /products
- 200 response was modified
  - results attribute was modified
Modified: POST /accounts
- body was modified
  - account_id, disbursements_config, payouts_config attributes were added
  - external_product_id, external_account_id attributes were removed
    Breaking
  - product_id attribute was modified
    Breaking
  - payment_processor_config, summary, promo_overview attributes were modified
- 200 response was modified
  - disbursements_config, payouts_config, payout_entities attributes were added
  - external_account_id attribute was removed
    Breaking
  - account_overview, account_product, payment_processor_config, summary attributes were modified
Modified: POST /accounts/{account_id}/line_items/charges
- body was modified
  - line_item_id attribute was added
  - merchant_data attribute was modified
- 200 response was modified
  - product_id attribute was modified
    Breaking
Modified: POST /accounts/{account_id}/line_items/credit_offsets
- body was modified
  - line_item_id, allocation, Additional properties are allowed attributes were added
  - Additional properties are NOT allowed attribute was removed
    Breaking
- 200 response was modified
  - product_id attribute was modified
    Breaking
Modified: POST /accounts/{account_id}/line_items/debit_offsets
- body was modified
  - line_item_id, allocation, Additional properties are allowed attributes were added
  - Additional properties are NOT allowed attribute was removed
    Breaking
- 200 response was modified
  - product_id attribute was modified
    Breaking
Modified: POST /accounts/{account_id}/line_items/manual_fees
- body was modified
  - line_item_id, Additional properties are allowed attributes were added
  - Additional properties are NOT allowed attribute was removed
    Breaking
- 200 response was modified
  - effective_at, created_at, line_item_summary, merchant_data, issuer_processor_details, external_fields, line_item_overview attributes were added
Modified: POST /accounts/{account_id}/temp_promos
- 200 response was modified
  - ach, debit_card attributes were modified
Modified: POST /customers
- body was modified
  - customer_id attribute was added
  - assign_to_accounts attribute was modified
Modified: POST /products
- body was modified
  - product_id attribute was added
  - external_product_id attribute was removed
    Breaking
  - product_overview, product_lifecycle_policies, promotional_policies attributes were modified
- 200 response was modified
  - external_product_id attribute was removed
    Breaking
  - product_lifecycle_policies, promotional_policies attributes were modified
Modified: PUT /accounts/{account_id}/line_items/{line_item_id}
- 200 response was modified
  - product_id attribute was modified
    Breaking
  - merchant_data attribute was modified
Modified: PUT /accounts/{account_id}/payment_processor_config
- body was modified
  - ach, debit_card attributes were modified
- 200 response was modified
  - ach, debit_card attributes were modified
Removed: POST /accounts/{account_id}/line_items/payments
Breaking
Removed: PUT /organization/payment_processors
Breaking

Feb 7, 2022

Jan 20, 2022

Added: GET /payout_entities
Added: POST /accounts/{account_id}/line_items/charge_reversals/{line_item_id}
Added: POST /accounts/{account_id}/line_items/payments
Added: POST /accounts/{account_id}/line_items/payments/payment_record
Added: POST /accounts/{account_id}/line_items/payments/payment_transfer
Added: POST /accounts/{account_id}/line_items/refunds
Added: POST /payout_entities
Added: PUT /customers/{customer_id}
Added: PUT /organization/payment_processors
Modified: GET /accounts/{account_id}
- 200 response was modified
  - disbursements_config, payouts_config, payout_entities attributes were added
  - external_account_id attribute was removed
    Breaking
  - account_overview, account_product, payment_processor_config, cycle_type, summary attributes were modified
Modified: GET /accounts/{account_id}/line_items
- 200 response was modified
  - results attribute was modified
Modified: GET /accounts/{account_id}/line_items/{line_item_id}
- 200 response was modified
  - results attribute was modified
Modified: GET /accounts/{account_id}/notes
- 200 response was modified
  - author attribute was modified
Modified: GET /accounts/{account_id}/statements/{statement_id}
- 200 response was modified
  - line_items attribute was modified
Modified: GET /api_users
- 200 response was modified
  - name_first, name_last attributes were modified
    Breaking
Modified: GET /api_users/summary
- 200 response was modified
  - name_first, name_last attributes were modified
    Breaking
Modified: GET /customers/accounts
- 200 response was modified
  - results attribute was modified
Modified: GET /organization
- 200 response was modified
  - features attribute was added
  - payment_processors attribute was modified
Modified: GET /products
- 200 response was modified
  - results attribute was modified
Modified: POST /accounts
- body was modified
  - account_id, disbursements_config, payouts_config attributes were added
  - external_product_id, external_account_id attributes were removed
    Breaking
  - product_id attribute was modified
    Breaking
  - payment_processor_config, cycle_type, summary, promo_overview attributes were modified
- 200 response was modified
  - disbursements_config, payouts_config, payout_entities attributes were added
  - external_account_id attribute was removed
    Breaking
  - account_overview, account_product, payment_processor_config, cycle_type, summary attributes were modified
Modified: POST /accounts/{account_id}/line_items/charges
- body was modified
  - line_item_id attribute was added
  - merchant_data attribute was modified
- 200 response was modified
  - product_id attribute was modified
    Breaking
Modified: POST /accounts/{account_id}/line_items/credit_offsets
- body was modified
  - line_item_id, allocation, Additional properties are allowed attributes were added
  - Additional properties are NOT allowed attribute was removed
    Breaking
- 200 response was modified
  - product_id attribute was modified
    Breaking
Modified: POST /accounts/{account_id}/line_items/debit_offsets
- body was modified
  - line_item_id, allocation, Additional properties are allowed attributes were added
  - Additional properties are NOT allowed attribute was removed
    Breaking
- 200 response was modified
  - product_id attribute was modified
    Breaking
Modified: POST /accounts/{account_id}/line_items/manual_fees
- body was modified
  - line_item_id, Additional properties are allowed attributes were added
  - Additional properties are NOT allowed attribute was removed
    Breaking
- 200 response was modified
  - effective_at, created_at, line_item_summary, merchant_data, issuer_processor_details, external_fields, line_item_overview attributes were added
Modified: POST /accounts/{account_id}/notes
- 200 response was modified
  - author attribute was modified
Modified: POST /accounts/{account_id}/temp_promos
- 200 response was modified
  - ach, debit_card attributes were modified
Modified: POST /api_users
- body was modified
  - name_first, name_last, phone attributes were added
- 200 response was modified
  - status attribute was added
  - email, created_at, expires_at attributes were removed
    Breaking
Modified: POST /customers
- body was modified
  - customer_id attribute was added
  - assign_to_accounts attribute was modified
Modified: POST /products
- body was modified
  - product_id attribute was added
  - external_product_id attribute was removed
    Breaking
  - product_overview, product_lifecycle_policies, promotional_policies, post_promotional_policies attributes were modified
- 200 response was modified
  - external_product_id attribute was removed
    Breaking
  - product_lifecycle_policies, promotional_policies, post_promotional_policies attributes were modified
Modified: POST /register
- 200 response was modified
  - name_first, name_last attributes were modified
    Breaking
Modified: PUT /accounts/{account_id}/line_items/{line_item_id}
- 200 response was modified
  - product_id attribute was modified
    Breaking
  - merchant_data attribute was modified
Modified: PUT /accounts/{account_id}/payment_processor_config
- body was modified
  - ach, debit_card attributes were modified
- 200 response was modified
  - ach, debit_card attributes were modified
Removed: POST /accounts/{account_id}/line_items/payments
Breaking
Removed: PUT /organization/payment_processors
Breaking

Dec 7, 2021

Modified: GET /accounts/{account_id}/notes
- 200 response was modified
  - author attribute was modified
Modified: GET /api_users
- 200 response was modified
  - name_first, name_last attributes were modified
    Breaking
Modified: GET /api_users/summary
- 200 response was modified
  - name_first, name_last attributes were modified
    Breaking
Modified: GET /products
- 200 response was modified
  - results attribute was modified
Modified: POST /accounts/{account_id}/notes
- 200 response was modified
  - author attribute was modified
Modified: POST /api_users
- body was modified
  - name_first, name_last, phone attributes were added
- 200 response was modified
  - status attribute was added
  - email, created_at, expires_at attributes were removed
    Breaking
Modified: POST /products
- body was modified
  - post_promotional_policies attribute was modified
- 200 response was modified
  - post_promotional_policies attribute was modified
Modified: POST /register
- 200 response was modified
  - name_first, name_last attributes were modified
    Breaking

Dec 7, 2021

Added: PUT /organization/payment_processors
Modified: GET /accounts/{account_id}
- 200 response was modified
  - summary attribute was modified
Modified: GET /accounts/{account_id}/notes
- 200 response was modified
  - author attribute was modified
Modified: GET /api_users
- 200 response was modified
  - name_first, name_last attributes were modified
Modified: GET /api_users/summary
- 200 response was modified
  - name_first, name_last attributes were modified
Modified: GET /customers/accounts
- 200 response was modified
  - results attribute was modified
Modified: GET /organization
- 200 response was modified
  - payment_processors attribute was modified
Modified: GET /products
- 200 response was modified
  - results attribute was modified
Modified: POST /accounts
- body was modified
  - promo_overview attribute was modified
- 200 response was modified
  - summary attribute was modified
Modified: POST /accounts/{account_id}/line_items/credit_offsets
- body was modified
  - allocation attribute was removed
    Breaking
Modified: POST /accounts/{account_id}/line_items/debit_offsets
- body was modified
  - allocation attribute was removed
    Breaking
Modified: POST /accounts/{account_id}/notes
- 200 response was modified
  - author attribute was modified
Modified: POST /api_users
- body was modified
  - name_first, name_last, phone attributes were removed
    Breaking
- 200 response was modified
  - email, created_at, expires_at attributes were added
  - status attribute was removed
    Breaking
Modified: POST /products
- body was modified
  - product_overview attribute was modified
  - post_promotional_policies attribute was modified
    Breaking
- 200 response was modified
  - post_promotional_policies attribute was modified
    Breaking
Modified: POST /register
- 200 response was modified
  - name_first, name_last attributes were modified
Removed: POST /accounts/{account_id}/line_items/refunds
Breaking
Removed: POST /customers/{customer_id}
Breaking
Removed: PUT /organization/payment_processors
Breaking

Dec 7, 2021

Added: POST /accounts/{account_id}/line_items/refunds
Added: POST /customers/{customer_id}
Added: PUT /organization/payment_processors
Modified: GET /accounts/{account_id}
- 200 response was modified
  - summary attribute was modified
Modified: GET /customers/accounts
- 200 response was modified
  - results attribute was modified
Modified: GET /organization
- 200 response was modified
  - payment_processors attribute was modified
Modified: POST /accounts
- body was modified
  - promo_overview attribute was modified
- 200 response was modified
  - summary attribute was modified
Modified: POST /accounts/{account_id}/line_items/credit_offsets
- body was modified
  - allocation attribute was added
Modified: POST /accounts/{account_id}/line_items/debit_offsets
- body was modified
  - allocation attribute was added
Modified: POST /products
- body was modified
  - product_overview attribute was modified
Removed: PUT /organization/payment_processors
Breaking

Dec 7, 2021

Modified: GET /accounts/{account_id}/notes
- 200 response was modified
  - author attribute was modified
Modified: GET /api_users
- 200 response was modified
  - name_first, name_last attributes were modified
    Breaking
Modified: GET /api_users/summary
- 200 response was modified
  - name_first, name_last attributes were modified
    Breaking
Modified: GET /products
- 200 response was modified
  - results attribute was modified
Modified: POST /accounts/{account_id}/notes
- 200 response was modified
  - author attribute was modified
Modified: POST /api_users
- body was modified
  - name_first, name_last, phone attributes were added
- 200 response was modified
  - status attribute was added
  - email, created_at, expires_at attributes were removed
    Breaking
Modified: POST /products
- body was modified
  - post_promotional_policies attribute was modified
- 200 response was modified
  - post_promotional_policies attribute was modified
Modified: POST /register
- 200 response was modified
  - name_first, name_last attributes were modified
    Breaking

Canopy API Documentation changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API documentation has been created

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed