Cancel or Void a Payment

A POST request to /payments/{payment_ref}/cancel/ stops an existing Payment object from being submitted for capture in future API calls.

For EBT Payments, a Payment can only be canceled if its status is requires_confirmation or failed. For HSA/FSA payments, the Payment can only be canceled if its status is authorized.

For HSA/FSA payments, this endpoint voids a previous authorization, or prevents future authorization attempts against the Payment. A voided authorization will be removed from the cardholder's statements.