HomeGuidesReference↗ Forage Dashboard
Log In
Reference

Void a refund by order ref.

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

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

Calling this endpoint will reverse the impacts of the refund 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 refund 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.

Responses

500

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

Updated 6 months ago

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

Updated 6 months ago