PIpier-finance
Facilities

Close a facility

Closes an active facility by setting its status to closed

post/facilities/{facility_id}/close

Request

  • Base URL
    https://production.pier-finance.com/api
  • Auth
    HTTP bearer

Path parameters

facility_idstring required

Response

idstring required
application_idstring required
borrower_idstring required
loan_agreement_idstring 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_onstring date-time required

Timestamp the loan agreement object is created on

status'active' | 'closed' required
account_numberstring required

The account number of the credit facility

balanceinteger nullable

The remaining balance of the loan, in cents

interest_balanceinteger nullable

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

payoff_balanceinteger nullable

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

origination_datestring nullable

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

disbursement_datestring nullable

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

remaining_terminteger nullable

The remaining term of the loan, in months

next_payment_amountinteger nullable

The amount of the next payment, in cents

next_payment_due_datestring nullable

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

current_payment_due_datestring nullable

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

last_payment_datestring nullable

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

principal_paid_thrustring nullable

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

next_billing_datestring nullable

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

interest_accrued_thrustring nullable

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

next_accrual_cutoff_datestring nullable

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

scheduled_payoff_datestring nullable

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

remaining_statement_balanceinteger 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_balanceinteger 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.

in_grace_periodboolean nullable

Whether the facility is in a grace period

in_introductory_promo_periodboolean nullable

Whether the facility is in an introductory promotional period

Example response

{
  "loan_agreement_id": "doc_43da3b3f95c745e1985a71e9a00d6c27",
  "created_on": "2023-05-12T19:46:09.293Z",
  "account_number": "401542198",
  "amortization_schedule": [
    {
      "payment_date": "2023-11-02",
      "principal_payment_amount": 8333,
      "total_payment_amount": 8333,
      "balance_amount": 91667,
      "item_index": 1
    }
  ],
  "repayment_bank_details": {
    "bank_account_number": "98989898",
    "bank_routing_number": "021000021"
  },
  "statements": [
    {
      "id": "stmt_deb6aba913d84feb987934f50c32bf03",
      "statement_date": "2023-03-17",
      "statement_start_date": "2024-06-17T00:00:00.000Z",
      "balance_due": 500000,
      "current_principal_balance": 500000,
      "current_interest_balance": 10000,
      "due_date": "2023-03-17",
      "payments": [
        {
          "amount": 100000,
          "facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
          "created_on": "2023-02-27T00:00:00Z"
        }
      ],
      "disbursements": [
        {
          "id": "dsb_18e5a3726b3943cda2635f40e1041ba4",
          "amount": 100000,
          "created_on": "2023-02-27T00:00:00Z"
        }
      ],
      "url": "https://app.docspring.com/submissions/sub_gjX2LS7c6FjqZt12hQ/download",
      "created_on": "2023-02-27T00:00:00Z"
    }
  ],
  "balances": {
    "current_balance": 500000,
    "principal_balance": 500000,
    "payoff_balance": 500000
  },
  "autopay": {
    "authorized": true,
    "bank_account": {
      "bank_account_number": "98989898",
      "bank_routing_number": "021000021"
    }
  },
  "documents": {
    "unsigned_credit_agreement": {
      "document_url": "https://example.com/document.pdf",
      "document_id": "doc_1234567890abcdef"
    },
    "signed_credit_agreement": {
      "document_url": "https://example.com/document.pdf",
      "document_id": "doc_1234567890abcdef"
    },
    "unsigned_ach_authorization": {
      "document_url": "https://example.com/document.pdf",
      "document_id": "doc_1234567890abcdef"
    },
    "unsigned_autopay_ach_authorization": {
      "document_url": "https://example.com/document.pdf",
      "document_id": "doc_1234567890abcdef"
    },
    "signed_ach_authorization": {
      "document_url": "https://example.com/document.pdf",
      "document_id": "doc_1234567890abcdef"
    },
    "signed_autopay_ach_authorization": {
      "document_url": "https://example.com/document.pdf",
      "document_id": "doc_1234567890abcdef"
    }
  },
  "remaining_statement_balance": 7500,
  "remaining_minimum_balance": 7500,
  "last_statement_info": {
    "last_statement_date": "2024-06-01T00:00:00.000Z",
    "last_statement_amount": 47000
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.