Invalid Input Error

Borrower Not Found Error

Server Error

Pier's rate limit is set to 1,000 requests per minute. 
The limit applies to both the sandbox and production environments.


Rate Limit Error

Unauthorized Error

Application Not Found Error

Invalid Application ID Error

List all applications associated with your account

Updates the status of a credit application to `rejected` and returns a user readable rejection reason, to be used in the adverse action notice

Get a JWT token for use with the Pier API by passing in a valid `client_id`/`secret` in the body

Creates a business borrower. Business borrowers must have a unique EIN.

Duplicate Ein Error

Create a consumer borrower. The created consumer resource is returned
in the response.

Duplicate Ssn Error

Retrieve all borrowers associated with your account

Updates an existing borrower. The full borrower object less a few unchangeable fields needs to be
supplied in the update request.

Invalid Lending Details Error

Reset the array of `urls` that receives Pier webhooks.

Get the array of `urls` that receives Pier webhooks.

Set the array of urls to receive webhook events from Pier.

Invalid Webhook Error

The Pier public key to use to verify webhook signatures.

Check a set of offers against our limits for a given state. Customers can pass us a list of offers, which we will run through our compliance limits. We will return a boolean for each offer indicating whether the offer passes our limits or not. If the user does not specify an ID for each offer, we will reindex them from 0.

Retrieve state-by-state consumer coverage list. The state-by-state consumer coverage list reflects your state coverage and compliant loan thresholds based on your use case. We configure this based on your licensing and compliance setup, upon our review to ensure you're compliant with state and federal requirements.

Retrieve a list of valid reasons to reject an applicant, along with descriptions for each reason

Add repayment bank details for a facility

Facility Not Found Error

Cancels a submitted disbursement before it is sent to the ACH network. Disbursements can only be canceled if they are still in the `pending` state and have not been submitted to the ACH network. After a disbursement is sent to the ACH network, you must wait for the it to settle and then you may refund it instead.

In some cases if you cancel while the disbursement is in the process of being submitted to the ACH network you may see a status of `cancellation_pending` in the response. In this case, you can check the status of the disbursement or wait for a subsequent webhook to see if it was successfully canceled or processed.

Transaction Not Found Error

Transaction Already Refunded Error

Cannot Cancel Transaction Incorrect Status

Closes an active facility by setting its status to `closed`

Facility Cannot Be Closed Error

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

Facility Cannot Be Created Error

Facility Already Exists Error

Document Not Found Error

Product Not Supported Error

Creates an unsigned ACH authorization document for a specified facility. This is a required step before submitting a payment if repayment ACH is enabled. The user must agree to ACH withdrawals before Pier can initiate payments. This document is automatically signed by the user when you call POST /payments. You must create a new ACH authorization document for each payment.

Creates an unsigned autopay ACH authorization document for a specified facility. This is a required step before enabling autopay. The user must agree to automatic ACH withdrawals before Pier can initiate payments. This document is automatically signed by the user when you call POST /enable_autopay.

Create a limit reduction notice, which should be presented to the user when their credit limit is reduced. This endpoint must be called before reducing the credit limit. The document_id returned should be stored and used in the PATCH /facilities/{facility_id}/update_limit endpoint.

Limit Update Must Be Lower Error

Line Limit Updates Disabled Error

Disbursement Not Found Error

Payment Not Found Error

Autopay Already Disabled Error

Create a disbursement for a facility. If disbursements_ach_enabled is false, use none for transfer_type.

Ledgering Not Supported Error

Disbursement Ach Disabled Error

Disbursement Amount Exceeds Facility Amount Error

Disbursement Amount Exceeds Available Limit Error

Missing Disbursement Bank Details

Move disbursement to failed state (_sandbox only_)

Move disbursement to initiated state (_sandbox only_)

Move disbursement to successful state (_sandbox only_)

Invalid Facility ID Error

The facility_id of the facility you want to retrieve

