Create a loan for a specific account

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

ID of the Account

Body Params

Body of request to create a loan

string
^(?!can_).*$

The ID associated to be with the line item for future requests. If not provided on line item creation, Canopy will generate this field.

string
enum
Defaults to VALID

The status of a line item.

integer
required
Defaults to 0

The amount charged (in cents).

interest_policies
object | null

Policies for interest on this specific line item.

date-time

The Date-Time that the charge is made applicable to the account. Note that loans always follow the statement cycle of the related account, meaning the first cycle will become due at the time of the statement most closely following this effective_at.

string | null
enum

Only applicable to LOAN type line_items. Optionally override the min_pay_type for this loan. For the minimum payment to include principal and interest each cycle, use AM. For the minimum payment to include only accrued interest for all cycles except the final cycle, and all principal and accrued interest in the final cycle, use AM_INTEREST. If not included, the loan will use the Account's min_pay_type value.

Allowed:
integer
required

For amortizing line items (loans), the number of cycles over which the line item amortizes.

string

A description for the Loan

fee_policies
object | null

Policies for an origination fee related to this loan

merchant_data
object | null
issuer_processor_metadata
object
array,null | object,null
Headers
boolean

Flag to decide if this is a preview

Responses

401

Unauthorized.

403

Forbidden.

422

Invalid input

429

Too many requests.

default

Unexpected Error.

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