Request Sandbox KeysSee a Demo
  • Overview
    • Quickstart
    • Payments and Disbursements
    • Errors
    • Webhooks
  • Guides
    • Compliance
    • Starter Mode
    • KYC
    • Line of Credit program
    • Buy Now Pay Later program
  • API Reference
LogoLogo
Request Sandbox KeysSee a Demo
API ReferencePayments

POST
/payments
POST
/api/payments
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  "settlement_priority": "same_day",
9  "ach_authorization_id": "doc_43da3b3f95c745e1985a71e9a00d6c27"
10}'
Try it
200Successful
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}
Was this page helpful?
Previous

Get a payment by ID

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
facility_idstringRequired

The facility_id of the credit facility to make a payment for

amountintegerRequired
The amount of the payment, in cents
transfer_typeenumRequired
The type of transfer to use for the payment (ACH or none [ledger only])
Allowed values:
settlement_priorityenumOptional
The speed at which the transfer should execute when ACH is used
Allowed values:
ach_authorization_idstringOptional
The Document ID of an unused ACH authorization document (only required when `transfer_type` is not `none`)

Response

This endpoint returns an object.
idstring
amountinteger
The amount of the payment, in cents
facility_idstring

The facility_id of the credit facility to make a payment for

statusenum
The status of the payment
transfer_typeenum
The type of ACH transfer
created_ondatetime
Timestamp the payment is created on
failure_reasonstring or null
A reason for the failure if one exists
is_autopayboolean or null
If the payment was a result of an autopay

Errors

The type of transfer to use for the payment (ACH or none [ledger only])

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

The Document ID of an unused ACH authorization document (only required when transfer_type is not none)