Invalid Disbursement ID Error

The disbursement_id of the disbursement you want to retrieve

Retrieve a list of payoff amount/date pairs for a facility for the next 10 days

The facility_id of the facility you want to retrieve payoff amounts for

The facility_id of the facility you want to list disbursements for

The facility_id of the facility you want to list statements for

Refunds a specified disbursement in full. This endpoint is intended for correcting erroneous transactions.

Cannot Refund Transaction Incorrect Status

Update credit limit for a line of credit. For reductions, pass in the document_id from the create_limit_reduction_notice endpoint. For increases, pass in the new credit limit amount.

Customer Not Found Error

Invalid Facility Type Error

Limit Update Cooldown Error

Limit Update Already Processed Error

Limit Update Nan Error

Limit Update Must Be Higher Error

Unsupported Offer Terms Error

A loan agreement can be created for an application with a status of approved. Expect 4-8 seconds of latency

Document Cannot Be Created Error

Electronically signs a loan document and updates the application's status to `accepted`

Document Cannot Be Signed Error

Cancels a submitted payment before it is sent to the ACH network. Payments can only be canceled if they are still in the `pending` state and have not been submitted to the ACH network. After a payment is sent to the ACH network, you must wait for the it to settle and then you may refund it instead.

In some cases if you cancel while the payment is in the process of being submitted to the ACH network you may see a status of `cancellation_pending` in the response. In this case, you can check the status of the payment or wait for a subsequent webhook to see if it was successfully canceled or processed.

Invalid Payment ID Error

List all payments associated with your account

Move payment to failed state (_sandbox only_)

Move payment to initiated state (_sandbox only_)

Move payment to successful state (_sandbox only_)

Refunds a specified payment in full. This endpoint is intended for correcting erroneous transactions. Only payments in the `settled` state can be refunded. This includes customers with ACH disabled because payments go straight to settled.

Instructs Pier to initiate an ACH payment for a loan. If repayment_ach_enabled is false, use none for transfer_type.

Payment Balance Less than Amount Error

Repayment Ach Disabled Error

Unable to Initiate Payment Error

Missing Repayment Bank Details Error

Get the balance report for all facilities for a Pier partner for a specific day. The report contains the balance EOD in Pacific Time.

Unable to Acquire Lock Error

Reconciliation Report Invalid Date Error

Reconciliation Report Not yet Available Error

Get the transaction report for all facilities for a Pier partner for a specific day. The report contains all transactions for the day that make up the ledger of the facility as well as payments and disbursements.

applications

auth

borrowers

configuration

coverage

facilities

loan-agreements

payments

reconciliation-reports

Application

The `borrower_id` of the borrower the application belongs to

Timestamp the application object is created on

Timestamp when the application is either approved or rejected on

If the application is approved, an object containing the credit offer details

If the application is rejected, a list containing 1-4 rejection reason(s). The Rejection Reasons endpoint provides a list of valid reasons and descriptors

If the borrower requests an amount in their application, the requested loan or credit line amount in cents (e.g. 500000 for $5,000)

For credit applications of type `consumer_bnpl`, the third party (i.e. merchant) receiving the funds is specified here

ApplicationId

ApplicationStatus

the application is approved with an offer

the application offer has been accepted by the borrower

CreditData

Whether or not there is bankruptcy history

GracePeriod

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'

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

IntroductoryPromoPeriod

The interest rate (in basis points) charged during the introductory period

LineOfCreditOffer

LineOfCreditOfferRequest

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

The annual percentage rate (in basis points) of the credit line

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

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'

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

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

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

The minimum payment due each billing cycle. There is also a flat minimum payment of \$15, which is used if the calculated minimum payment is less than \$15.

The origination fee charged to originate the line in basis points (e.g. '150' for 1.50%)

The repayment frequency for the loan. Accepted values weekly, biweekly, monthly, semi_monthly_first_15th, semi_monthly_last_15th, semi_monthly

