Cancel a payment

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Cancel can only be used on ACH credit payments associated with funded payrolls whose payment attempt has not yet been transmitted to the payment processor. These payments have a 'draft' or 'processing' status — a payment reads 'processing' from the moment it is created with the processor, which is before it is transmitted — so use the can_cancel boolean rather than the status to determine whether a payment can be canceled.

Cancel must be used prior to the payment's fulfillment being sent out. This is denoted by the cancel_deadline field and is generally around 1 pm ET the day before the payday of the credit's associated payroll.

Canceled payments have a status of failed.

[08/15 Sandbox Only] Canceled payments have a status ofcanceled.

Path Params
string
required
Defaults to ID of payment desired for cancellation
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json