Create a facility

post https://production.pier-finance.com/api/facilities

A facility can be created for a given loan agreement with a status of signed

Responses

Response body

object

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

credit_type

string

required

The type of credit production.

consumer_installment_loan consumer_bnpl consumer_revolving_line_of_credit consumer_closed_line_of_credit consumer_secured_installment_loan consumer_secured_revolving_line_of_credit commercial_installment_loan commercial_revolving_line_of_credit commercial_closed_line_of_credit commercial_bnpl commercial_merchant_advance

created_on

date-time

required

Timestamp the loan agreement object is created on

status

string

required

The status of the facility.

active closed

account_number

string

required

The account number of the credit facility

amortization_schedule

array of objects | null

The amortization schedule of the loan

AmmortizationSchedules

object

payment_date

string

required

The date of this payment in the schedule

interest_payment_amount

integer

required

The amount in cents of the payment going towards interest (e.g. 0 is $0.00)

principal_payment_amount

integer

required

The amount in cents of the payment going towards principal (e.g. 8333 is $83.33)

other_payment_amount

integer

required

Any other payments in cents to be made (e.g. 0 is $0.00)

total_payment_amount

integer

required

The total payment in cents to be made comprised of all of the other payment amount fields (e.g. 8333 is $83.33)

balance_amount

integer

required

The balance in cents that is left after making the total_payment_amount (e.g. 91667 is $916.67)

item_index

integer

required

The number representing the order of the item in the list (one based)

repayment_bank_details

object | null

The bank account information used to repay the loan

bank_account_number

string

required

The bank account number to use for scheduled payments

bank_routing_number

string

required

The bank routing number to use for scheduled payments

type

string

required

The type of bank account, either checking or savings

checking savings

transactions

array of objects

required

An array of transactions made (empty if no payments are due)

FacilityTransactionItems*

object

amount

integer

required

The amount of the transaction, in cents (e.g. 1000 = $10.00)

net_amount

integer

required

The net amount of the transaction, meaning positive or negative depending on the effect on the ledger, in cents (e.g. 1000 = $10.00)

transaction_date

string

required

The date of the transaction (YYYY-MM-DD)

effective_date

string

required

The effective date of the transaction (YYYY-MM-DD)

description

string

required

A description of the transaction

transaction_type

string

required

The type of transaction relative to the effect on the balance (CREDIT = balance decrease; DEBIT = balance increase; NONE = no balance change)

NONE CREDIT DEBIT

transaction_iso_timestamp

date-time

required

The ISO timestamp of the transaction

statements

array of objects

required

An array of statements for the loan (empty if no statements exist)

statements*

object

string

required

The id of the statement

statement_date

string

required

The end date of the statement (YYYY-MM-DD)

statement_start_date

date-time

required

The start date of the statement (YYYY-MM-DD)

balance_due

integer

required

The balance due at the time of statement creation, in cents

current_principal_balance

integer

required

The principal balance of the statement, in cents

current_interest_balance

integer

required

The interest balance of the statement, in cents

interest_charged

integer

required

The interest balance of the statement, in cents

due_date

string

required

The due date of the statement (YYYY-MM-DD)

transactions

array of objects

required

An array of transactions made (scoped to the period of the statement)

FacilityTransactionItems*

object

amount

integer

required

The amount of the transaction, in cents (e.g. 1000 = $10.00)

net_amount

integer

required

The net amount of the transaction, meaning positive or negative depending on the effect on the ledger, in cents (e.g. 1000 = $10.00)

transaction_date

string

required

The date of the transaction (YYYY-MM-DD)

effective_date

string

required

The effective date of the transaction (YYYY-MM-DD)

description

string

required

A description of the transaction

transaction_type

string

required

The type of transaction relative to the effect on the balance (CREDIT = balance decrease; DEBIT = balance increase; NONE = no balance change)

NONE CREDIT DEBIT

transaction_iso_timestamp

date-time

required

The ISO timestamp of the transaction

payments

array of objects

required

An array of payments made (scoped to the period of the statement)

payments*

object

string

required

amount

integer

required

The amount of the payment, in cents

facility_id

string

required

The facility_id of the credit facility to make a payment for

status

string

required

The status of the payment

pending processing processed settled failed cancelled

transfer_type

string

required

The type of ACH transfer

standard none refund credit cancellation suspense_credit

created_on

date-time

required

Timestamp the payment is created on

failure_reason

string | null

A reason for the failure if one exists

is_autopay

boolean | null

If the payment was a result of an autopay

disbursements

array of objects

required

An array of disbursements made (scoped to the period of the statement)

