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


Create an application

Approve an application

Reject an application

Get an application by ID

List all applications associated with your account

List all applications

Applications

Get a JWT token

Auth

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

Create a business borrower

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

Update a business borrower

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

Create a consumer borrower

Update a consumer borrower

Retrieve a borrower by id

Retrieve all borrowers associated with your account

List all borrowers

Borrowers

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

Set webhook URLs

Reset webhook URLs

Get webhook URLs

The Pier public key to use to verify webhook signatures.

Verify a webhook with Pier public key

Set lending details

Remove lending details

Configuration

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 commercial lending coverage

Retrieve consumer lending coverage

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

Retrieve rejection reasons

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.

Check offers

Coverage

Create a facility

Create a disbursement for a facility

Move disbursement to initiated state

Move disbursement to successful state

Move disbursement to failed state

Create a limit reduction notice

Update credit limit for a line of credit

List all payments for a facility

Credit a facility

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

Refund a disbursement

Close a facility

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.

Create ACH Authorization

Create autopay ACH authorization

Enable autopay for a facility

Disable autopay for a facility

Add repayment bank details for a facility

Retrieve a facility

List all disbursements for your account

List statements for a facility

Retrieve a disbursement by its id

List disbursements for a facility

List all facilities

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

Retrieve payoff amounts for a facility

Facilities

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

Create a loan agreement

Sign a loan agreement

Get a loan agreement by id

List all loan agreements

Loan Agreements

Submit a loan payment

Get a payment by ID

Refunds a specified payment in full. This endpoint is intended for correcting erroneous transactions. Only customers with ACH disabled can refund payments.

Refund a payment

List all payments associated with your account

List all payments

Move payment to initiated state

Move payment to successful state

Move payment to failed state

Payments

Application

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)

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

GetApplicationRequest

The id of the borrower you're requesting to retrieve

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%)

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 date of the first payment, in ISO 8601 format (e.g. 2022-12-31)

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 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

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

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, …)

BusinessBorrowerId

BusinessBorrowerRequest

BusinessBorrowerResponse

BusinessContact

The person's title in the company (e.g. COO)

BusinessType

ConsumerBorrower

The borrower's date of birth (YYYY-MM-DD)

Date kyc completed on the borrower (YYYY-MM-DD)

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

ConsumerBorrowerId

ConsumerBorrowerRequest

Date kyc completed on the borrower, only required if Pier is not performing KYC (YYYY-MM-DD)

The borrower's government identifiers, required fields dependent on customer configuration. Can be non-unique on sandbox environment.

ConsumerBorrowerResponse

GovernmentIdentifiers

The borrower's 9-digit social security number (e.g. 345543221)

The last 4 digits of the borrower's social security number

KycStatus

UpdateBusinessBorrowerRequest

UpdateConsumerBorrowerRequest

Address

Autopay

a bollean indicating whether autopay is authorized

the timestamp when autopay was authorized

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

AutopayAmountType

BankAccount

The bank account number to use for scheduled payments

1	{
2	"id": "pmt_18e5a3726b3943cda2635f40e1041ba4",
3	"amount": 100000,
4	"facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
5	"status": "pending",
6	"transfer_type": "standard",
7	"created_on": "2023-02-27T00:00:00Z",
8	"is_autopay": false
9	}

Get a payment by ID

Path parameters

Response

Errors

1	curl https://production.pier-finance.com/api/payments/pmt_18e5a3726b3943cda2635f40e1041ba4 \
2	-H "Authorization: Bearer <token>"