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
Facilities
Refund a disbursement
POST
https://
production.pier-finance.com
/
api
/
facilities
/
:facility_id
/
disbursements
/
:disbursement_id
/
refund
Refunds a specified disbursement in full. This endpoint is intended for correcting erroneous transactions.
Path parameters
facility_id
string
Required
disbursement_id
string
Required
Response
This endpoint returns an object
amount
integer
The amount of the disbursement, in cents (e.g. 1000 = $10.00)
created_on
datetime
Timestamp the disbursement object is created on
facility_id
string
id
string
The id of the disbursement
refund_metadata
object
Metadata about the original transaction being refunded
Show 3 properties
status
enum
The status of the disbursement
Allowed values:
pending
processing
settled
failed
cancelled
transfer_type
enum
The type of transfer to use for the disbursement
Allowed values:
standard
next_day
same_day
none
date
string
Optional
The date of the disbursement (YYYY-MM-DD)
failure_reason
string
Optional
A reason for the failure if any exists
Errors
400
Bad Request
400
Bad Request
401
Unauthorized
404
Not Found
404
Not Found
429
Too Many Requests
500
Internal Server Error
Built with