Create facility

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

loan_agreement_id

string

required

The loan_agreement_id of the loan agreement to create a facility for

Response

200

application/json

id

string

required

application_id

string

required

The application_id of the corresponding loan application for the facility

borrower_id

string

required

The borrower_id of the corresponding borrower the facility is for

loan_agreement_id

string

required

The loan_agreement_id of the corresponding loan agreement the facility is for

Example:

"doc_234259b117854d0194bc5864a6c45b42"

credit_type

enum<string>

required

The type of credit production.

Available options:

installment_loan,

revolving_line_of_credit,

closed_line_of_credit

created_on

string

required

Timestamp the loan agreement object is created on

Example:

"2023-01-17T04:59:21.773Z"

status

enum<string>

required

The status of the facility.

Available options:

active,

closed

terms

object

required

An object containing a summary of the terms of the facility.

• Option 1
• Option 2

Show child attributes

terms.amount

integer

required

The amount (in cents) of the credit line offer (e.g. '200000' for $2,000.00)

terms.apr

integer

required

The apr (in basis points) of the credit line offer (e.g. '750' for 7.50%)

terms.annual_fee

integer

required

The annual fee charged for the credit line (e.g. '5000' for $50.00)

terms.billing_cycle

integer

required

The time in days between the last statement's closing date and the next statement's closing date. For consumer lines of credit, the minimum is '21'

terms.grace_period

integer

required

The time in days between the end of a billing cycle and the bill's due date. For consumer lines of credit, the minimum is '21'

terms.interest_rate

integer

required

The interest rate (in basis points) of the loan or credit line offer (e.g. '750' for 7.50%)

terms.late_payment_fee

integer

required

The fee charged if a borrower misses the payment due date, in cents (e.g. '2500' for $25.00)

terms.origination_fee

integer

required

The origination fee charged to originate the line in cents (e.g. '20000' for $200)

terms.term

integer

required

The term of the line in months

terms.finance_charge

integer

If your platform charges a monthly finance charge for access to the line, the amount in cents

terms.grace_period_interest_rate

integer

The interest rate (in basis points) charged during the grace period. Must be '0' for consumer lines of credit. Defaults to 0 if omitted

terms.introductory_offer_interest_rate

integer

If you offer an introductory period with a reduced interest rate, the interest rate in basis points

terms.introductory_offer_interest_rate_term

integer

If you offer an introductory period with a reduced interest rate, the term in months

terms.type

enum<string>

Available options:

line_of_credit