The date of the first payment, in ISO 8601 format (e.g. 2022-12-31)

LoanOffer

LoanOfferRequest

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

The interest rate (in basis points) charged on the loan principal (e.g. 750 for 7.50%)

The origination fee charged to originate the loan in basis points (e.g. 150 for 1.50%)

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

The type of term. Accepted values are months, days, payments

The amount (in cents) of the value of the loan collateral (e.g. 200000 for $2,000.00). Required for secured loan application types.

MerchantAdvanceOffer

MerchantAdvanceOfferRequest

MinimumPayment

The type of minimum payment structure. Accepted values are interest_plus_percentage_of_principal

The minimum payment percentage due each billing cycle (e.g. 500 for 5.00%)

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.

MinimumPaymentType

The minimum payment is 100% of interest accrued plus a percentage of the principal balance

Offer

OfferId

OfferRequest

PaymentPeriod

Semi-monthly payment period, with payments due on the 1st and 15th of each month

Semi-monthly payment period, with payments due on the 15th and last day of each month

PromoTerm

The term of the promotional period relative to the `term_type` (e.g. if `daily` in days, `period` in period of loan, etc.)

PromoTermType

The term of the promotional period is in days

[NOT YET IMPLEMENTED] The term of the promotional period is in the term of the offer

RejectionReason

Unable to predict regular pattern of income deposits

Duplicate account (previously applied for a loan with a different email address)

Unable to link to a supported banking institution

Under the Military Lending Act, loans to military personnel or their spouses
and dependents cannot be made if the interest and expenses associated with the
loan exceed an annual percentage rate (APR) of 36%. Due to these limits on
military-related lending, we can't lend to members of the military or their
spouses and dependents. Please feel free to contact us with any questions you
may have about this notice!

Unable to verify identification documents

No data from supported financial institution. Unsupported financial institution is linked

Unable to verify that your permanent residence is in a state

Unable to verify qualified income over a sustained period

Recent deposits and withdrawals detected from other lenders

Multiple Returned checks or Insufficient Fund Fees detected

Bank account has been flagged as potential fraud risk

Payment processor is unable to authenticate user

Cash flow analysis - income funds are quickly depleted from bank account after income deposit

Your credit score does not meet our requirement

Term

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.

TermType

The term of the line is in number of payments

AuthRequest

AuthResponse

A JWT token to use with the Pier API (24h expiration)

BeneficialOwnerId

A person who owns owns 25% or more of the business as well as those who control the funds.

BeneficialOwners

The person's government identifiers, required fields dependent on customer configuration

BeneficialOwnersResponse

The person's 10-digit US phone number (e.g. 4152251000)

The percent ownership the person has in the business in basis points (e.g. 2500 for 25%)

Borrower

BusinessBorrower

An array of objects representing owners of the business and those who control the funds of the business.
If no one owns more than 25% of the business, just the individual who has ultimate control of the funds must be included.
A maximum of 5 objects can be added.

9-digit IRS employee identification number of the business (e.g. 345543221)

Incorporation date of the business (YYYY-MM-DD)

Date kyb completed on the business (YYYY-MM-DD)

Required 2-digit US state code (e.g. CA, IL, FL, …)

1	curl -X POST https://production.pier-finance.com/api/applications \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"borrower_id": "bor_a1d0c30d77104f35b4c842b99132624e",
6	"credit_type": "consumer_installment_loan",
7	"requested_amount": 200000
8	}'

1	{
2	"status": "pending",
3	"id": "app_f0467657bba948e6a87292e182132848",
4	"borrower_id": "bor_a1d0c30d77104f35b4c842b99132624e",
5	"created_on": "2022-12-31T01:36:52.606Z",
6	"credit_type": "consumer_installment_loan",
7	"rejection_reasons": [],
8	"lender_of_record": "lender"
9	}

Create an application

Request

Response

Errors