Payments

Refund a payment

POST
Refunds a specified payment in full. This endpoint is intended for correcting erroneous transactions. Only customers with ACH disabled can refund payments.

Path parameters

payment_idstringRequired

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/payments/:payment_id/refund \
2 -H "Authorization: Bearer <token>"
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}