Payments

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.

post/payments

Request

Base URL
https://production.pier-finance.com/api
Auth
HTTP bearer

Request body

facility_idstring required

The facility_id of the credit facility to make a payment for

amountinteger required

The amount of the payment, in cents

transfer_type'standard' | 'none' required

These transfer types are passed in by API users to indicate ACH or not.

settlement_priority'standard' | 'next_day' | 'same_day'

This determines the network speed used for ACH transfers.

ach_authorization_idstring nullable

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

Example request

{
  "facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
  "amount": 100000
}

Response

idstring required

amountinteger required

The amount of the payment, in cents

facility_idstring required

The facility_id of the credit facility to make a payment for

Transfer types that are not standard/none are set by special operations like the refund endpoint for example. Special types, like refund, will reference the original transaction transfer type of standard/none to determine if ACH was used if this knowledge is needed (e.g. does an ACH refund need to happen or was this ledgering only).

created_onstring date-time required

Timestamp the payment is created on

failure_reasonstring nullable

A reason for the failure if one exists

is_autopayboolean nullable

If the payment was a result of an autopay

Example response

{
  "amount": 100000,
  "facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
  "created_on": "2023-02-27T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.