API ReferenceFacilities

Cancel a disbursement

Cancels a submitted disbursement before it is sent to the ACH network. Disbursements can only be canceled if they are still in the `pending` state and have not been submitted to the ACH network. After a disbursement is sent to the ACH network, you must wait for the it to settle and then you may refund it instead. In some cases if you cancel while the disbursement is in the process of being submitted to the ACH network you may see a status of `cancellation_pending` in the response. In this case, you can check the status of the disbursement or wait for a subsequent webhook to see if it was successfully canceled or processed.

Authentication

AuthorizationBearer

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

Path parameters

facility_idstringRequired
disbursement_idstringRequired

Response

This endpoint returns an object.
idstring
The id of the disbursement
facility_idstring
amountinteger

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

statusenum
The status of the disbursement
created_ondatetime
Timestamp the disbursement object is created on
transfer_typeenum

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

Allowed values:
failure_reasonstring or null
A reason for the failure if any exists
datestring or null

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

Errors