Jump to Content
Guides
API Reference
Release Notes
Log In
API Reference
Log In
Guides
API Reference
Release Notes
Add a tag to the organization
All
Pages
Start typing to search…
JUMP TO
Canopy Servicing Core API - Latest
API Users
Invite a new API user to Canopy
post
Get all API users in your organization
get
Register a new organization and user
post
Deactivate a user
post
Resend a new API user's temporary password
post
Get summary info
get
Documents
Request a presigned URL to upload a document
get
Request a presigned URL to download a document
get
List existing documents for an account
get
Transactions
Get transactions for a specific account.
get
Get a specific transaction for a specific account.
get
Get balance splits for a specific transaction.
get
Loans
Retrieve all the loans of the account.
get
Retrieve a given loan by its line_item_id.
get
Initiates the restructuring of one or multiple loans
post
Retrieve restructure details for the given loan.
get
Get the adjustment amounts for a specific loan
get
Get a loan's due dates.
get
Defer a loan's payment obligation
post
Tags
Get all tags for the organization
get
Add a tag to the organization
post
Update a Tag option.
patch
Notifications
Create a notification configuration for a product or an account
post
Accounts
Get all system applied tags for an account
get
Accounts
Transfer account ownership to a new organization
post
Organization
Get all organizations
get
Gets the Data Direct connection configuration
get
Gets the Data Direct allow list
get
Adds CIDRs to the Data Direct allow list
post
Deletes CIDRs from the Data Direct allow list
del
Products
Products
Create a new product
post
Get all available products
get
Retreieve an individual product record based on product_id
get
Update Metro2 Configuration for a product
put
/filters
get
Create a product offering
post
Get a customer's product offering
get
Remove a product offering
del
Data Migrations
Toggle Migration Mode
put
Accounts
Accounts
Create a new account
post
Get a specific Account
get
Soft-delete a Specific Account
del
Edit the payment processor configuration
put
Update account status and substatus
put
Get all tags for an account
get
Apply a tags to an account
post
Remove a tag from an account
del
Update account policies
put
Update interest rate record for an account during the given time period. Note that the interest_rate_id of the record will change.
put
Create an interest rate record for an account during the given time period
post
Get effective interest rate for an account during the given time period
get
Update Metro2 Configuration for an account
put
Edit account's external fields
put
Account's min_pay
get
Line Items
Get line items for a specific account.
get
Get information on a specific line item for a specific account
get
Update an existing line item
put
Get min_pay fulfillments made by a specific line item for a specific account
get
Schedule the update of an existing line item
put
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
post
Execute a payment attempt for a specific account
post
Execute a payment attempt for a specific account with arbitrary payment method
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
Reverse a charge for an account
post
Notes
Create a note for an account.
post
Get All Notes for a specific Account
get
Create a note for the specified entity.
post
Get All Notes for a specific entity
get
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 a loan's amortization schedule
get
Get the amortization schedule for an account across all loans
get
Get the payoff amounts for an account
get
Calculate the amortization schedule for a specific loan
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
Payout Entities
Get all payout entities
get
Create a new payout entity
post
Get an existing payout entity by ID
get
Update an existing payout entity
put
Issuing
Add card
post
Update card
put
Get all cards
get
Audit Trails
Get the history of account status changes for a specific account.
get
Customers
Customers
Update Metro2 Configuration for a customer
put
Get all accounts for all customers
get
Create a new customer
post
Get all customers
get
Get a specific customer
get
Update a specific customer's information
put
List all accounts for a business
get
List beneficial owners of a business
get
Create a new beneficial owner for the business
post
Get beneficial owner for business
get
Update beneficial owner
put
Delete the beneficial owner
del
Organization
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
Configuration
Create a vanity domain.
post
Get all vanity domains.
get
Get the status of a vanity domain.
get
Delete a vanity domain.
del
Organization
Get organization configuration
get
list subscriptions
get
get webhook subscription
get
Test your webhook URL.
get
Configure credit reporting details for your organization
put
Configure nacha report details for your organization
put
Update the organization's address
put
Finance Requests
Finance Requests
Get all finance requests
get
Create a new finance request
post
Get a finance request
get
Update an existing finance request
put
Convert an approved finance request to an account
post
Reporting
Nacha
Get the transaction entry details of records contained in a NACHA file.
get
Webhooks
Webhooks
Create notification configuration
put
Subscribe to event triggers from Canopy.
put
Unsubscribe from event triggers from Canopy.
put
Unsubscribe from event triggers from Canopy.
put
Replay dead letter queue events for a particular webhook
put
Get webhook secret
get
Replay dead letter queue events
put
Powered by
Add a tag to the organization
post
https://Contact sales to enable your sandbox/tags
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
OAuth2
Bearer
URL
Base URL
https://Contact sales to enable your sandbox
/tags
Response
Click
Try It!
to start a request and see the response here!