Refund a disbursement — Pier

Refunds a specified disbursement in full. This endpoint is intended for correcting erroneous transactions.

facility_idstringRequired

disbursement_idstringRequired

This endpoint returns an object.

amountinteger

The amount of the disbursement, in cents (e.g. 1000 = $10.00)

created_ondatetime

Timestamp the disbursement object is created on

facility_idstring

idstring

The id of the disbursement

refund_metadataobject

Metadata about the original transaction being refunded

statusenum

The status of the disbursement

transfer_typeenum

Allowed values: standardnonerefundcancellationsuspense_refund

The type of transfer that the disbursement was (ACH, ledger only, or special cases like refunds)

datestringOptional

The date of the disbursement (YYYY-MM-DD)

failure_reasonstringOptional

A reason for the failure if any exists

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	"date": "string",
14	"failure_reason": "string"
15	}

1	curl -X POST https://production.pier-finance.com/api/facilities/:facility_id/disbursements/:disbursement_id/refund \
2	-H "Authorization: Bearer <token>"