docs/
465 pages · Updated July 18, 2026
Pages
- Navigating CanopyOS
- Loan Tape
- Account Transcripts
- Loan Transactions Extract
- MultiLoan
- Past Due Report
- Line Item Types
- operation-updatecustomer
- operation-createcustomer
- account_delinquency*
- PDF Statement Generation
- CanopyOS
- Getting Started
- Connectors: Available Actions & Integrations
- Canopy Extending Support for Advances
- Introducing the new Installments OS Experience (Beta)
- Fee Structures
- Introducing Reconciliation in Canopy
- Update Line of Credit Transaction Interest Rate
- Quality of life improvements to Controlled Processing
- Data Direct Payoff Amounts and Unaccrued Interest Fields
- Uploaded Documents Now Persist Across Master Account, Originator, and Owner Orgs
- Organization-Level Access Controls
- New Calculation Endpoint for TILA Compliance
- Update to Data Direct's refresh logic
- Navigating CanopyOS
- Loan Tape
- Loans Overview
- LoanLab How-to Guide
- Reversals
- Webhooks
- Account Transcripts
- Loans Overview
- Core Concepts
- Downloadable Reports
- Getting Started Guides
- Recommended tools
- Transactions
- Borrower Portal How-to Guide
- Loan Restructuring
- Canopy Connect
- DataDirect
- Preview
- Transaction Reversals
- LoanLab FAQs
- Connect FAQs
- Interest
- Borrower Portal
- Connect Feedback Form
- Payment Deferrals
- Past Due Report
- Account Certified Time
- DataDirect Reporting
- Portfolio Analytics Dashboard
- Account Status
- Amortization Schedule
- Create a Customer
- Delinquency
- Integrations Set Up
- LoanLab
- Testing with Migration Mode
- Issuer Processor: Lithic
- Tags
- CanopyOS
- Create a Product
- Balance Splits
- Create an Account
- Delinquency Management
- Testing with Controlled Processing
- Integration Patterns
- Transaction Updates
- Getting Started Overview
- Customer Entities
- Data Dictionary
- Segmentation
- Payments
- Borrower Onboarding
- Welcome to Canopy
- Data Migrations
- Events System
- Minimum Payments
- Closed Account Statuses
- Transaction Types
- Testing
- Late Payments & Webhooks
- Credit Reporting: Bloomcredit
- Issuer Processor
- Product Set Up
- Policy Configurations
- Payment Pouring
- Document Sharing
- Payment Splits
- Payment Processor: Dwolla
- AutoPay
- Payment Processor
- Transaction Statuses
- Go-Live Checklist
- Credit Reporting
- Entities
- Accounts
- Refunds
- Associating Entities
- Statements
- Products
- Fundamentals Overview
- Treasury Entities
- Design Your Program
- Get all finance requests
- Update beneficial owner
- Create a notification configuration for a product or an account
- Update an existing finance request
- Get transactions for a specific account.
- Create a new customer
- List all accounts for a business
- Create a new finance request
- Create a new beneficial owner for the business
- Unsubscribe from event triggers from Canopy.
- Create notification configuration
- Get notification configurations
- Get a finance request
- Get webhook secret
- Get the transaction entry details of records contained in a NACHA file.
- Get all system applied tags for an account
- Replay dead letter queue events
- Configure nacha report details for your organization
- Replay dead letter queue events for a particular webhook
- Create a vanity domain.
- Transfer account ownership to a new organization
- Unsubscribe from event triggers from Canopy.
- Get all organizations
- Update the organization's address
- Gets the Data Direct allow list
- Update a specific customer's information
- list subscriptions
- Convert an approved finance request to an account
- Deletes CIDRs from the Data Direct allow list
- Initiates the restructuring of one or multiple loans
- Test your webhook URL.
- Get all customers
- Get the status of a vanity domain.
- Configure credit reporting details for your organization
- Get organization configuration
- Adds CIDRs to the Data Direct allow list
- Get beneficial owner for business
- get webhook subscription
- Add card
- Get balance splits for a specific transaction.
- Update an organization's Plaid client credentials.
- Get all vanity domains.
- Configure payment processor information for your organization
- Delete the beneficial owner
- Add a tag to the organization
- Configure issuer processor information for your organization
- List beneficial owners of a business
- Gets the Data Direct connection configuration
- Update a Tag option.
- Update Metro2 Configuration for a customer
- Get a specific customer
- Update card
- Calculate the amortization schedule for a specific loan
- Defer a loan's payment obligation
- Get a loan's due dates.
- Update an existing payout entity
- Get all tags for the organization
- Get all cards
- Retrieve all the loans of the account.
- Retrieve restructure details for the given loan.
- Create a new payout entity
- Retrieve a given loan by its line_item_id.
- Create a new account
- Get a specific transaction for a specific account.
- Get the history of account status changes for a specific account.
- Update account policies
- Get a specific Metro2 credit report for a specific account.
- Get an existing payout entity by ID
- Get a list of all current and prior statements for a specific account
- Create a payment record for a specific account
- Get the amortization schedule for an account across all loans
- Get a list of all current and Metro2 credit reports for a specific account
- Get All Notes for a specific Account
- Create a note for the specified entity.
- Get all payout entities
- Create a note for an account.
- Create a loan for a specific account
- Get a loan's amortization schedule
- Update interest rate record for an account during the given time period. Note that the interest_rate_id of the record will change.
- Request a presigned URL to upload a document
- Get a specific statement for a specific account.
- Request a presigned URL to download a document
- Apply a tags to an account
- Account's min_pay
- List existing documents for an account
- Edit the payment processor configuration
- Execute a payment attempt for a specific account
- Create a new product
- Edit account's external fields
- Get effective interest rate for an account during the given time period
- Create an interest rate record for an account during the given time period
- Update account status and substatus
- Get all tags for an account
- Increase the balance of a specific account with a credit offset
- Decrease the balance of a specific account with a debit offset
- Execute a payment attempt for a specific account
- Remove a tag from an account
- Get line items for a specific account.
- Execute a payment attempt for a specific account with arbitrary payment method
- Reverses a payment for an account
- Create a manual fee for a specific account
- Create a charge for a specific account
- Create a refund for a specific account
- Reverse a charge for an account
- Get the periodic payment due for a loan
- Soft-delete a Specific Account
- Get information on a specific line item for a specific account
- Update an existing line item
- Get min_pay fulfillments made by a specific line item for a specific account
- Get all available products
- Get a customer's product offering
- /filters
- Update Metro2 Configuration for a product
- Create a product offering
- Remove a product offering
- Toggle Migration Mode
- Register a new organization and user
- Get all API users in your organization
- Notifications
- Get summary info
- Add tag to the organization
- Create a line of credit template
- Update policies for a line of credit
- Update a tag option
- Create an advance template
- Create a new locale rule set
- Stripe webhook handler
- Get all system applied tags
- Get deferral policies for an installment loan.
- Update policies for multiple lines of credit
- Get all system applied tags associated with an account
- Get all tags for the organization
- Create an account template
- Get all templates for advance creation
- User Tags
- Create a new business borrower
- Get policies for a line of credit
- Get policies for a given account
- Get deferral policies for a line of credit.
- Create a new borrower
- Get all policy templates
- Get all templates for account creation
- Get all templates for line of credit creation
- Check health of the application (reader and writer DB endpoints)
- Get all locale rule sets
- Calculate APR and APY for a loan
- Get a locale rule set by ID
- Create a new account
- Calculate Nominal Interest Rate for a loan
- Policies
- Update external fields for an account
- Apply a tag to an account
- Get a paginated list of borrowers
- Get accounts
- Transfer account ownership to a new organization
- Gets the account details for a given account id
- Get an auth token
- Borrowers
- Accounts
- Account External Fields
- FirstData webhook handler
- Loan Transactions Extract
- Payoff
- Release Notes
- Fulfillment
- Principal Pre-Payments
- Get all accounts for all customers
- Subscribe to event triggers from Canopy.
- Schedule the update of an existing line item
- Invite a new API user to Canopy
- Organization-Level Access Controls
- Delete a vanity domain.
- Resend a new API user's temporary password
- Retreieve an individual product record based on product_id
- Get All Notes for a specific entity
- Get the adjustment amounts for a specific loan
- Update Metro2 Configuration for an account
- Deactivate a user
- Get a specific Account
- Introducing the new Installments OS Experience (Beta)
- Get the payoff amounts for an account
- Introducing Reconciliation in Canopy
- Canopy Extending Support for Advances
- Update Line of Credit Transaction Interest Rate
- Data Direct Payoff Amounts and Unaccrued Interest Fields
- Quality of life improvements to Controlled Processing
- New Calculation Endpoint for TILA Compliance
- Organization-Level Access Controls
- Get transactions for a line of credit promo
- Create an installment loan template
- Create a balance transfer for a line of credit
- Graduate a secured card line of credit to unsecured
- Create an offset for a line of credit
- Collaterals
- Get splits for an advance transaction
- Get splits related to a transaction for a line of credit
- Renew a card for a line of credit
- Defer past, current, or future payment schedule due amounts to later dates.
- Valuations
- Statements
- Get payoff amounts for a given account
- Create an advance for an account
- Get transactions for a line of credit
- Add a valuation to a collateral
- Transactions
- Get collaterals
- Create a lien
- Create a collateral
- Get a line of credit statement by id
- Get the Loan To Value ratio
- Substitute collaterals
- Create a promo configuration
- Release a collateral
- Get account advances
- List promo configurations
- Update the status of a card for a line of credit (freeze, unfreeze, cancel)
- Settle a transaction for a line of credit
- Reverse a draw on a line of credit
- Create a draw for a line of credit
- Verify a line of credit balance snapshot.
- Terminate a lien on a collateral
- Get a promo configuration
- List lines of credit for a promo configuration
- Create a refund for a line of credit
- Get statements for a line of credit
- Fees
- Capture a portion of an authorized draw
- Create a backdated draw for a line of credit
- Issue a card for a line of credit
- Update the status of a line of credit.
- Change the loan's interest rate.
- Get promos for a line of credit
- Creates a new installment loan.
- Offsets
- Get transactions for a loan
- Create a fee for a line of credit
- Adjust the balance of a transaction for a line of credit
- Return a collateral deposit
- Liens
- Create a payment for a line of credit
- Liquidate a collateral
- Get history of credit limit changes for a line of credit
- Create a backdated payment for a line of credit
- LTV
- Create an association between a collateral and a loan or a line of credit
- Get transaction for an advance
- Create a notification configuration for a product or an account
- Get a collateral by ID
- Defer past, current, or future payment schedule due amounts to later dates.
- Create a payment for an advance
- Get a loan statement by id
- Get the obligations for a line of credit
- Get a line of credit for an account
- Get an advance for an account
- Get a statement for an advance
- Get the payment schedule for an advance
- Get a card for a line of credit
- Get a transaction for a line of credit
- Draws
- Create a line of credit for an account
- Adjust the interest rate for a line of credit.
- Get the minimum payment for an advance
- Get cards for a line of credit
- Get the due dates for a line of credit
- Get the status history of a line of credit.
- Adjust the interest rate for a transaction
- Update transaction metadata
- Update transaction dispute status
- Get an installment loan's payment schedule.
- Reversals
- Post an MLA adjustment to an installment loan.
- Adjust credit limit for a line of credit
- Get statements for a loan
- Disable the notification configurations that match the provided filters
- Get the available credit for a line of credit
- Refunds
- Adjust the interest rate for a line of credit
- Payments
- Adds CIDRs to the Data Direct allow list
- Get the minimum payment for a line of credit
- Adjust the interest rate for a line of credit.
- Lines of Credit
- Get notifications
- Post an SCRA adjustment to an installment loan.
- Get an installment loan by loan_id.
- Get a transaction for a loan
- Get the payment schedule due dates for a loan.
- Get the installment loans for an account.
- Get the periodic payment due for a loan.
- Gets the Data Direct allow list
- Gets the Data Direct connection configuration
- Deletes CIDRs from the Data Direct allow list
- Installment Loans
- Get available notification configurations
- Get all organizations
- Get all tags associated with an account
- Get all templates for installment loan creation
- Remove a tag from an account
- Get a policy template by ID
- Statuses
- Update to Data Direct's refresh logic
- Uploaded Documents Now Persist Across Master Account, Originator, and Owner Orgs
- MLA/SCRA
- Canopy Connect
- Delinquency Report
- Recommended tools
- Handling Delinquency
- DataDirect
- Release Notes
- Reports
- Get paginated transactions for an advance
- Get all line of credits for an account
- Policy Updates
- Deferrals
- Loan Origination and Activation
- Tags
- Attach a promo configuration to a line of credit
- Reconciliation
- Policies
- Getting Started Guides
- Locale Rule Sets
- Secured Lending
- Liens
- Retroactivity
- Complex Authorization Scenarios
- Connect Feedback Form
- Get usage information for a specific policy template
- Delinquency Management
- Connect FAQs
- Interest Calculations
- Lines of Credit
- Policy Framework
- Installment Loans
- Getting Started
- Card Management
- Transactions
- Testing with Event Processing
- Connectors: Available Actions & Integrations
- Notifications
- Segmentation
- The Future of Lending
- Advances
- Authorization Flows
- Provisional Credit
- Payment Pouring
- Accounts
- Templates
- Active Disputes
- Cards
- Draws
- docs
- Auth
- Testing
- Interest Grace Periods for Credit Cards
- Core Workflows
- Core Concepts
- Risk Mitigation
- Lending, Reinvented