PIpier-finance
Facilities

Refund a disbursement

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

post/facilities/{facility_id}/disbursements/{disbursement_id}/refund

Request

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

Path parameters

facility_idstring required
disbursement_idstring required

Response

idstring required

The id of the disbursement

facility_idstring required
amountinteger required

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

status'pending' | 'processing' | 'processed' | 'settled' | 'failed' | 'canceled' | 'cancellation_pending' required
failure_reasonstring nullable

A reason for the failure if any exists

datestring nullable

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

created_onstring date-time required

Timestamp the disbursement object is created on

transfer_type'standard' | 'none' | 'refund' | 'cancellation' | 'suspense_refund' required

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).

Example response

{
  "id": "dsb_18e5a3726b3943cda2635f40e1041ba4",
  "amount": 100000,
  "created_on": "2023-02-27T00:00:00Z"
}

Changes

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