# Canopy Servicing Core API - Latest ## Description This is version `1.8.11` of this API documentation. Last update on Feb 3, 2022. **API Overview** Canopy allows you to easily manage credit, installment, or other more complex lending programs from a servicing and compliance perspective - whether newly launched or migrated from existing systems. Using Canopy, you can track balances and transactions for each customer of your product, both in real-time and historically. You can see how various policy and product changes would impact your customers, and readily generate compliance reports and minimize your risk with all real-time information always on hand. Canopy additionally surfaces information around all of your lending activity through its intuitive UI which provides a customer support interface as well as at-a-glance data needed for compliance and insights. Simply configure your product’s policies through our Create Product API endpoint, and then you can immediately begin adding customer accounts and relying on Canopy for accurate servicing information. ## Servers - Public Sandbox: https://sandbox-api.canopyservicing.com (Public Sandbox) - Protected UAT Sandbox: https://uat-api.canopyservicing.com (Protected UAT Sandbox) - Production: https://api.canopyservicing.com (Production) ## Topics - [Getting Started](https://bump.sh/devs/doc/upcoming-release/topic/topic-getting-started.md) - [Authentication](https://bump.sh/devs/doc/upcoming-release/authentication.md) - [Troubleshooting](https://bump.sh/devs/doc/upcoming-release/topic/topic-troubleshooting.md) - [Test it out](https://bump.sh/devs/doc/upcoming-release/topic/topic-test-it-out.md) - [Pagination](https://bump.sh/devs/doc/upcoming-release/topic/topic-pagination.md) - [Document Versioning](https://bump.sh/devs/doc/upcoming-release/topic/topic-document-versioning.md) ## Endpoints and operations ### [api_users](https://bump.sh/devs/doc/upcoming-release/group/endpoint-api_users.md) - [Get all API users in your organization](https://bump.sh/devs/doc/upcoming-release/operation/operation-getapiusers.md) - [Invite a new API user to Canopy](https://bump.sh/devs/doc/upcoming-release/operation/operation-createapiuser.md) - [Register a new organization and user](https://bump.sh/devs/doc/upcoming-release/operation/operation-registerapiuserpassword.md) - [Get summary info for an API user](https://bump.sh/devs/doc/upcoming-release/operation/operation-getapiuser.md) ### [products](https://bump.sh/devs/doc/upcoming-release/group/endpoint-products.md) - [Get all available products](https://bump.sh/devs/doc/upcoming-release/operation/operation-getproducts.md) - [Create a new product](https://bump.sh/devs/doc/upcoming-release/operation/operation-createproduct.md) ### [customers](https://bump.sh/devs/doc/upcoming-release/group/endpoint-customers.md) - [Get all accounts for all customers](https://bump.sh/devs/doc/upcoming-release/operation/operation-getcustomersaccounts.md) - [Create a new customer](https://bump.sh/devs/doc/upcoming-release/operation/operation-createcustomer.md) - [Update a specific customer's information](https://bump.sh/devs/doc/upcoming-release/operation/operation-updatecustomer.md) - [Update a card for an existing customer on an account](https://bump.sh/devs/doc/upcoming-release/operation/operation-updatecustomeraccountcard.md) - [Create a new card for an existing customer on an account](https://bump.sh/devs/doc/upcoming-release/operation/operation-createcustomeraccountcard.md) ### [accounts](https://bump.sh/devs/doc/upcoming-release/group/endpoint-accounts.md) - [Create a new account](https://bump.sh/devs/doc/upcoming-release/operation/operation-createaccount.md) - [Get a specific Account](https://bump.sh/devs/doc/upcoming-release/operation/operation-getaccount.md) - [Soft-delete a Specific Account](https://bump.sh/devs/doc/upcoming-release/operation/operation-softdeleteaccount.md) - [Edit the payment processor config for an existing account](https://bump.sh/devs/doc/upcoming-release/operation/operation-editaccountpaymentprocessorconfig.md) - [Get a list of temporary promos for a specific account](https://bump.sh/devs/doc/upcoming-release/operation/operation-getaccounttemppromos.md) - [Create a temporary promotion for an account.](https://bump.sh/devs/doc/upcoming-release/operation/operation-createaccounttemppromo.md) ### [line_items](https://bump.sh/devs/doc/upcoming-release/group/endpoint-line_items.md) - [Get line items for a specific account.](https://bump.sh/devs/doc/upcoming-release/operation/operation-getaccountlineitems.md) - [Get information on a specific line item for a specific account](https://bump.sh/devs/doc/upcoming-release/operation/operation-getaccountlineitem.md) - [Change the status of an existing line item](https://bump.sh/devs/doc/upcoming-release/operation/operation-editlineitemstatus.md) - [Create a charge for a specific account](https://bump.sh/devs/doc/upcoming-release/operation/operation-createaccountcharge.md) - [Execute a payment attempt for a specific account](https://bump.sh/devs/doc/upcoming-release/operation/operation-createaccountpaymenttransfer.md) - [Create a payment record for a specific account](https://bump.sh/devs/doc/upcoming-release/operation/operation-createaccountpaymentrecord.md) - [Execute a payment attempt for a specific account](https://bump.sh/devs/doc/upcoming-release/operation/operation-createaccountpaymenttransfer.md) - [Increase the balance of a specific account with a credit offset](https://bump.sh/devs/doc/upcoming-release/operation/operation-createaccountcreditoffset.md) - [Decrease the balance of a specific account with a debit offset](https://bump.sh/devs/doc/upcoming-release/operation/operation-createaccountdebitoffset.md) - [Create a manual fee for a specific account](https://bump.sh/devs/doc/upcoming-release/operation/operation-createaccountmanualfee.md) - [Create a refund for a specific account](https://bump.sh/devs/doc/upcoming-release/operation/operation-createaccountrefund.md) - [Reverses a payment for an account](https://bump.sh/devs/doc/upcoming-release/operation/operation-createaccountpaymentreversal.md) - [Waives a fee for an account](https://bump.sh/devs/doc/upcoming-release/operation/operation-createaccountfeewaiver.md) - [Reverse a charge for an account](https://bump.sh/devs/doc/upcoming-release/operation/operation-createaccountchargereversal.md) ### [notes](https://bump.sh/devs/doc/upcoming-release/group/endpoint-notes.md) - [Get All Notes for a specific Account](https://bump.sh/devs/doc/upcoming-release/operation/operation-getnotes.md) - [Create a note for a specific account.](https://bump.sh/devs/doc/upcoming-release/operation/operation-createaccountnote.md) ### [statements](https://bump.sh/devs/doc/upcoming-release/group/endpoint-statements.md) - [Get a list of all current and prior statements for a specific account](https://bump.sh/devs/doc/upcoming-release/operation/operation-getaccountstatementslist.md) - [Get a specific statement for a specific account.](https://bump.sh/devs/doc/upcoming-release/operation/operation-getaccountstatement.md) ### [amortization_schedule](https://bump.sh/devs/doc/upcoming-release/group/endpoint-amortization_schedule.md) - [Get the amortization schedule for a specific loan](https://bump.sh/devs/doc/upcoming-release/operation/operation-getamortizationschedule.md) ### [event_subscriptions](https://bump.sh/devs/doc/upcoming-release/group/endpoint-event_subscriptions.md) - [Subscribe to event triggers from Canopy. ](https://bump.sh/devs/doc/upcoming-release/operation/operation-subscribetoevents.md) ### [integrations](https://bump.sh/devs/doc/upcoming-release/group/endpoint-integrations.md) - [Configure payment processor information for your organization](https://bump.sh/devs/doc/upcoming-release/operation/operation-configureorgpaymentprocessors.md) - [Configure issuer processor information for your organization](https://bump.sh/devs/doc/upcoming-release/operation/operation-configureissuerprocessors.md) - [Update an organization's Plaid client credentials.](https://bump.sh/devs/doc/upcoming-release/operation/operation-updateorganizationplaidconfig.md) ### [data_migrations](https://bump.sh/devs/doc/upcoming-release/group/endpoint-data_migrations.md) - [Toggle Migration Mode for a product](https://bump.sh/devs/doc/upcoming-release/operation/operation-togglemigrationmode.md) ### [payout_entities](https://bump.sh/devs/doc/upcoming-release/group/endpoint-payout_entities.md) - [Get all payout entities](https://bump.sh/devs/doc/upcoming-release/operation/operation-getpayoutentities.md) - [Create a new payout entity](https://bump.sh/devs/doc/upcoming-release/operation/operation-createpayoutentity.md) ### [credit_reporting](https://bump.sh/devs/doc/upcoming-release/group/endpoint-credit_reporting.md) - [Get a list of all current and Metro2 credit reports for a specific account](https://bump.sh/devs/doc/upcoming-release/operation/operation-getaccountcreditreportslist.md) - [Get a specific Metro2 credit report for a specific account.](https://bump.sh/devs/doc/upcoming-release/operation/operation-getaccountcreditreport.md) ### [audit_trails](https://bump.sh/devs/doc/upcoming-release/group/endpoint-audit_trails.md) - [Get the history of account status changes for a specific account.](https://bump.sh/devs/doc/upcoming-release/operation/operation-getaccountstatusaudittrail.md) ### [organization](https://bump.sh/devs/doc/upcoming-release/group/endpoint-organization.md) - [Get organization configuration](https://bump.sh/devs/doc/upcoming-release/operation/operation-getorganization.md) - [Test your webhook URL.](https://bump.sh/devs/doc/upcoming-release/operation/operation-subscribetoeventstest.md) - [Configure credit reporting details for your organization](https://bump.sh/devs/doc/upcoming-release/operation/operation-configurecreditreporting.md) - [Update the organization's address](https://bump.sh/devs/doc/upcoming-release/operation/operation-updateorganizationaddress.md) [Powered by Bump.sh](https://bump.sh)