---
title: "Retrieve a facility"
method: GET
path: "/facilities/{facility_id}"
tags: ["Facilities"]
---

# Retrieve a facility

`GET /facilities/{facility_id}`

## Request

- Base URL: `https://production.pier-finance.com/api`
- URL: `https://production.pier-finance.com/api/facilities/{facility_id}`
- Auth: HTTP bearer

Retrieve a facility by its id

## Path parameters

- `facility_id` string, required

## Response `200`

- Facility
  - `id` string, required
  - `application_id` string, required
  - `borrower_id` string, required
  - `loan_agreement_id` string, required: The `loan_agreement_id` of the corresponding loan agreement the facility is for
  - `credit_type` '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', required
  - `created_on` string, date-time, required: Timestamp the loan agreement object is created on
  - `status` 'active' | 'closed', required
  - `account_number` string, required: The account number of the credit facility
  - `amortization_schedule` AmortizationSchedule[]
    - `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` BankAccount
    - `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` 'checking' | 'savings', required
  - `transactions` FacilityTransactionItem[], required
    - `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
    - `category` 'DRAWER_RESERVE_PURCHASE_IN_FROM_RESERVE_BANK' | 'REVERSE_PURCHASE_IN_FROM_RESERVE_BANK' | 'CASH_DRAWER_SELL_OFF_FUNDS_OUT_TO_RESERVE' | 'REVERSE_SELL_OFF_FUNDS_OUT_TO_RESERVE' | 'CASH_DRAWER_RESERVE_BANK_DEPOSIT_OUT' | 'REVERSE_BANK_DEPOSIT_OUT' | 'CASH_DRAWER_RESERVE_RECONCILING_ERROR_CORRECTION' | 'REVERSE_RECONCILING_ERROR_CORRECTION' | 'TRUST_DEPOSIT' | 'REVERSE_TRUST_DEPOSIT' | 'TRUST_DISBURSEMENT' | 'REVERSE_TRUST_DISBURSEMENT' | 'TRUST_DISBURSEMENT_SERVICING_FEE' | 'REVERSE_TRUST_DISBURSEMENT_SERVICING_FEE' | 'TRUST_RECEIVABLE_SERVICING_FEE' | 'REVERSE_TRUST_RECEIVABLE_SERVICING_FEE' | 'SUBSIDIZED_INTEREST_RECEIVABLE' | 'REVERSE_SUBSIDIZED_INTEREST_RECEIVABLE' | 'SUBSIDIZED_INTEREST_PAYABLE' | 'REVERSE_SUBSIDIZED_INTEREST_PAYABLE' | 'REVERSE_DEALER_RESERVE_RECEIVABLE' | 'DISBURSEMENT' | 'REVERSE_DISBURSEMENT' | 'CRED_LINE_LIMIT' | 'REVERSE_CRED_LINE_LIMIT' | 'PRECOMPUTED_INTEREST' | 'REVERSE_PRECOMPUTED_INTEREST' | 'FA_PRECOMPUTED_INTEREST' | 'REVERSE_FA_PRECOMPUTED_INTEREST' | 'PRINCIPAL_BILLING' | 'REVERSE_PRINCIPAL_BILLING' | 'INTEREST_BILLING' | 'REVERSE_INTEREST_BILLING' | 'PRINCIPAL_AND_INTEREST_BILLING' | 'REVERSE_PRINCIPAL_AND_INTEREST_BILLING' | 'PRINCIPAL_BALLOON_BILLING' | 'REVERSE_PRINCIPAL_BALLOON_BILLING' | 'INTEREST_BALLOON_BILLING' | 'REVERSE_INTEREST_BALLOON_BILLING' | 'DEFERRED_INTEREST_BILLING' | 'REVERSE_DEFERRED_INTEREST_BILLING' | 'ADB_INTEREST_BILLING' | 'REVERSE_ADB_INTEREST_BILLING' | 'ADB_INTEREST_BILLING_ADJUSTMENT' | 'REVERSE_ADB_INTEREST_BILLING_ADJUSTMENT' | 'LATE_FEE' | 'REVERSE_LATE_FEE' | 'CREDIT_LINE_ADVANCE_FEE' | 'REVERSE_CREDIT_LINE_ADVANCE_FEE' | 'CREDIT_LINE_OVERDRAFT_FEE' | 'REVERSE_CREDIT_LINE_OVERDRAFT_FEE' | 'IMPOUND_ASSESSMENT' | 'REVERSE_IMPOUND_ASSESSMENT' | 'NSF_FEE' | 'REVERSE_NSF_FEE' | 'AMORTIZED_INCOME_FEE' | 'REVERSE_AMORTIZED_INCOME_FEE' | 'AMORTIZATION_OF_INCOME_FEE' | 'REVERSE_AMORTIZATION_OF_INCOME_FEE' | 'AMORTIZED_EXPENSE_FEE' | 'REVERSE_AMORTIZED_EXPENSE_FEE' | 'AMORTIZATION_OF_EXPENSE_FEE' | 'REVERSE_AMORTIZATION_OF_EXPENSE_FEE' | 'PRINCIPAL_PAYMENT' | 'REVERSE_PRINCIPAL_PAYMENT' | 'INTEREST_PAYMENT' | 'REVERSE_INTEREST_PAYMENT' | 'P_PLUS_I_PRINCIPAL_PAYMENT' | 'REVERSE_P_PLUS_I_PRINCIPAL_PAYMENT' | 'P_PLUS_I_INTEREST_PAYMENT' | 'REVERSE_P_PLUS_I_INTEREST_PAYMENT' | 'PRINCIPAL_BALLOON_PAYMENT' | 'REVERSE_PRINCIPAL_BALLOON_PAYMENT' | 'INTEREST_BALLOON_PAYMENT' | 'REVERSE_INTEREST_BALLOON_PAYMENT' | 'DEFERRED_INTEREST_PAYMENT' | 'REVERSE_DEFERRED_INTEREST_PAYMENT' | 'RULE_OF_78S_ACTUARIAL_PAYMENT' | 'REVERSE_RULE_OF_78S_ACTUARIAL_PAYMENT' | 'PRINCIPAL_REDUCTION' | 'REVERSE_PRINCIPAL_REDUCTION' | 'INTEREST_REDUCTION' | 'REVERSE_INTEREST_REDUCTION' | 'FEE_REDUCTION' | 'REVERSE_FEE_REDUCTION' | 'LATE_FEE_REDUCTION' | 'DEFERRED_INTEREST_REDUCTION' | 'REVERSE_DEFERRED_INTEREST_REDUCTION' | 'LATE_FEE_PAYMENT' | 'REVERSE_LATE_FEE_PAYMENT' | 'CREDIT_LINE_ADVANCE_FEE_PAYMENT' | 'REVERSE_CREDIT_LINE_ADVANCE_FEE_PAYMENT' | 'CREDIT_LINE_OVERDRAFT_FEE_PAYMENT' | 'REVERSE_CREDIT_LINE_OVERDRAFT_FEE_PAYMENT' | 'DOWN_PAYMENT' | 'REVERSE_DOWN_PAYMENT' | 'IMPOUND_PAYMENT' | 'REVERSE_IMPOUND_PAYMENT' | 'NSF_FEE_PAYMENT' | 'REVERSE_NSF_FEE_PAYMENT' | 'INTEREST_INCOME' | 'REVERSE_INTEREST_INCOME' | 'DISCOUNT_INCOME' | 'REVERSE_DISCOUNT_INCOME' | 'SHORT_TERM_CAPITAL_GAIN' | 'REVERSE_SHORT_TERM_CAPITAL_GAIN' | 'LONG_TERM_CAPITAL_GAIN' | 'REVERSE_LONG_TERM_CAPITAL_GAIN' | 'INTEREST_FREE_PRINCIPAL_ADJ' | 'REVERSE_INTEREST_FREE_PRINCIPAL_ADJ' | 'INTEREST_FREE_INTEREST_ADJ' | 'REVERSE_INTEREST_FREE_INTEREST_ADJ' | 'CAPITALIZE_OVERPAID_INTEREST' | 'REVERSE_CAPITALIZE_OVERPAID_INTEREST' | 'UNEARNED_ADDON_INTEREST_REDUCTION' | 'REVERSE_UNEARNED_ADDON_INTEREST_REDUCTION' | 'UNEARNED_ADDON_INTEREST_ADDITION' | 'REVERSE_UNEARNED_ADDON_INTEREST_ADDITION' | 'CAPITALIZE_INTEREST' | 'REVERSE_CAPITALIZE_INTEREST' | 'COMPOUND_INTEREST_BALANCE_ADJUSTMENT' | 'REVERSE_COMPOUND_INTEREST_BALANCE_ADJUSTMENT' | 'CAPITALIZE_DEFERRED_INTEREST' | 'REVERSE_CAPITALIZE_DEFERRED_INTEREST' | 'CAPITALIZE_OVERPAID_DEFERRED_INTEREST' | 'REVERSE_CAPITALIZE_OVERPAID_DEFERRED_INTEREST' | 'SERVICING_FEE' | 'REVERSE_SERVICING_FEE', required
    - `transaction_type` 'NONE' | 'CREDIT' | 'DEBIT', required
    - `transaction_iso_timestamp` string, date-time, required: The ISO timestamp of the transaction
  - `statements` Statement[], required: An array of statements for the loan (empty if no statements exist)
    - `id` string, required: The id of the statement
    - `statement_date` string, required: The end date of the statement (YYYY-MM-DD)
    - `statement_start_date` string, 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` FacilityTransactionItem[], required
      - `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
      - `category` 'DRAWER_RESERVE_PURCHASE_IN_FROM_RESERVE_BANK' | 'REVERSE_PURCHASE_IN_FROM_RESERVE_BANK' | 'CASH_DRAWER_SELL_OFF_FUNDS_OUT_TO_RESERVE' | 'REVERSE_SELL_OFF_FUNDS_OUT_TO_RESERVE' | 'CASH_DRAWER_RESERVE_BANK_DEPOSIT_OUT' | 'REVERSE_BANK_DEPOSIT_OUT' | 'CASH_DRAWER_RESERVE_RECONCILING_ERROR_CORRECTION' | 'REVERSE_RECONCILING_ERROR_CORRECTION' | 'TRUST_DEPOSIT' | 'REVERSE_TRUST_DEPOSIT' | 'TRUST_DISBURSEMENT' | 'REVERSE_TRUST_DISBURSEMENT' | 'TRUST_DISBURSEMENT_SERVICING_FEE' | 'REVERSE_TRUST_DISBURSEMENT_SERVICING_FEE' | 'TRUST_RECEIVABLE_SERVICING_FEE' | 'REVERSE_TRUST_RECEIVABLE_SERVICING_FEE' | 'SUBSIDIZED_INTEREST_RECEIVABLE' | 'REVERSE_SUBSIDIZED_INTEREST_RECEIVABLE' | 'SUBSIDIZED_INTEREST_PAYABLE' | 'REVERSE_SUBSIDIZED_INTEREST_PAYABLE' | 'REVERSE_DEALER_RESERVE_RECEIVABLE' | 'DISBURSEMENT' | 'REVERSE_DISBURSEMENT' | 'CRED_LINE_LIMIT' | 'REVERSE_CRED_LINE_LIMIT' | 'PRECOMPUTED_INTEREST' | 'REVERSE_PRECOMPUTED_INTEREST' | 'FA_PRECOMPUTED_INTEREST' | 'REVERSE_FA_PRECOMPUTED_INTEREST' | 'PRINCIPAL_BILLING' | 'REVERSE_PRINCIPAL_BILLING' | 'INTEREST_BILLING' | 'REVERSE_INTEREST_BILLING' | 'PRINCIPAL_AND_INTEREST_BILLING' | 'REVERSE_PRINCIPAL_AND_INTEREST_BILLING' | 'PRINCIPAL_BALLOON_BILLING' | 'REVERSE_PRINCIPAL_BALLOON_BILLING' | 'INTEREST_BALLOON_BILLING' | 'REVERSE_INTEREST_BALLOON_BILLING' | 'DEFERRED_INTEREST_BILLING' | 'REVERSE_DEFERRED_INTEREST_BILLING' | 'ADB_INTEREST_BILLING' | 'REVERSE_ADB_INTEREST_BILLING' | 'ADB_INTEREST_BILLING_ADJUSTMENT' | 'REVERSE_ADB_INTEREST_BILLING_ADJUSTMENT' | 'LATE_FEE' | 'REVERSE_LATE_FEE' | 'CREDIT_LINE_ADVANCE_FEE' | 'REVERSE_CREDIT_LINE_ADVANCE_FEE' | 'CREDIT_LINE_OVERDRAFT_FEE' | 'REVERSE_CREDIT_LINE_OVERDRAFT_FEE' | 'IMPOUND_ASSESSMENT' | 'REVERSE_IMPOUND_ASSESSMENT' | 'NSF_FEE' | 'REVERSE_NSF_FEE' | 'AMORTIZED_INCOME_FEE' | 'REVERSE_AMORTIZED_INCOME_FEE' | 'AMORTIZATION_OF_INCOME_FEE' | 'REVERSE_AMORTIZATION_OF_INCOME_FEE' | 'AMORTIZED_EXPENSE_FEE' | 'REVERSE_AMORTIZED_EXPENSE_FEE' | 'AMORTIZATION_OF_EXPENSE_FEE' | 'REVERSE_AMORTIZATION_OF_EXPENSE_FEE' | 'PRINCIPAL_PAYMENT' | 'REVERSE_PRINCIPAL_PAYMENT' | 'INTEREST_PAYMENT' | 'REVERSE_INTEREST_PAYMENT' | 'P_PLUS_I_PRINCIPAL_PAYMENT' | 'REVERSE_P_PLUS_I_PRINCIPAL_PAYMENT' | 'P_PLUS_I_INTEREST_PAYMENT' | 'REVERSE_P_PLUS_I_INTEREST_PAYMENT' | 'PRINCIPAL_BALLOON_PAYMENT' | 'REVERSE_PRINCIPAL_BALLOON_PAYMENT' | 'INTEREST_BALLOON_PAYMENT' | 'REVERSE_INTEREST_BALLOON_PAYMENT' | 'DEFERRED_INTEREST_PAYMENT' | 'REVERSE_DEFERRED_INTEREST_PAYMENT' | 'RULE_OF_78S_ACTUARIAL_PAYMENT' | 'REVERSE_RULE_OF_78S_ACTUARIAL_PAYMENT' | 'PRINCIPAL_REDUCTION' | 'REVERSE_PRINCIPAL_REDUCTION' | 'INTEREST_REDUCTION' | 'REVERSE_INTEREST_REDUCTION' | 'FEE_REDUCTION' | 'REVERSE_FEE_REDUCTION' | 'LATE_FEE_REDUCTION' | 'DEFERRED_INTEREST_REDUCTION' | 'REVERSE_DEFERRED_INTEREST_REDUCTION' | 'LATE_FEE_PAYMENT' | 'REVERSE_LATE_FEE_PAYMENT' | 'CREDIT_LINE_ADVANCE_FEE_PAYMENT' | 'REVERSE_CREDIT_LINE_ADVANCE_FEE_PAYMENT' | 'CREDIT_LINE_OVERDRAFT_FEE_PAYMENT' | 'REVERSE_CREDIT_LINE_OVERDRAFT_FEE_PAYMENT' | 'DOWN_PAYMENT' | 'REVERSE_DOWN_PAYMENT' | 'IMPOUND_PAYMENT' | 'REVERSE_IMPOUND_PAYMENT' | 'NSF_FEE_PAYMENT' | 'REVERSE_NSF_FEE_PAYMENT' | 'INTEREST_INCOME' | 'REVERSE_INTEREST_INCOME' | 'DISCOUNT_INCOME' | 'REVERSE_DISCOUNT_INCOME' | 'SHORT_TERM_CAPITAL_GAIN' | 'REVERSE_SHORT_TERM_CAPITAL_GAIN' | 'LONG_TERM_CAPITAL_GAIN' | 'REVERSE_LONG_TERM_CAPITAL_GAIN' | 'INTEREST_FREE_PRINCIPAL_ADJ' | 'REVERSE_INTEREST_FREE_PRINCIPAL_ADJ' | 'INTEREST_FREE_INTEREST_ADJ' | 'REVERSE_INTEREST_FREE_INTEREST_ADJ' | 'CAPITALIZE_OVERPAID_INTEREST' | 'REVERSE_CAPITALIZE_OVERPAID_INTEREST' | 'UNEARNED_ADDON_INTEREST_REDUCTION' | 'REVERSE_UNEARNED_ADDON_INTEREST_REDUCTION' | 'UNEARNED_ADDON_INTEREST_ADDITION' | 'REVERSE_UNEARNED_ADDON_INTEREST_ADDITION' | 'CAPITALIZE_INTEREST' | 'REVERSE_CAPITALIZE_INTEREST' | 'COMPOUND_INTEREST_BALANCE_ADJUSTMENT' | 'REVERSE_COMPOUND_INTEREST_BALANCE_ADJUSTMENT' | 'CAPITALIZE_DEFERRED_INTEREST' | 'REVERSE_CAPITALIZE_DEFERRED_INTEREST' | 'CAPITALIZE_OVERPAID_DEFERRED_INTEREST' | 'REVERSE_CAPITALIZE_OVERPAID_DEFERRED_INTEREST' | 'SERVICING_FEE' | 'REVERSE_SERVICING_FEE', required
      - `transaction_type` 'NONE' | 'CREDIT' | 'DEBIT', required
      - `transaction_iso_timestamp` string, date-time, required: The ISO timestamp of the transaction
    - `payments` Payment[], required: An array of payments made (scoped to the period of the statement)
      - `id` 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` 'pending' | 'processing' | 'processed' | 'settled' | 'failed' | 'canceled' | 'cancellation_pending', required
      - `transfer_type` 'standard' | 'none' | 'refund' | 'credit' | 'cancellation' | 'suspense_credit', required: Transfer types that are not standard/none are set by special operations like the refund endpoint for example. Special types, like refund, will reference the original transaction transfer type of standard/none to determine if ACH was used if this knowledge is needed (e.g. does an ACH refund need to happen or was this ledgering only).
      - `created_on` string, date-time, required: Timestamp the payment is created on
      - `failure_reason` string, nullable: A reason for the failure if one exists
      - `is_autopay` boolean, nullable: If the payment was a result of an autopay
    - `disbursements` Disbursement[], required: An array of disbursements made (scoped to the period of the statement)
      - `id` 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` 'pending' | 'processing' | 'processed' | 'settled' | 'failed' | 'canceled' | 'cancellation_pending', required
      - `failure_reason` string, nullable: A reason for the failure if any exists
      - `date` string, nullable: The date of the disbursement (YYYY-MM-DD)
      - `created_on` string, date-time, required: Timestamp the disbursement object is created on
      - `transfer_type` 'standard' | 'none' | 'refund' | 'cancellation' | 'suspense_refund', required: Transfer types that are not standard/none are set by special operations like the refund endpoint for example. Special types, like refund, will reference the original transaction transfer type of standard/none to determine if ACH was used if this knowledge is needed (e.g. does an ACH refund need to happen or was this ledgering only).
    - `facility_id` string, required
    - `url` string, required: The url of the statement pdf
    - `created_on` string, date-time, required: Timestamp the statement object is created on
  - `balance` integer, nullable: The remaining balance of the loan, in cents
  - `balances` FacilityBalances, required
    - `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, nullable: The current interest balance of the loan, in cents (deprecated - see balances field)
  - `payoff_balance` integer, nullable: The current payoff balance of the loan, in cents (deprecated - see balances field)
  - `origination_date` string, nullable: The date the loan was originated (YYYY-MM-DD)
  - `disbursement_date` string, nullable: The date the loan was disbursed (YYYY-MM-DD)
  - `remaining_term` integer, nullable: The remaining term of the loan, in months
  - `payments_due` PaymentDue[], required
    - `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, nullable: The amount of the next payment, in cents
  - `next_payment_due_date` string, nullable: The date the next payment is due (YYYY-MM-DD)
  - `current_payment_due_date` string, nullable: The date the current payment is due (YYYY-MM-DD)
  - `last_payment_date` string, nullable: The date the last payment was made (YYYY-MM-DD)
  - `principal_paid_thru` string, nullable: The date the principal is paid through (YYYY-MM-DD)
  - `next_billing_date` string, nullable: The next billing date of the loan (YYYY-MM-DD)
  - `interest_accrued_thru` string, nullable: The date the interest is accrued through (YYYY-MM-DD)
  - `next_accrual_cutoff_date` string, nullable: The next accrual cutoff date of the loan (YYYY-MM-DD)
  - `scheduled_payoff_date` string, nullable: The scheduled payoff date of the loan (YYYY-MM-DD)
  - `terms` union, required
    - object
      - `type` 'revolving_line_of_credit_offer', required
      - `id` string, required
      - `amount` integer, required: The amount (in cents) of the credit line offer (e.g. '200000' for $2,000.00)
      - `apr` integer, nullable: The annual percentage rate (in basis points) of the credit line
      - `annual_fee` integer, nullable: The annual fee charged for the credit line (e.g. '5000' for $50.00)
      - `billing_cycle` integer, nullable: 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'
      - `finance_charge` integer, nullable: If your platform charges a monthly finance charge for access to the line, the amount in cents
      - `grace_period` GracePeriod
        - `term` integer, nullable: 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'
        - `interest_rate` integer, nullable: The interest rate (in basis points) charged during the grace period. Must be '0' for consumer lines of credit. Defaults to 0 if omitted
      - `introductory_promo_period` IntroductoryPromoPeriod
        - `interest_rate` integer, required: The interest rate (in basis points) charged during the introductory period
        - `promo_term` PromoTerm, required
          - `term` integer, required: The term of the promotional period relative to the `term_type` (e.g. if `daily` in days, `period` in period of loan, etc.)
          - `term_type` 'daily' | 'period', required
      - `interest_rate` integer, nullable: The interest rate (in basis points) of the loan or credit line offer (e.g. '750' for 7.50%)
      - `late_payment_fee` integer, nullable: The fee charged if a borrower misses the payment due date, in cents (e.g. '2500' for $25.00; default to 0)
      - `minimum_payment` MinimumPayment
        - `type` 'interest_plus_percentage_of_principal', required
        - `value` integer, required: The minimum payment percentage due each billing cycle (e.g. 500 for 5.00%)
        - `floor` integer, nullable: The minimum payment floor in cents (e.g. 1500 for $15.00). Defaults to 1500 if omitted. If the percentage of the principal balance is less than the floor, the floor is used.
      - `payment_period` 'weekly' | 'biweekly' | 'monthly' | 'semi_monthly_first_15th' | 'semi_monthly_last_15th' | 'semi_monthly'
      - `first_payment_date` string, nullable: The date of the first payment, in ISO 8601 format (e.g. 2022-12-31)
    - object
      - `type` 'loan_offer', required
      - `id` string, required
      - `amount` integer, required: The amount (in cents) of the loan offer (e.g. 200000 for $2,000.00)
      - `grace_period` GracePeriod
        - `term` integer, nullable: 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'
        - `interest_rate` integer, nullable: The interest rate (in basis points) charged during the grace period. Must be '0' for consumer lines of credit. Defaults to 0 if omitted
      - `introductory_promo_period` IntroductoryPromoPeriod
        - `interest_rate` integer, required: The interest rate (in basis points) charged during the introductory period
        - `promo_term` PromoTerm, required
          - `term` integer, required: The term of the promotional period relative to the `term_type` (e.g. if `daily` in days, `period` in period of loan, etc.)
          - `term_type` 'daily' | 'period', required
      - `interest_rate` integer, nullable: The interest rate (in basis points) charged on the loan principal (e.g. 750 for 7.50%)
      - `origination_fee` OriginationFee
        - `type` 'deducted' | 'capitalized', required
        - `fee` integer, required: The origination fee in bps
      - `payment_period` 'weekly' | 'biweekly' | 'monthly' | 'semi_monthly_first_15th' | 'semi_monthly_last_15th' | 'semi_monthly'
      - `first_payment_date` string, nullable: The date of the first payment, in ISO 8601 format (e.g. 2022-12-31)
      - `late_payment_fee` integer, nullable: The fee charged if a borrower misses the payment due date, in cents (e.g. 2500 for $25.00)
      - `loan_term` Term, required
        - `term_type` 'months' | 'days' | 'payments', required
        - `term` integer, required: The term of the loan according to the term type. A minimum of 3 is required for monthly payment_period, 6 for semi-monthly, 7 for biweekly and 13 for weekly.
      - `security_amount` integer, nullable: The amount (in cents) of the value of the loan collateral (e.g. 200000 for $2,000.00). Required for secured loan application types.
    - object
      - `type` 'merchant_advance_offer', required
      - `id` string, required
      - `apr` integer, nullable: The annual percentage rate (in basis points) of the credit line
      - `amount` integer, required: The amount (in cents) of the loan offer (e.g. 200000 for $2,000.00)
      - `interest_rate` integer, required: The interest rate charged on the advance
      - `loan_term` Term, required
        - `term_type` 'months' | 'days' | 'payments', required
        - `term` integer, required: The term of the loan according to the term type. A minimum of 3 is required for monthly payment_period, 6 for semi-monthly, 7 for biweekly and 13 for weekly.
      - `origination_fee` OriginationFee
        - `type` 'deducted' | 'capitalized', required
        - `fee` integer, required: The origination fee in bps
      - `late_payment_fee` integer, nullable: The fee charged if a borrower misses the payment due date, in cents (e.g. 2500 for $25.00)
  - `autopay` Autopay
    - `authorized` boolean, required: a bollean indicating whether autopay is authorized
    - `authorization_timestamp` string, date-time, nullable: the timestamp when autopay was authorized
    - `bank_account` BankAccount
      - `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` 'checking' | 'savings', required
    - `amount_type` 'minimum_payment' | 'statement_balance'
    - `additional_amount` integer, nullable: the additional amount to be paid on top of the minimum payment, in cents
  - `documents` Documents
    - `unsigned_credit_agreement` FacilityDocument
      - `document_url` string, required: The URL where the document can be accessed.
      - `document_id` string, required: The unique identifier for the document.
    - `signed_credit_agreement` FacilityDocument
      - `document_url` string, required: The URL where the document can be accessed.
      - `document_id` string, required: The unique identifier for the document.
    - `unsigned_ach_authorization` FacilityDocument
      - `document_url` string, required: The URL where the document can be accessed.
      - `document_id` string, required: The unique identifier for the document.
    - `unsigned_autopay_ach_authorization` FacilityDocument
      - `document_url` string, required: The URL where the document can be accessed.
      - `document_id` string, required: The unique identifier for the document.
    - `signed_ach_authorization` FacilityDocument
      - `document_url` string, required: The URL where the document can be accessed.
      - `document_id` string, required: The unique identifier for the document.
    - `signed_autopay_ach_authorization` FacilityDocument
      - `document_url` string, required: The URL where the document can be accessed.
      - `document_id` string, required: The unique identifier for the 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` LastStatementInfo
    - `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, nullable: Whether the facility is in a grace period
  - `in_introductory_promo_period` boolean, nullable: Whether the facility is in an introductory promotional period

## Other responses

- `400`
- `401`
- `404`
- `429`
- `500`

---

[API](https://skmtc.dev/pier-finance/apis/pier-api.md) - [All operations](https://skmtc.dev/pier-finance/apis/pier-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pier-finance/apis/pier-api/revisions/08a7c49252b9?raw)