Overview
- The Canopy Lithic Integration allows Canopy to automatically wrap calls to the Lithic API when you use Canopy as normal.
- When a borrower is onboarded; Canopy will automatically create their corresponding card in Lithic
- When the borrower uses their card, Canopy will subscribe to the authorization request and handle authorization based on the available credit on the account.
- When transaction states change in Lithic, Canopy’s ledger will update those transaction states in sync.
- From your perspective:
- You set your Lithic API keys in Canopy
- You onboard borrowers into Canopy as normal per our core workflows
- When onboarding borrowers, you need to pass a few extra details necessary for card creation in Lithic
- You do not need to write any code to call
Create Chargeor update charge line items in Canopy; we will handle this by subscribing to Lithic’s webhooks - Canopy supports all Authorization and Settlement transaction types (such as Partial Authorization and Incremental Clearing) as well as Adjustment Events (such as Merchant Credits and Dispute Handling)
- Whenever an authorization request is processed by Canopy, our system creates the new line item and sets the Line Item Status as
AUTHORIZED. - (To better understand line item statuses in Canopy, check out this document )
- Updates to this authorization request are sent by Lithic and processed by Canopy, mapping the various transaction states in Lithic to internal Canopy line item statuses
- For example,
SETTLEDauthorizations map toVALIDline items in Canopy VOIDEDandEXPIREDto line itemVOIDDECLINEDtoDECLINED- Canopy supports all transaction types listed under
- Canopy automatically updates the transaction amount based on whatever was received from Lithic during settlement.
- Canopy is also able to perform a
CHARGE_REVERSALwhenever Lithic suggests the authorization needs to be reversed. - For example,
SETTLEDauthorizations map toVALIDline items in Canopy DECLINEDtoDECLINED
Technical:
There is only one easy step to getting the issuer-processor integration set up:
- To get started, Generate a set of API keys in the Lithic dashboard, and store these in Canopy by passing a
lithic_configto the PUT /organizations/issuer_processors endpoint in Canopy. Canopy is now equipped to communicate with Lithic on your behalf.
That’s it! - Your Lithic Integration is now running. You can use Canopy as normal.
On an ongoing basis, you may choose to modify the state of current cards, or create multiple cards for a customer. You may do so via our cards API.
Here’s what to expect now that your integration is set up:
- Accounts
- In all
Create AccountAPI requests to Canopy, you should now expect to see anissuer_processordetails andcardssection in the response - In the
Getrequests to all accounts, you should now see issuer_processor details and card details in the response
- Line Items
- In all line items created by the Lithic integration, you should see
issuer_processor_detailsincluded in theGetrequest that includes transaction data.
- Lithic Dashboard:
- You should see all cards created by Canopy, and all transactions in your Lithic Dashboard whenever customers use their cards.