Canopy API - Latest logo

Canopy API Documentation hub
  • Canopy API - Latest
  • legacy
  • Upcoming Release

Back to hub page

  • API Changelog

Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification

Topics

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

Endpoints

  • API Users
    • GET
      Get all API users in your organization
    • POST
      Invite a new API user to Canopy
    • POST
      Register a new organization and user
    • POST
      Resend a new API user's temporary password
    • GET
      Get summary info
  • Products
    • GET
      Get all available products
    • POST
      Create a new product
    • PUT
      Update Metro2 Configuration for a product
    • GET
      Get all filter values for all endpoints that allow filtering
    • GET
      Get a customer's product offering
    • POST
      Create a product offering
    • DELETE
      Remove a product offering
  • Customers
    • GET
      Get all customers
    • POST
      Create a new customer
    • GET
      Get a specific customer
    • PUT
      Update a specific customer's information
    • PUT
      Update Metro2 Configuration for a customer
    • GET
      Get all accounts for all customers
    • GET
      List all accounts for a business
    • GET
      List beneficial owners of a business
    • POST
      Create a new beneficial owner for the business
    • GET
      Get beneficial owner for business
    • PUT
      Update beneficial owner
    • DELETE
      Delete the beneficial owner
  • Accounts
    • POST
      Create a new account
    • GET
      Get a specific Account
    • DELETE
      Soft-delete a Specific Account
    • PUT
      Edit the payment processor configuration
    • PUT
      Update account status and substatus
    • GET
      Get a list of temporary promos for a specific account
    • POST
      Create a temporary promotion for an account.
    • PUT
      Update account policies
    • GET
      Get effective interest rate for an account during the given time period
    • PUT
      Update interest rate record for an account during the given time period. Note that the interest_rate_id of the record will change.
    • POST
      Create an interest rate record for an account during the given time period
    • PUT
      Update Metro2 Configuration for an account
  • Line Items
    • PUT
      Update an existing line item
    • PUT
      Schedule the update of an existing line item
    • POST
      Create a charge for a specific account
    • POST
      Create a loan for a specific account
    • POST
      Execute a payment attempt for a specific account
    • POST
      Create a payment record for a specific account
    • GET
      Get line items for a specific account.
    • GET
      Get information on a specific line item for a specific account
    • POST
      Increase the balance of a specific account with a credit offset
    • POST
      Execute a payment attempt for a specific account
    • POST
      Execute a payment attempt for a specific account with arbitrary payment method
    • 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
      Schedules the refinancing of a loan
  • Credit Reporting
    • GET
      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.
  • Payout Entities
    • GET
      Get all payout entities
    • POST
      Create a new payout entity
    • PUT
      Update an existing payout entity
  • Finance Requests
    • GET
      Get all finance requests
    • POST
      Create a new finance request
    • GET
      Get a finance request
    • PUT
      Update an existing finance request
    • POST
      Convert an approved finance request to an account
  • Notes
    • GET
      Get All Notes for a specific Account
    • POST
      Create a note for an account.
    • GET
      Get All Notes for a specific entity
    • POST
      Create a note for the specified entity.
  • Statements
    • GET
      Get a list of all current and prior statements for a specific account
    • GET
      Get a specific statement for a specific account.
  • Amortization Schedule
    • GET
      Get the amortization schedule for a specific loan
    • POST
      Calculate the amortization schedule for a specific loan
  • Webhooks
    • PUT
      Subscribe to event triggers from Canopy.
  • Integrations
    • PUT
      Configure issuer processor information for your organization
    • PUT
      Update an organization's Plaid client credentials.
    • PUT
      Configure payment processor information for your organization
  • Configuration
    • GET
      Get all vanity domains.
    • POST
      Create a vanity domain.
    • GET
      Get the status of a vanity domain.
    • DELETE
      Delete a vanity domain.
  • Data Migrations
    • PUT
      Toggle Migration Mode
  • Issuing
    • GET
      Get all cards
    • PUT
      Update card
    • POST
      Add card
  • Audit Trails
    • GET
      Get the history of account status changes for a specific account.
  • Organization
    • GET
      Get organization configuration
    • GET
      Test your webhook URL.
    • PUT
      Configure credit reporting details for your organization
    • PUT
      Configure nacha report details for your organization
    • PUT
      Update the organization's address
  • Nacha
    • GET
      Get the transaction entry details of records contained in a NACHA file.
Powered by Bump.sh

Issuing