Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Upcoming Release

Topics

  • Introduction
  • Getting Started
  • Authentication
  • Troubleshooting
  • Test it out
  • Pagination
  • Document Versioning

Endpoints

  • api_users
    • Get all API users in your organization GET
    • Invite a new API user to Canopy POST
    • Register a new organization and user POST
    • Get summary info for an API user GET
  • products
    • Get all available products GET
    • Create a new product POST
  • customers
    • Get all accounts for all customers GET
    • Create a new customer POST
    • Update a specific customer's information PUT
    • Update a card for an existing customer on an account PUT
    • Create a new card for an existing customer on an account POST
  • accounts
    • Create a new account POST
    • Get a specific Account GET
    • Soft-delete a Specific Account DELETE
    • Edit the payment processor config for an existing account PUT
    • Get a list of temporary promos for a specific account GET
    • Create a temporary promotion for an account. POST
  • line_items
    • Get line items for a specific account. GET
    • Get information on a specific line item for a specific account GET
    • Change the status of an existing line item PUT
    • Create a charge for a specific account POST
    • Execute a payment attempt for a specific account POST
    • Create a payment record for a specific account POST
    • Execute a payment attempt for a specific account POST
    • Increase the balance of a specific account with a credit offset POST
    • Decrease the balance of a specific account with a debit offset POST
    • Create a manual fee for a specific account POST
    • Create a refund for a specific account POST
    • Reverses a payment for an account POST
    • Waives a fee for an account POST
    • Reverse a charge for an account POST
  • notes
    • Get All Notes for a specific Account GET
    • Create a note for a specific account. POST
  • statements
    • Get a list of all current and prior statements for a specific account GET
    • Get a specific statement for a specific account. GET
  • amortization_schedule
    • Get the amortization schedule for a specific loan GET
  • event_subscriptions
    • Subscribe to event triggers from Canopy. PUT
  • integrations
    • Configure payment processor information for your organization PUT
    • Configure issuer processor information for your organization PUT
    • Update an organization's Plaid client credentials. PUT
  • data_migrations
    • Toggle Migration Mode for a product PUT
  • payout_entities
    • Get all payout entities GET
    • Create a new payout entity POST
  • credit_reporting
    • Get a list of all current and Metro2 credit reports for a specific account GET
    • Get a specific Metro2 credit report for a specific account. GET
  • audit_trails
    • Get the history of account status changes for a specific account. GET
  • organization
    • Get organization configuration GET
    • Test your webhook URL. GET
    • Configure credit reporting details for your organization PUT
    • Update the organization's address PUT
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Upcoming Release

Troubleshooting

View as Markdown

See a detailed overview of error codes supported by Canopy and their meanings.