Facilities

Credit a facility

POST
Credit a facility

Path parameters

facility_idstringRequired

Request

This endpoint expects an object.
amount
integerRequired
The amount to credit the facility, in cents (e.g. 1000 = $10.00)
memo
stringOptional
A memo to attach to the credit
original_disbursement_id
stringOptional
Disbursement ID associated with the credit action (if applicable)
original_payment_id
stringOptional
Payment ID associated with the credit action (if applicable)

Response

This endpoint returns an object
amount
integer
The amount of the payment, in cents
created_on
datetime
Timestamp the payment is created on
facility_id
string

The facility_id of the credit facility to make a payment for

id
string
refund_metadata
object
Metadata about the original transaction being refunded
status
enum
The status of the payment
Allowed values: pendingprocessingsettledfailedcancelled
transfer_type
enum
The type of ACH transfer
Allowed values: standardnext_daysame_daynone
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/facilities/:facility_id/credit \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "amount": 0
6}'
1{
2 "amount": 0,
3 "created_on": "2023-01-01T00:00:00Z",
4 "facility_id": "string",
5 "id": "string",
6 "refund_metadata": {
7 "original_payment_id": "string",
8 "original_disbursement_id": "string",
9 "memo": "string"
10 },
11 "status": "pending",
12 "transfer_type": "standard",
13 "failure_reason": "string",
14 "is_autopay": true
15}