# Canopy Documentation

> Documentation for Canopy

## Guides: 💡Solutions to build now
- [Lending, Reinvented](https://canopy-api.readme.io/docs/overview.md): Build familiarity with Canopy's ledger
- [Cards](https://canopy-api.readme.io/docs/cards.md)
  - [Card Management](https://canopy-api.readme.io/docs/card-management.md): Eliminate the need to switch between systems and manage cards directly in Canopy!
  - [Authorization Flows](https://canopy-api.readme.io/docs/authorization-flows.md)
  - [Complex Authorization Scenarios](https://canopy-api.readme.io/docs/complex-authorization-scenarios.md)
  - [Interest Calculations](https://canopy-api.readme.io/docs/interest-calculations.md)
  - [Interest Grace Periods for Credit Cards](https://canopy-api.readme.io/docs/interest-grace-periods.md)
- [Lines of Credit](https://canopy-api.readme.io/docs/credit-lines.md)
- [Advances](https://canopy-api.readme.io/docs/merchant-cash-advances.md)
- [Installment Loans](https://canopy-api.readme.io/docs/installments.md)
- [Testing](https://canopy-api.readme.io/docs/testing.md)
  - [Testing with Event Processing](https://canopy-api.readme.io/docs/testing-with-controlled-processing.md)

## Guides: 🏁 Getting Started
- [Getting Started](https://canopy-api.readme.io/docs/getting-started-overview.md): Let's get you on your way to launching a credit or lending product!
- [Core Workflows](https://canopy-api.readme.io/docs/core-workflows.md)
  - [Loan Origination and Activation](https://canopy-api.readme.io/docs/loan-origination-and-activation.md)
  - [Handling Delinquency](https://canopy-api.readme.io/docs/handling-delinquency.md)
  - [Payment Pouring](https://canopy-api.readme.io/docs/payment-pouring.md): Payment pouring refers to the systematic allocation of payments across various types of financial obligations
  - [Policy Updates](https://canopy-api.readme.io/docs/policy-flexibility.md): Canopy's dynamic policy engine treats policies as living and adaptable that can evolve alongside your business needs and borrower circumstances.

## Guides: 🏗️ Building blocks
- [The Future of Lending](https://canopy-api.readme.io/docs/the-future-of-lending.md)
- [Policy Framework](https://canopy-api.readme.io/docs/policies-1.md): The engine behind compliance and lending behavior
  - [Locale Rule Sets](https://canopy-api.readme.io/docs/locale-rule-sets.md): Establishes the regulatory boundaries within which your lending program operates. These rules are non-negotiable constraints based on jurisdictional requirements.
  - [Templates](https://canopy-api.readme.io/docs/templates.md): Ensures that all necessary policies are applied consistently when creating accounts or credit constructs
  - [Policies](https://canopy-api.readme.io/docs/policies.md): Individual policies determine how specific aspects of your lending product operate
- [Accounts](https://canopy-api.readme.io/docs/account.md): The central hub where a borrower's entire financial relationship with a lender comes to life
- [Draws](https://canopy-api.readme.io/docs/draws-1.md)
- [Transactions](https://canopy-api.readme.io/docs/transactions.md): A comprehensive, immutable record of every financial interaction.

## Guides: 🚚 Servicing
- [Deferrals](https://canopy-api.readme.io/docs/deferrals.md): Provide better servicing to borrowers by deferring obligations
- [MLA/SCRA](https://canopy-api.readme.io/docs/mlascra.md)
- [Notifications](https://canopy-api.readme.io/docs/notifications-1.md)
- [Provisional Credit](https://canopy-api.readme.io/docs/provisional-credit.md)
- [Reconciliation](https://canopy-api.readme.io/docs/reconciliation.md): Reconciliation is the process of ensuring that transactions recorded by your issuer or processor exactly match the transactions reflected in Canopy’s ledger.
- [Retroactivity](https://canopy-api.readme.io/docs/retroactivity.md)
- [Segmentation](https://canopy-api.readme.io/docs/segmentation.md): Automatically categorize accounts with intelligent segmentation
  - [Delinquency Management](https://canopy-api.readme.io/docs/delinquency-management.md): Proactively address any delinquency issues
  - [Active Disputes](https://canopy-api.readme.io/docs/active-disputes.md): Always know which accounts have active disputes
- [Statuses](https://canopy-api.readme.io/docs/statuses.md): Track and manage the lifecycle of your advances, loans and lines of credit
- [Tags](https://canopy-api.readme.io/docs/tags.md): Organize. Understand. Impact.

## Guides: 🔒 Secured Lending
- [Secured Lending](https://canopy-api.readme.io/docs/secured-lending.md)
  - [Valuations](https://canopy-api.readme.io/docs/valuations.md)
  - [Liens](https://canopy-api.readme.io/docs/liens-1.md)
  - [Risk Mitigation](https://canopy-api.readme.io/docs/risk-mitigation.md)

## Guides: 💎 Platform
- [DataDirect](https://canopy-api.readme.io/docs/datadirect.md): Access Canopy data through direct database connection
  - [Recommended tools](https://canopy-api.readme.io/docs/recommended-tools.md): Recommended tools to get you started with DataDirect.
- [Canopy Connect](https://canopy-api.readme.io/docs/canopy-connect.md): Connect is a user friendly, no-code workflow builder that allows users to integrate Canopy with the other systems that power their lending program and automate manual processes.
  - [Core Concepts](https://canopy-api.readme.io/docs/connect-core-concepts.md)
  - [Getting Started Guides](https://canopy-api.readme.io/docs/getting-started.md)
  - [Connectors: Available Actions & Integrations](https://canopy-api.readme.io/docs/connectors.md)
  - [Connect Feedback Form](https://canopy-api.readme.io/docs/connect-feedback-form.md)
  - [Connect FAQs](https://canopy-api.readme.io/docs/connect-faqs.md)

## Guides: 📄 Reports
- [Reports](https://canopy-api.readme.io/docs/reports.md): Get comprehensive access to your lending data with Canopy's reporting capabilities.
  - [Delinquency Report](https://canopy-api.readme.io/docs/delinquency-report.md): Comprehensive delinquency analysis and risk management insights for your lending portfolio.

## API Reference: Public
- [Auth](https://canopy-api.readme.io/reference/auth.md)
  - [Get an auth token](https://canopy-api.readme.io/reference/authcbv_request_auth_token_public_v1_auth_token_post.md): Endpoint to request an auth token that can be used to access the API with a Bearer token.  RBAC controls based on the client_id and client_secret are applied to the returned token.
- Webhook Handler
  - [FirstData webhook handler](https://canopy-api.readme.io/reference/webhookhandlercbv_handle_firstdata_webhook_public_v1_webhooks_firstdata_post.md): Handles the FirstData Issuer Processing webhook.
  - [Stripe webhook handler](https://canopy-api.readme.io/reference/webhookhandlercbv_handle_stripe_webhook_public_v1_webhooks_stripe_post.md): Handles the Stripe Issuer Processing webhook.
- Healthcheck
  - [Check health of the application (reader and writer DB endpoints)](https://canopy-api.readme.io/reference/healthcheckcbv_healthcheck_public_v1_health_check_get.md): Checks the health of the application by performing a full healthcheck.

## API Reference: Core
- Account User Tags
  - [Get all tags associated with an account](https://canopy-api.readme.io/reference/accounttagscbv_get_all_account_tags_core_v1_accounts__account_id__tags_get.md): Gets all user applied tags associated with an account.
  - [Apply a tag to an account](https://canopy-api.readme.io/reference/accounttagscbv_add_tag_to_account_core_v1_accounts__account_id__tags_post.md): Applies a user generated tag to an account.
  - [Remove a tag from an account](https://canopy-api.readme.io/reference/accounttagscbv_remove_tag_from_account_core_v1_accounts__account_id__tags__tag_id__delete.md): Removes a user generated tag from an account.
- [Accounts](https://canopy-api.readme.io/reference/accounts.md)
  - [Get accounts](https://canopy-api.readme.io/reference/coreaccountcbv_get_accounts_core_v1_accounts_get.md): This endpoint returns a paginated list of accounts.  Can filter by manual or system generated tags on the account along with being able to filter by a text search via the following fields…
  - [Create a new account](https://canopy-api.readme.io/reference/coreaccountcbv_create_account_core_v1_accounts_post.md)
  - [Gets the account details for a given account id](https://canopy-api.readme.io/reference/accountcbv_get_account_core_v1_accounts__account_id__get.md): Gets the account details for a given account id.
  - [Transfer account ownership to a new organization](https://canopy-api.readme.io/reference/accountcbv_post_account_ownership_transfer_core_v1_accounts__account_id__ownership_transfers_post.md): Transfer account ownership to a new organization.
- Account System Tags
  - [Get all system applied tags associated with an account](https://canopy-api.readme.io/reference/accountsystemtagscbv_get_all_account_system_applied_tags_core_v1_accounts__account_id__system_tags_get.md): Gets all system applied tags associated with an account.
- [Account External Fields](https://canopy-api.readme.io/reference/account-external-fields.md)
  - [Update external fields for an account](https://canopy-api.readme.io/reference/accountexternalfieldscbv_put_account_external_fields_core_v1_accounts__account_id__external_fields_put.md): Edit account's external fields  The body of your request should be in the same format used to provide key value pairs when adding external fields when creating an account.  [{'key': 'key 1', 'value':…
- Calculations
  - [Calculate APR and APY for a loan](https://canopy-api.readme.io/reference/loancalculationscbv_calculate_apr_core_v1_calculations_apr_post.md): Calculates the Annual Percentage Rate (APR) for a loan based on provided parameters.
  - [Calculate Nominal Interest Rate for a loan](https://canopy-api.readme.io/reference/loancalculationscbv_calculate_nominal_interest_rate_core_v1_calculations_nominal_interest_rate_post.md): Calculates the nominal interest rate for a loan based on provided parameters.
- [Borrowers](https://canopy-api.readme.io/reference/borrowers.md)
  - [Create a new borrower](https://canopy-api.readme.io/reference/borrowerscbv_create_borrower_core_v1_borrowers_post.md): Creates a new borrower.
  - [Create a new business borrower](https://canopy-api.readme.io/reference/borrowerscbv_create_business_borrower_core_v1_borrowers_business_post.md): Creates a new business borrower.
  - [Get a paginated list of borrowers](https://canopy-api.readme.io/reference/borrowerscbv_get_borrowers_core_v1_borrowers_get.md)
- Locale Rule Sets
  - [Create a new locale rule set](https://canopy-api.readme.io/reference/localerulesetsrouter_create_locale_rule_set_core_v1_locale_rule_sets_post.md): Create a new locale rule set for jurisdiction-specific validation rules.
  - [Get a locale rule set by ID](https://canopy-api.readme.io/reference/localerulesetsrouter_get_locale_rule_set_core_v1_locale_rule_sets__locale_rule_set_id__get.md): Gets a locale rule set by locale_rule_set_id.
  - [Get all locale rule sets](https://canopy-api.readme.io/reference/localerulesetsrouter_get_locale_rule_sets_core_v1_locale_rule_sets_get.md): Gets all locale rule sets with optional filters and pagination.  By default, expired rule sets are excluded. Set include_expired=true to include them.
- [Policies](https://canopy-api.readme.io/reference/templates.md)
  - [Get usage information for a specific policy template](https://canopy-api.readme.io/reference/policiescbv_get_template_usage_core_v1_templates__template_id__usage_get.md): Gets usage information for a specific policy template with pagination.  Returns accounts, lines of credit, installment loans, and advances that were created using the specified template.
  - [Get a policy template by ID](https://canopy-api.readme.io/reference/policiescbv_get_template_by_id_core_v1_templates__template_id__get.md): Gets a policy template by template_id.
  - [Get all policy templates](https://canopy-api.readme.io/reference/policiescbv_get_all_templates_core_v1_templates_get.md): Gets all policy templates with pagination and filtering.
  - [Update policies for multiple lines of credit](https://canopy-api.readme.io/reference/policiescbv_update_loc_policies_batch_core_v1_line_of_credit_policies_patch.md)
  - [Create an account template](https://canopy-api.readme.io/reference/policiescbv_create_account_template_core_v1_templates_account_post.md): Creates a new account template.
  - [Get all templates for account creation](https://canopy-api.readme.io/reference/policiescbv_get_account_templates_core_v1_templates_account_get.md): Gets all templates for account creation.
  - [Get policies for a given account](https://canopy-api.readme.io/reference/accountcbv_get_account_policies_core_v1_accounts__account_id__policies_get.md): Gets the policies for a given account.
  - [Create a line of credit template](https://canopy-api.readme.io/reference/policiescbv_create_loc_template_core_v1_templates_line_of_credit_post.md): Creates a new line of credit template.
  - [Get all templates for line of credit creation](https://canopy-api.readme.io/reference/policiescbv_get_loc_templates_core_v1_templates_line_of_credit_get.md): Gets all templates for line of credit creation.
  - [Get policies for a line of credit](https://canopy-api.readme.io/reference/lineofcreditcbv_get_loc_policies_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__policies_get.md)
  - [Get deferral policies for a line of credit.](https://canopy-api.readme.io/reference/lineofcreditcbv_get_payment_deferral_policies_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__payment_deferrals_policies_get.md): Gets the deferral policies for a line of credit.
  - [Update policies for a line of credit](https://canopy-api.readme.io/reference/lineofcreditcbv_update_loc_policies_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__policies_patch.md)
  - [Create an installment loan template](https://canopy-api.readme.io/reference/policiescbv_create_loan_template_core_v1_templates_installment_loan_post.md): Creates a new installment loan template.
  - [Get all templates for installment loan creation](https://canopy-api.readme.io/reference/policiescbv_get_loan_templates_core_v1_templates_installment_loan_get.md): Gets all templates for installment loan creation.
  - [Create an advance template](https://canopy-api.readme.io/reference/policiescbv_create_advance_template_core_v1_templates_advance_post.md)
  - [Get all templates for advance creation](https://canopy-api.readme.io/reference/policiescbv_get_advance_templates_core_v1_templates_advance_get.md): Gets all templates for advance creation.
  - [Get deferral policies for an installment loan.](https://canopy-api.readme.io/reference/installmentloanscbv_get_payment_deferral_policies_installment_v1_accounts__account_id__installment_loans__loan_id__payment_deferrals_policies_get.md): Gets the deferral policies for an installment loan.
- [User Tags](https://canopy-api.readme.io/reference/tags.md)
  - [Get all tags for the organization](https://canopy-api.readme.io/reference/tagscbv_get_all_tags_core_v1_tags_get.md): Gets all user generated tags for the organization.
  - [Add tag to the organization](https://canopy-api.readme.io/reference/tagscbv_create_tag_option_core_v1_tags_post.md): Adds a new user generated tag to the organization.
  - [Update a tag option](https://canopy-api.readme.io/reference/tagscbv_update_tag_option_core_v1_tags__tag_id__patch.md): Updates a user generated tag option.
- System Tags
  - [Get all system applied tags](https://canopy-api.readme.io/reference/systemtagscbv_get_all_system_applied_tags_core_v1_system_tags_get.md): Gets all system applied tags available in the LMS.
- [Notifications](https://canopy-api.readme.io/reference/notifications.md)
  - [Get available notification configurations](https://canopy-api.readme.io/reference/notificationscbv_get_notification_configs_core_v1_notifications_configs_get.md): Gets the notification configurations for a product or an account.
  - [Create a notification configuration for a product or an account](https://canopy-api.readme.io/reference/notificationscbv_create_notification_configs_core_v1_notifications_configs_post.md): Creates a notification configuration for a product or an account.
  - [Disable the notification configurations that match the provided filters](https://canopy-api.readme.io/reference/notificationscbv_disable_notification_configs_core_v1_notifications_configs_patch.md): Disables the notification configurations that match the provided filters.
  - [Get notifications](https://canopy-api.readme.io/reference/notificationscbv_get_notifications_core_v1_notifications_get.md): Gets the notifications for a product or an account.
- Organizations
  - [Get all organizations](https://canopy-api.readme.io/reference/organizationcbv_get_organizations_core_v1_organizations_get.md): Gets all organizations.
  - [Gets the Data Direct connection configuration](https://canopy-api.readme.io/reference/datadirectcbv_get_data_direct_connection_core_v1_organizations_data_direct_get.md)
  - [Gets the Data Direct allow list](https://canopy-api.readme.io/reference/datadirectcbv_get_data_direct_allow_list_core_v1_organizations_data_direct_allow_list_get.md): Gets the Data Direct allow list.
  - [Adds CIDRs to the Data Direct allow list](https://canopy-api.readme.io/reference/datadirectcbv_add_cidrs_to_allow_list_core_v1_organizations_data_direct_allow_list_post.md): Adds CIDRs to the Data Direct allow list.
  - [Deletes CIDRs from the Data Direct allow list](https://canopy-api.readme.io/reference/datadirectcbv_delete_cidrs_from_allow_list_core_v1_organizations_data_direct_allow_list_delete.md): Deletes CIDRs from the Data Direct allow list.

## API Reference: Installments
- [Installment Loans](https://canopy-api.readme.io/reference/installment-loans.md)
  - [Creates a new installment loan.](https://canopy-api.readme.io/reference/installmentloanscbv_create_loan_installment_v1_accounts__account_id__installment_loans_post.md): Creates a new installment loan.
  - [Get the installment loans for an account.](https://canopy-api.readme.io/reference/installmentloanscbv_get_loans_installment_v1_accounts__account_id__installment_loans_get.md): Gets the installment loans for an account.
  - [Get an installment loan by loan_id.](https://canopy-api.readme.io/reference/installmentloanscbv_get_loan_by_id_installment_v1_accounts__account_id__installment_loans__loan_id__get.md): Gets an installment loan by loan_id.
  - [Get an installment loan's payment schedule.](https://canopy-api.readme.io/reference/installmentloanscbv_get_payment_schedule_installment_v1_accounts__account_id__installment_loans__loan_id__payment_schedule_get.md): Gets the payment schedule for an installment loan.
  - [Get the payment schedule due dates for a loan.](https://canopy-api.readme.io/reference/installmentloanscbv_get_due_dates_installment_v1_accounts__account_id__installment_loans__loan_id__due_dates_get.md): Gets the payment schedule due dates for a loan.
  - [Get the periodic payment due for a loan.](https://canopy-api.readme.io/reference/installmentloanscbv_get_periodic_payment_due_installment_v1_accounts__account_id__installment_loans__loan_id__periodic_payment_due_get.md): Gets the periodic payment due for an installment loan with enhanced information including: - Total periodic payment due - Payment due date - Current cycle and past due breakdowns by principal,…
  - [Change the loan's interest rate.](https://canopy-api.readme.io/reference/installmentloanscbv_patch_loan_interest_rate_installment_v1_accounts__account_id__installment_loans__loan_id__interest_rate_patch.md): Changes the loan's interest rate.
- Deferrals
  - [Defer past, current, or future payment schedule due amounts to later dates.](https://canopy-api.readme.io/reference/installmentloanscbv_post_payment_deferrals_installment_v1_accounts__account_id__installment_loans__loan_id__payment_deferrals_post.md): Defers past, current, or future payment schedule due amounts to later dates.
- SCRA/MLA Adjustments
  - [Post an MLA adjustment to an installment loan.](https://canopy-api.readme.io/reference/installmentloanscbv_post_mla_adjustment_installment_v1_accounts__account_id__installment_loans__loan_id__mla_adjustment_post.md): Posts an MLA adjustment to an installment loan.
  - [Post an SCRA adjustment to an installment loan.](https://canopy-api.readme.io/reference/installmentloanscbv_post_scra_adjustment_installment_v1_accounts__account_id__installment_loans__loan_id__scra_adjustment_post.md): Posts an SCRA adjustment to an installment loan.
- Transactions
  - [Get a transaction for a loan](https://canopy-api.readme.io/reference/transactioncbv_get_installment_loan_transaction_by_id_installment_v1_accounts__account_id__installment_loans__loan_id__transactions__transaction_id__get.md): Get a transaction by id.
  - [Get transactions for a loan](https://canopy-api.readme.io/reference/transactioncbv_get_installment_loan_transactions_installment_v1_accounts__account_id__installment_loans__loan_id__transactions_get.md): Gets transactions for a loan.
- Statements
  - [Get statements for a loan](https://canopy-api.readme.io/reference/statementcbv_get_loan_statements_installment_v1_accounts__account_id__installment_loans__loan_id__statements_get.md): Get statements for a loan.
  - [Get a loan statement by id](https://canopy-api.readme.io/reference/statementcbv_get_loan_statement_by_id_installment_v1_accounts__account_id__installment_loans__loan_id__statements__statement_id__get.md): Get a loan statement by id.

## API Reference: Revolving
- [Lines of Credit](https://canopy-api.readme.io/reference/lines-of-credit.md)
  - [Adjust the interest rate for a line of credit.](https://canopy-api.readme.io/reference/lineofcreditcbv_post_mla_adjustment_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__mla_adjustment_post.md): Applies a Military Lending Act (MLA) interest rate adjustment to the specified line of credit.  This endpoint enforces MLA interest rate caps for eligible service members and recomputes the accrued…
  - [Adjust the interest rate for a line of credit.](https://canopy-api.readme.io/reference/lineofcreditcbv_post_scra_adjustment_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__scra_adjustment_post.md): Applies a Servicemembers Civil Relief Act (SCRA) interest rate adjustment to the specified line of credit.  This endpoint enforces SCRA interest rate caps for eligible service members and recomputes…
  - [Get the status history of a line of credit.](https://canopy-api.readme.io/reference/lineofcreditcbv_get_all_line_of_credit_status_history_revolving_v1_accounts__account_id__line_of_credit_history_status_get.md)
  - [Create a line of credit for an account](https://canopy-api.readme.io/reference/lineofcreditcbv_create_loc_revolving_v1_accounts__account_id__line_of_credit_post.md): Creates a new line of credit for an account.
  - [Get a line of credit for an account](https://canopy-api.readme.io/reference/lineofcreditcbv_get_loc_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__get.md): Gets a line of credit by line_of_credit_id.
  - [Get the available credit for a line of credit](https://canopy-api.readme.io/reference/lineofcreditcbv_get_available_credit_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__available_credit_get.md): Gets the available credit for a line of credit. Helpful in authorization flows.
  - [Get all line of credits for an account](https://canopy-api.readme.io/reference/lineofcreditcbv_get_locs_revolving_v1_accounts__account_id__line_of_credit_get.md): Gets all line of credits for an account.
  - [Get the minimum payment for a line of credit](https://canopy-api.readme.io/reference/lineofcreditcbv_get_min_pay_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__min_pay_get.md): Gets the minimum payment for a line of credit.
  - [Get the obligations for a line of credit](https://canopy-api.readme.io/reference/lineofcreditcbv_get_obligations_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__obligations_get.md): Gets the obligations for a line of credit.
  - [Get the due dates for a line of credit](https://canopy-api.readme.io/reference/lineofcreditcbv_get_due_dates_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__due_dates_get.md): Gets the due dates for a line of credit.
  - [Adjust credit limit for a line of credit](https://canopy-api.readme.io/reference/lineofcreditcbv_adjust_credit_limit_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__credit_limit_patch.md): Adjusts the credit limit for a line of credit.
  - [Get history of credit limit changes for a line of credit](https://canopy-api.readme.io/reference/lineofcreditcbv_get_credit_limit_changes_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__credit_limits_get.md): Gets history of credit limit changes for a line of credit.
  - [Adjust the interest rate for a line of credit](https://canopy-api.readme.io/reference/lineofcreditcbv_adjust_interest_rate_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__interest_rate_patch.md): Adjusts the interest rate for a line of credit.
  - [Update the status of a line of credit.](https://canopy-api.readme.io/reference/lineofcreditcbv_update_line_of_credit_status_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__status_patch.md)
- Deferrals
  - [Defer past, current, or future payment schedule due amounts to later dates.](https://canopy-api.readme.io/reference/lineofcreditcbv_post_payment_deferrals_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__payment_deferrals_post.md): Defers past, current, or future payment schedule due amounts to later dates.
- [Draws](https://canopy-api.readme.io/reference/draws.md)
  - [Create a draw for a line of credit](https://canopy-api.readme.io/reference/drawcbv_create_draw_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__draw_post.md): Creates a new draw on a line of credit.  Allows creation of a draw on an existing line of credit for a specified account, enabling users to request funds.  The draw will decrease the available credit…
  - [Capture a portion of an authorized draw](https://canopy-api.readme.io/reference/drawcbv_capture_draw_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__draws__draw_id__capture_post.md): Captures a specified amount from an authorized draw on a line of credit. This enables partial settlements against a single authorization, ideal for scenarios like e-commerce orders with multiple…
  - [Create a backdated draw for a line of credit](https://canopy-api.readme.io/reference/drawcbv_create_backdated_draw_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__backdated_action_draw_post.md)
- [Fees](https://canopy-api.readme.io/reference/fees.md)
  - [Create a fee for a line of credit](https://canopy-api.readme.io/reference/feecbv_create_fee_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__fee_post.md): Creates a new fee for a line of credit.
- [Offsets](https://canopy-api.readme.io/reference/offsets.md)
  - [Create an offset for a line of credit](https://canopy-api.readme.io/reference/offsetcbv_create_offset_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__offset_post.md): Creates a new offset for a line of credit.
- [Statements](https://canopy-api.readme.io/reference/statements.md)
  - [Get statements for a line of credit](https://canopy-api.readme.io/reference/statementcbv_get_statements_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__statements_get.md): Gets statements for a line of credit.
  - [Get a line of credit statement by id](https://canopy-api.readme.io/reference/statementcbv_get_statement_by_id_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__statements__statement_id__get.md): Gets a line of credit statement by id.
- [Payments](https://canopy-api.readme.io/reference/payments.md)
  - [Create a payment for a line of credit](https://canopy-api.readme.io/reference/paymentcbv_create_payment_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__payment_post.md): Creates a new payment for a line of credit.
  - [Create a backdated payment for a line of credit](https://canopy-api.readme.io/reference/paymentcbv_create_backdated_payment_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__backdated_action_payment_post.md): Creates a new payment for a line of credit.
- [Refunds](https://canopy-api.readme.io/reference/refunds.md)
  - [Create a refund for a line of credit](https://canopy-api.readme.io/reference/refundcbv_create_refund_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__refund_post.md): Creates a new refund for a line of credit.
- [Transactions](https://canopy-api.readme.io/reference/transactions.md)
  - [Get a transaction for a line of credit](https://canopy-api.readme.io/reference/transactioncbv_get_transaction_by_id_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__transactions__transaction_id__get.md): Gets a transaction by id.
  - [Get transactions for a line of credit](https://canopy-api.readme.io/reference/transactioncbv_get_line_of_credit_transactions_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__transactions_get.md): Gets transactions for a line of credit.
  - [Settle a transaction for a line of credit](https://canopy-api.readme.io/reference/transactioncbv_settle_transaction_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__transactions__transaction_id__settle_patch.md): Settles a transaction for a line of credit.
  - [Update transaction dispute status](https://canopy-api.readme.io/reference/transactioncbv_update_transaction_dispute_status_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__transactions__transaction_id__dispute_put.md): Updates the dispute status of a transaction for a line of credit.
  - [Update transaction metadata](https://canopy-api.readme.io/reference/transactioncbv_upsert_transaction_metadata_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__transactions__transaction_id__metadata_put.md): Updates the metadata of a transaction for a line of credit.
  - [Adjust the balance of a transaction for a line of credit](https://canopy-api.readme.io/reference/transactioncbv_adjust_balance_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__transactions__transaction_id__balance_patch.md): Adjusts the balance of a transaction for a line of credit.
  - [Get splits related to a transaction for a line of credit](https://canopy-api.readme.io/reference/transactioncbv_get_transaction_balance_splits_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__transactions__transaction_id__balance_splits_get.md): Gets splits related to a transaction for a line of credit.
  - [Adjust the interest rate for a transaction](https://canopy-api.readme.io/reference/transactioncbv_adjust_interest_rate_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__transactions__transaction_id__interest_rate_patch.md): Adjusts the interest rate for a transaction.
- [Reversals](https://canopy-api.readme.io/reference/reversals.md)
  - [Reverse a payment on a line of credit](https://canopy-api.readme.io/reference/reversalcbv_reverse_payment_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__payment_reversals__payment_id__post.md): Reverses a payment on a line of credit.
  - [Reverse a draw on a line of credit](https://canopy-api.readme.io/reference/reversalcbv_reverse_draw_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__draw_reversals__draw_id__post.md): Reverses a draw on a line of credit.
- Cards
  - [Issue a card for a line of credit](https://canopy-api.readme.io/reference/lineofcreditcardscbv_create_card_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__cards_post.md): Issues a card for a line of credit.
  - [Get a card for a line of credit](https://canopy-api.readme.io/reference/lineofcreditcardscbv_get_card_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__cards__card_id__get.md): Gets a card for a line of credit.
  - [Get cards for a line of credit](https://canopy-api.readme.io/reference/lineofcreditcardscbv_get_cards_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__cards_get.md)
  - [Update the status of a card for a line of credit (freeze, unfreeze, cancel)](https://canopy-api.readme.io/reference/lineofcreditcardscbv_update_card_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__cards__card_id__put.md): Updates the status of a card for a line of credit.
  - [Renew a card for a line of credit](https://canopy-api.readme.io/reference/lineofcreditcardscbv_renew_card_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__cards__card_id__renew_post.md): Renews a card for a line of credit.

## API Reference: Advances
- Advances
  - [Get a statement for an advance](https://canopy-api.readme.io/reference/advancecbv_get_advance_statement_advance_v1_accounts__account_id__advances__advance_id__statements__statement_id__get.md)
  - [Get an advance for an account](https://canopy-api.readme.io/reference/advancecbv_get_advance_advance_v1_accounts__account_id__advances__advance_id__get.md)
  - [Get the payment schedule for an advance](https://canopy-api.readme.io/reference/advancecbv_get_payment_schedule_advance_v1_accounts__account_id__advances__advance_id__payment_schedule_get.md)
  - [Get the minimum payment for an advance](https://canopy-api.readme.io/reference/advancecbv_get_advance_min_pay_advance_v1_accounts__account_id__advances__advance_id__min_pay_get.md)
  - [Create an advance for an account](https://canopy-api.readme.io/reference/advancecbv_post_advance_advance_v1_accounts__account_id__advances_post.md)
  - [Get account advances](https://canopy-api.readme.io/reference/advancecbv_get_account_advances_advance_v1_accounts__account_id__advances_get.md)
  - [Create a payment for an advance](https://canopy-api.readme.io/reference/advancecbv_post_payment_advance_v1_accounts__account_id__advances__advance_id__payment_post.md)
  - [Get paginated transactions for an advance](https://canopy-api.readme.io/reference/advancecbv_get_advance_transactions_advance_v1_accounts__account_id__advances__advance_id__transactions_get.md)
  - [Get transaction for an advance](https://canopy-api.readme.io/reference/advancecbv_get_advance_transaction_by_id_advance_v1_accounts__account_id__advances__advance_id__transactions__transaction_id__get.md)
  - [Get splits for an advance transaction](https://canopy-api.readme.io/reference/advancecbv_get_advance_transaction_splits_advance_v1_accounts__account_id__advances__advance_id__transactions__transaction_id__splits_get.md)

## API Reference: Secured
- [Valuations](https://canopy-api.readme.io/reference/valuations.md)
  - [Add a valuation to a collateral](https://canopy-api.readme.io/reference/collateralscbv_add_collateral_valuation_core_v1_secured_collaterals__collateral_id__valuations_post.md): Adds a valuation to a collateral.
- [LTV](https://canopy-api.readme.io/reference/ltv.md)
  - [Get the Loan To Value ratio](https://canopy-api.readme.io/reference/collateralscbv_get_ltv_core_v1_secured_ltv_get.md): Gets the LTV for the loan or line of credit.
- [Liens](https://canopy-api.readme.io/reference/liens.md)
  - [Create a lien](https://canopy-api.readme.io/reference/collateralscbv_create_lien_core_v1_secured_collaterals__collateral_id__liens_post.md): Creates a new lien on a collateral.
  - [Terminate a lien on a collateral](https://canopy-api.readme.io/reference/collateralscbv_terminate_lien_core_v1_secured_collaterals__collateral_id__liens__lien_id__terminate_patch.md): Terminates a lien on a collateral.
- [Collaterals](https://canopy-api.readme.io/reference/collaterals.md)
  - [Get a collateral by ID](https://canopy-api.readme.io/reference/collateralscbv_get_collateral_core_v1_secured_collaterals__collateral_id__get.md): Gets a collateral by collateral_id.
  - [Get collaterals](https://canopy-api.readme.io/reference/collateralscbv_get_collaterals_core_v1_secured_collaterals_get.md): Gets collaterals associated with a loan or a line of credit, if provided. Otherwise, returns all collaterals.
  - [Create a collateral](https://canopy-api.readme.io/reference/collateralscbv_create_collateral_core_v1_secured_collaterals_post.md): Creates a new collateral.
  - [Create an association between a collateral and a loan or a line of credit](https://canopy-api.readme.io/reference/collateralscbv_create_collateral_association_core_v1_secured_collaterals__collateral_id__associations_post.md): Creates an association between a collateral and a loan or a line of credit.
  - [Substitute collaterals](https://canopy-api.readme.io/reference/collateralscbv_substitute_collaterals_core_v1_secured_collaterals_substitute_post.md): Substitutes collaterals.
  - [Liquidate a collateral](https://canopy-api.readme.io/reference/collateralscbv_liquidate_collateral_core_v1_secured_collaterals__collateral_id__liquidate_post.md): Liquidates a collateral by seizing the deposit and applying it to the outstanding balance.
  - [Release a collateral](https://canopy-api.readme.io/reference/collateralscbv_release_collateral_core_v1_secured_collaterals__collateral_id__release_patch.md): Releases a collateral.
  - [Return a collateral deposit](https://canopy-api.readme.io/reference/collateralscbv_return_collateral_core_v1_secured_collaterals__collateral_id__return_post.md): Returns a collateral deposit on voluntary account closure in good standing.
- Graduation
  - [Graduate a secured card line of credit to unsecured](https://canopy-api.readme.io/reference/collateralscbv_graduate_line_of_credit_core_v1_secured_graduation_accounts__account_id__line_of_credit__line_of_credit_id__post.md): Graduates a secured card line of credit to an unsecured card by updating credit limit, APR, handling the security deposit, and releasing the collateral.

## API Reference: Canopy Servicing Core API
- Accounts
  - [Get payoff amounts for a given account](https://canopy-api.readme.io/reference/accountcbv_get_account_payoff_amounts_core_v1_accounts__account_id__payoff_amounts_get.md): Gets the payoff amounts for a given account.
- Lines of Credit
  - [Create a promo configuration](https://canopy-api.readme.io/reference/promoconfigurationscbv_create_promo_configuration_core_v1_promo_configurations_post.md): Creates a new promo configuration that can later be attached to lines of credit.
  - [Get promos for a line of credit](https://canopy-api.readme.io/reference/lineofcreditcbv_get_promos_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__promos_get.md): Returns all promos attached to the specified line of credit.
  - [Attach a promo configuration to a line of credit](https://canopy-api.readme.io/reference/lineofcreditcbv_attach_promo_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__promos_post.md): Attaches a promo configuration to a line of credit, creating a new promo instance.
  - [List promo configurations](https://canopy-api.readme.io/reference/promoconfigurationscbv_list_promo_configurations_core_v1_promo_configurations_get.md): Returns a paginated list of promo configurations with optional filtering by ID, active status, promotional rate range, and text search on name/description.
  - [Get a promo configuration](https://canopy-api.readme.io/reference/promoconfigurationscbv_get_promo_configuration_core_v1_promo_configurations__promo_configuration_id__get.md): Returns a single promo configuration by ID.
  - [List lines of credit for a promo configuration](https://canopy-api.readme.io/reference/promoconfigurationscbv_list_promo_configuration_lines_of_credit_core_v1_promo_configurations__promo_configuration_id__lines_of_credit_get.md): Returns a paginated list of line of credit promos issued under this promo configuration.
  - [Get transactions for a line of credit promo](https://canopy-api.readme.io/reference/lineofcreditcbv_get_promo_transactions_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__promos__promo_id__transactions_get.md): Returns a paginated list of transactions associated with the specified promo.
  - [Verify a line of credit balance snapshot.](https://canopy-api.readme.io/reference/lineofcreditcbv_verify_balance_snapshot_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__balance_snapshots_verify_post.md): Verifies the latest non-discarded balance snapshot at or before ``effective_at`` by reconciling it against outstanding payable balances.
- Draws
  - [Create a balance transfer for a line of credit](https://canopy-api.readme.io/reference/drawcbv_create_balance_transfer_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__balance_transfer_post.md)

## Pages
- [Another Custom Page](https://canopy-api.readme.io/page/another-custom-page.md)
- [Test Custom Page](https://canopy-api.readme.io/page/test-custom-page.md)

## Release Notes
- [Introducing Reconciliation in Canopy](https://canopy-api.readme.io/changelog/introducing-reconciliation-in-canopy.md)
- [Canopy Extending Support for Advances](https://canopy-api.readme.io/changelog/canopy-now-fully-supports-advances.md)
- [Uploaded Documents Now Persist Across Master Account, Originator, and Owner Orgs](https://canopy-api.readme.io/changelog/uploaded-documents-now-persist-across-master-account-originator-and-owner-orgs.md)
- [Introducing the new Installments OS Experience (Beta)](https://canopy-api.readme.io/changelog/introducing-the-new-installments-os-experience-beta.md)
- [Organization-Level Access Controls](https://canopy-api.readme.io/changelog/organization-level-access-controls.md)
- [New Calculation Endpoint for TILA Compliance](https://canopy-api.readme.io/changelog/new-calculation-endpoints-for-tila-compliance.md)
- [Quality of life improvements to Controlled Processing](https://canopy-api.readme.io/changelog/quality-of-life-improvements-to-controlled-processing.md)
- [Update to Data Direct's refresh logic](https://canopy-api.readme.io/changelog/update-data-directs-refresh-logic.md)
- [Data Direct Payoff Amounts and Unaccrued Interest Fields](https://canopy-api.readme.io/changelog/data-direct-payoff-amounts-and-unaccrued-interest-fields.md)
- [Update Line of Credit Transaction Interest Rate](https://canopy-api.readme.io/changelog/update-line-of-credit-transaction-interest-rate.md)