API ReferencePayments

Submit a loan payment

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

Headers

AuthorizationstringRequired

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_reasonstringOptional

A reason for the failure if one exists

is_autopaybooleanOptional

If the payment was a result of an autopay

Errors