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
Auth
Borrowers
Configuration
Coverage
Facilities
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
API Reference
Payments
Get a payment by ID
GET
https://production.pier-finance.com/api
/
payments
/
:payment_id
Get a payment by its id
Path parameters
payment_id
string
Required
Response
This endpoint returns an object.
id
string
amount
integer
The amount of the payment, in cents
facility_id
string
The facility_id of the credit facility to make a payment for
status
enum
The status of the payment
Show 6 enum values
transfer_type
enum
Allowed values:
standard
next_day
same_day
none
The type of ACH transfer
created_on
datetime
Timestamp the payment is created on
failure_reason
string
Optional
A reason for the failure if one exists
is_autopay
boolean
Optional
If the payment was a result of an autopay
Errors
400
Bad Request
401
Unauthorized
404
Not Found
429
Too Many Requests
500
Internal Server Error
Built with