HomeGuidesReference↗ Forage Dashboard
Log In
Reference

Void a Payment

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 a PaymentRefund.

For EBT PaymentRefunds and voided Payments 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 original Payment 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 returned balance amount accounts for the original transaction, before the void. A customer must check their balance via PIN entry to get the post-void balance.

Path Params
string
required

A unique reference hash for the Forage Payment object, returned when the Payment was created.

Headers
string
required

An OAuth 2.0 bearer token that validates the request. You can use either a short-lived session token if the request is coming from the front-end, or an authentication token for server-side requests. Pass the token in this header after the word Bearer and a whitespace, for example Bearer <api_key>.

string
required

A unique merchant ID that Forage provides during onboarding, as in 123ab45c67. The Merchant ID can be found in the Forage sandbox or production dashboard.

string
required

An alphanumeric key that clients can use to identify repeated requests that are dropped in transit. Generate a distinct key for every unique request and only re-use keys for retries.

string

The Forage version, represented as a string with the format of a YYYY-MM-DD date.

If not specified in the request header, then the version defaults to the value set in the Forage dashboard.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json