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.
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: standardnext_daysame_daynone
The type of transfer to use for the disbursement
datestringOptional
The date of the disbursement (YYYY-MM-DD)
failure_reasonstringOptional
A reason for the failure if any exists

Errors