Cancel a payment

POST
/payments/:payment_id/cancel

Cancels a submitted payment before it is sent to the ACH network. Payments can only be canceled if they are still in the pending state and have not been submitted to the ACH network. After a payment 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 payment 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 payment or wait for a subsequent webhook to see if it was successfully canceled or processed.

Path parameters

payment_idstringRequired

Response

This endpoint returns an object.
idstring
amountinteger

The amount of the payment, in cents

facility_idstring

The facility_id of the credit facility to make a payment for

statusenum

The status of the payment

transfer_typeenum

The type of ACH transfer

created_ondatetime

Timestamp the payment is created on

failure_reasonstringOptional

A reason for the failure if one exists

is_autopaybooleanOptional

If the payment was a result of an autopay

Errors