API Reference

Create a new account

post
https://Contact sales to enable your sandbox/accounts

At least one account should be created for customer of each of your products. Once created, you will be able to add line_items to the account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create a new account

date-time

The Date-Time as of which this account is effective on the server.

string

This is the ID used to identify the account in your system. For most use-cases, we strongly recommend using the ID from the system the account was originally created in -- for most use-cases, this is created as part of the origination system that approves a borrower. This will be the account that is used to refer to the borrower for all subsequent requests. Note: both strings and integers are accepted.

string
required

The product ID that ties to the product onto which this account is being onboarded.

string

The ID used to identify the partner_entity with which to associate to this account

array,null | object,null
payment_processor_config
object
disbursements_config
object
payouts_config
object
cycle_type
object
discounts
object
summary
object
promo_overview
object
post_promo_overview
object
associated_entities
object

(to be depricated) -- use payout_entities instead to provide more granular detail.

plaid_config
object

Plaid configurations.

interest_management_policies
object
string

The name of the organization that is originating the account. If not provided, defaults to the calling user's organization name.

assign_customers
array of objects | null

Array of existing customer IDs to be added to the account. Canopy recommends assigning a customer to the account during account creation.

assign_customers
metro2_config
object

Metro2 credit reporting configs

Responses

401

Unauthorized.

403

Forbidden.

422

Invalid input

429

Too many requests.

default

Unexpected Error.

Updated about 1 year ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago