Cancel a payment
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_id
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Response
This endpoint returns an object.
id
amount
The amount of the payment, in cents
facility_id
The facility_id of the credit facility to make a payment for
status
The status of the payment
transfer_type
The type of ACH transfer
created_on
Timestamp the payment is created on
failure_reason
A reason for the failure if one exists
is_autopay
If the payment was a result of an autopay