Facilities

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.

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

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)

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.