POS Terminal and HSA/FSA Payments Only
This endpoint is only relevant to Forage EBT POS Terminal integrations and HSA/FSA payments.
For EBT Prefer Refunds Over Voids
In most cases, instead of voiding an EBT
Payment
, create aPaymentRefund
.For EBT
PaymentRefunds
and voidedPayments
have the same impact on settlement, but refunds provide a better paper trail. The refunds API also gives you more granular control over, for example, the fraction of the originalPayment
to refund.
A POST
request to /payments/{payment_ref}/void/
voids the payment transaction.
On success, this endpoint reverses the impacts of the payment on daily net settlement. The API responds with the original Payment
object.
EBT Balance Value Doesn’t Reflect Voids
For EBT payments, the
balance
value in the response does not reflect the voided transaction. The returnedbalance
amount accounts for the original transaction, before the void. A customer must check their balance via PIN entry to get the post-void balance.