URL Expired

The URL for this request expired after 30 days.

account_id
string
required
ID of the Account

Body of request to create a loan

line_item_id
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.

line_item_status
string
enum
Defaults to VALID
The status of a line item.
VALID, INVALID, OFFSET, PENDING, AUTHORIZED, DECLINED, VOID, POSTED
Show 8 enum values

original_amount_cents
integer
required
Defaults to 0
The amount charged (in cents).

interest_policies
object | null
Policies for interest on this specific line item.

effective_at
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.

min_pay_type
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: AM, AM_INTEREST

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

description
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

external_fields
array,null | object,null

Preview
boolean
Flag to decide if this is a preview
true, false

HTTP Response Codes

200      Loan Created
303      See Other.
401      Unauthorized.
403      Forbidden.
422      Invalid input
429      Too many requests.
default  Unexpected Error.

Updated about 1 year ago

Example Request

curl --request POST \
    --url https://contact/%20sales%20to%20enable%20your%20sandbox/accounts//line_items/loans \
    --header 'accept: application/json' \ 
    --header 'content-type: application/json' \ 
    --data '  
{  
  "line_item_status": "VALID",  
  "original_amount_cents": 0,  
  "interest_policies": {  
    "interest_percent": 0,  
    "is_limited_to_loan_duration": false  
  },  
  "fee_policies": {  
    "origination_fee_cents": 0,  
    "origination_fee_percent": 0,  
    "is_origination_fee_lesser_value": false  
  }  
}
'  

Try It! to start a request and see the response here! Or choose an example:

Application/JSON

200
303