Payments

Submit a loan payment

POST

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

Request

This endpoint expects an object.
facility_id
stringRequired

The facility_id of the credit facility to make a payment for

amount
integerRequired
The amount of the payment, in cents
transfer_type
enumRequired
The type of ACH transfer
Allowed values: standardnext_daysame_daynone
ach_authorization_id
stringRequired
The Document ID of an unused ACH authorization document

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
Allowed values: pendingprocessingsettledfailedcancelled
transfer_type
enum
The type of ACH transfer
Allowed values: standardnext_daysame_daynone
created_on
datetime
Timestamp the payment is created on
failure_reason
stringOptional
A reason for the failure if one exists
is_autopay
booleanOptional
If the payment was a result of an autopay

Errors

POST
1curl -X POST https://production.pier-finance.com/api/payments \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
6 "amount": 100000,
7 "transfer_type": "standard",
8 "ach_authorization_id": "doc_43da3b3f95c745e1985a71e9a00d6c27"
9}'
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}