Facilities

Refund a disbursement

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

Path parameters

facility_idstringRequired
disbursement_idstringRequired

Response

This endpoint returns an object
amount
integer
The amount of the disbursement, in cents (e.g. 1000 = $10.00)
created_on
datetime
Timestamp the disbursement object is created on
facility_id
string
id
string
The id of the disbursement
refund_metadata
object
Metadata about the original transaction being refunded
status
enum
The status of the disbursement
Allowed values: pendingprocessingsettledfailedcancelled
transfer_type
enum
The type of transfer to use for the disbursement
Allowed values: standardnext_daysame_daynone
date
stringOptional
The date of the disbursement (YYYY-MM-DD)
failure_reason
stringOptional
A reason for the failure if any exists

Errors

POST
1curl -X POST https://production.pier-finance.com/api/facilities/:facility_id/disbursements/:disbursement_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 "date": "string",
14 "failure_reason": "string"
15}