HomeGuidesReference↗ Forage Dashboard
Log In
Reference

Void a payment by supplying the order and payment object refs.

post
https://{environment}.joinforage.app/api/orders//payments//void/

POS Terminal Only

This endpoint only applies to payments made via POS terminal. For other payment types, use the refunds flow.

Prefer Refunds Over Voids

Refunds and voided payments have the same impact on settlement, but refunds provide a better paper trail and more control.

Submits reversal message(s) to the EBT processor which have the effect of voiding the payment transaction.

Calling this endpoint will reverse the impacts of the payment on daily net settlement.

Path Params
string
required

The reference hash of the order that this payment belongs to

string
required

The reference hash of the order that this payment belongs to

Headers
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

500

Server Errors Something went wrong on Forage's servers. Try again.

Updated 7 months ago

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

Updated 7 months ago