Request Sandbox Keys
See a Demo
Search...
/
Overview
Quickstart
Payments and Disbursements
Errors
Webhooks
Guides
Starter Mode
KYC
Line of Credit program
Buy Now Pay Later program
API Reference
Applications
POST
Create an application
POST
Approve an application
POST
Reject an application
GET
Get an application by ID
GET
List all applications
Auth
POST
Get a JWT token
Borrowers
POST
Create a business borrower
PATCH
Update a business borrower
POST
Create a consumer borrower
PATCH
Update a consumer borrower
GET
Retrieve a borrower by id
GET
List all borrowers
Configuration
POST
Set webhook URLs
DEL
Reset webhook URLs
GET
Get webhook URLs
GET
Verify a webhook with Pier public key
POST
Set lending details
DEL
Remove lending details
Coverage
GET
Retrieve commercial lending coverage
GET
Retrieve consumer lending coverage
GET
Retrieve rejection reasons
POST
Check offers
Facilities
POST
Create a facility
POST
Create a disbursement for a facility
PATCH
Move disbursement to initiated state
PATCH
Move disbursement to successful state
PATCH
Move disbursement to failed state
GET
List all payments for a facility
POST
Credit a facility
POST
Refund a disbursement
POST
Close a facility
POST
Create ACH Authorization
POST
Create autopay ACH authorization
POST
Enable autopay for a facility
POST
Disable autopay for a facility
POST
Add repayment bank details for a facility
GET
Retrieve a facility
GET
List all disbursements for your account
GET
List statements for a facility
GET
Retrieve a disbursement by its id
GET
List disbursements for a facility
GET
List all facilities
GET
Retrieve payoff amounts for a facility
Loan Agreements
POST
Create a loan agreement
POST
Sign a loan agreement
GET
Get a loan agreement by id
GET
List all loan agreements
Payments
POST
Submit a loan payment
GET
Get a payment by ID
POST
Refund a payment
GET
List all payments
PATCH
Move payment to initiated state
PATCH
Move payment to successful state
PATCH
Move payment to failed state
Request Sandbox Keys
See a Demo
Borrowers
Create a consumer borrower
POST
https://
production.pier-finance.com
/
api
/
borrowers
/
consumer
Create a consumer borrower. The created consumer resource is returned in the response.
Request
This endpoint expects an object.
address
object
Required
The address of the borrower
Show 5 properties
date_of_birth
string
Required
The borrower's date of birth (YYYY-MM-DD)
email
string
Required
The borrower's valid email address
first_name
string
Required
The borrower's first name
last_name
string
Required
The borrower's last name
kyc_completion_date
string
Optional
Date kyc completed on the borrower, only required if Pier is not performing KYC (YYYY-MM-DD)
kyc_status
enum
Optional
Kyc status of a consumer (
sandbox only
)
Allowed values:
approved
declined
pending
government_identifiers
object
Optional
The borrower's government identifiers, required fields dependent on customer configuration
Show 2 properties
Response
This endpoint returns an object
address
object
The address of the borrower
Show 5 properties
date_of_birth
string
The borrower's date of birth (YYYY-MM-DD)
id
string
The ID of the borrower
email
string
The borrower's valid email address
first_name
string
The borrower's first name
last_name
string
The borrower's last name
kyc_completion_date
string
Date kyc completed on the borrower (YYYY-MM-DD)
created_on
datetime
The date the borrower was created
Errors
400
Bad Request
400
Bad Request
401
Unauthorized
429
Too Many Requests
500
Internal Server Error
Built with