API ReferenceFacilities

Refund a disbursement

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

Path parameters

facility_idstringRequired
disbursement_idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

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

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

Allowed values:
datestring or null

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

failure_reasonstring or null
A reason for the failure if any exists

Errors