disbursements*

object

string

required

The id of the disbursement

facility_id

string

required

amount

integer

required

The amount of the disbursement, in cents (e.g. 1000 = $10.00)

status

string

required

The status of the disbursement

pending processing processed settled failed cancelled

failure_reason

string | null

A reason for the failure if any exists

date

string | null

The date of the disbursement (YYYY-MM-DD)

created_on

date-time

required

Timestamp the disbursement object is created on

transfer_type

string

required

The type of transfer that the disbursement was (ACH, ledger only, or special cases like refunds)

standard none refund cancellation suspense_refund

facility_id

string

required

url

string

required

The url of the statement pdf

created_on

date-time

required

Timestamp the statement object is created on

balance

integer | null

The remaining balance of the loan, in cents

balances

object

required

A deeper view of what makes up the facility balance, all in cents

current_balance

integer

required

The current balance of the loan, in cents (includes everything - principal, interest, fees, etc.)

principal_balance

integer

required

The principal balance of the loan, in cents

interest_balance

integer

required

The interest balance of the loan, in cents

payoff_balance

integer

required

The payoff balance of the loan, in cents (if the facility is in grace then this balance is only principal; otherwise it matches current_balance)

interest_balance

integer | null

The current interest balance of the loan, in cents (deprecated - see balances field)

payoff_balance

integer | null

The current payoff balance of the loan, in cents (deprecated - see balances field)

origination_date

string | null

The date the loan was originated (YYYY-MM-DD)

disbursement_date

string | null

The date the loan was disbursed (YYYY-MM-DD)

remaining_term

integer | null

The remaining term of the loan, in months

payments_due

array of objects

required

An array of payments due (empty if no payments are due)

PaymentsDue*

object

payment_amount

integer

required

The amount of the payment, in cents (e.g. 1000 = $10.00)

payment_amount_remaining

integer

required

The amount of the payment remaining, in cents (e.g. 1000 = $10.00)

payment_due_date

string

required

The date the payment is due (YYYY-MM-DD)

next_payment_amount

integer | null

The amount of the next payment, in cents

next_payment_due_date

string | null

The date the next payment is due (YYYY-MM-DD)

current_payment_due_date

string | null

The date the current payment is due (YYYY-MM-DD)

last_payment_date

string | null

The date the last payment was made (YYYY-MM-DD)

principal_paid_thru

string | null

The date the principal is paid through (YYYY-MM-DD)

next_billing_date

string | null

The next billing date of the loan (YYYY-MM-DD)

interest_accrued_thru

string | null

The date the interest is accrued through (YYYY-MM-DD)

next_accrual_cutoff_date

string | null

The next accrual cutoff date of the loan (YYYY-MM-DD)

scheduled_payoff_date

string | null

The scheduled payoff date of the loan (YYYY-MM-DD)

terms

required

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

autopay

object | null

Whether or not autopay is enabled for the facility.

authorized

boolean

required

a bollean indicating whether autopay is authorized

authorization_timestamp

date-time | null

the timestamp when autopay was authorized

bank_account

object | null

amount_type

string | null

the type of autopay amount, either minimum_payment or statement_balance

minimum_payment statement_balance

additional_amount

integer | null

the additional amount to be paid on top of the minimum payment, in cents

documents

object | null

The documents associated with the facility

unsigned_credit_agreement

object | null

The URL and ID for the unsigned credit agreement document.

signed_credit_agreement

object | null

The URL and ID for the signed credit agreement document.

unsigned_ach_authorization

object | null

The URL and ID for the unsigned ACH authorization document.

unsigned_autopay_ach_authorization

object | null

The URL and ID for the unsigned autopay ACH authorization document.

signed_ach_authorization

object | null

The URL and ID for the signed ACH authorization document.

signed_autopay_ach_authorization

object | null

The URL and ID for the signed autopay ACH authorization document.

remaining_statement_balance

integer

required

The amount, in cents, of the last statement balance, less any payments made after the statement was created. Will be set to null until first statement is created.

remaining_minimum_balance

integer

required

The minimum due, in cents, of the last statement minimum, less any payments made since the statement was created. Will be set to null until first statement is created.

last_statement_info

object | null

The last statement information including date/amount.

last_statement_date

string

required

The date of the last statement (2024-06-01T00:00:00.000Z)

last_statement_amount

integer

required

The amount of the last statement, in cents

in_grace_period

boolean | null

Whether the facility is in a grace period

in_introductory_promo_period

boolean | null

Whether the facility is in an introductory promotional period

429

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://production.pier-finance.com/api/facilities \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200

400

401

403

404

500