Skip to main content
GET
/
facilities
List all facilities
curl --request GET \
  --url https://production.pier-finance.com/api/facilities \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "terms": {
      "type": "line_of_credit",
      "amount": 1000000,
      "apr": 0,
      "annual_fee": 0,
      "billing_cycle": 30,
      "finance_charge": 0,
      "grace_period": 21,
      "grace_period_interest_rate": 0,
      "interest_rate": 0,
      "late_payment_fee": 0,
      "origination_fee": 0,
      "term": 24
    },
    "id": "fac_7264c6575a894548a386939434b0adf3",
    "application_id": "app_ad1564ffb1d745f9ad482bb5182708e2",
    "borrower_id": "bor_d965bea9f47a4b108562642dbb1dae9f",
    "loan_agreement_id": "doc_234259b117854d0194bc5864a6c45b42",
    "credit_type": "revolving_line_of_credit",
    "status": "active",
    "created_on": "2023-01-17T04:59:21.773Z"
  }
]

Authorizations

​
Authorization
string
header
required

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

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<date-time>
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
⌘I