Integrations Set Up

How to get 3rd party systems working with Canopy

Integrations Set Up



We recommend that you get yourself familiar with Integration Patterns for an overview of how our integrations work before jumping into implementation details.

Before You Start

A pre-requisite for each low-code integration made by Canopy is that you already have the 3rd party app keys available. We would need them to call the external system on your behalf. Those can usually be obtained by registering your organization with the 3rd party, and taking note of your account details once onboarded.

There are 3 core integration categories required to launch on Canopy:

  • Payment Processor
  • Issuer Processor (for card-based programmes)
  • Credit Reporting

Fortunately, we've made it so that integrating each follows a simple 2-step pattern:

  1. Pass the integration keys at the Organization level
  2. Add additional information at Customer/ Account level to link Borrower records between 2 systems

Step 1: Configure integration at the Organization level

Once you have 3rd party app keys, you can make a single API call to Canopy. Based on the integration category you are looking for, it might be any of the following endpoints:

Payment Processors
API reference

Issuer Processors
API reference

Credit Reporting
API reference


What does it mean to pass 3rd party app keys?

If Canopy already supports the app integration (i.e. it's mentioned in our documentation),
then our System-of-Record would call the 3rd party on your behalf.
e.g. to make a payment via Dwolla

Step 2. Pass additional info at the Account / Customer level

This step is to make sure that records of your borrowers are connected and recognised between systems. Hence, it would require that you pass some additional information (e.g. payment method per payment processor) at Canopy's Accounts or Customers level (depending on specific integration).

You can include those details as part of a POST request (at creation) or via a PUT request (to make changes to an onboarded Account/Customer).


Borrower-specific configuration

This step is usually automated and completed during Borrower onboarding

Here are examples of PUT requests from our documentation for borrower-specific configuration:

Individual Integration Guides

We've written set up guides for our most common core integrations. Follow the steps in the articles below

We will be looking to add step-by-step guides for each integration to our documentation in the short-medium term. Please let us know if you would like support with setting up integrations so that we can prioritize writing out the most relevant pages for you!

Related Articles