Create a Refund associated with an existing Purchase.
Catch can process one or more refund events associated with a particular Purchase.
Note that Catch enforces merchant_refund_id uniqueness. As a result:
If multiple requests contain identical values for both the merchant_refund_id and the refund_amount, Catch will treat requests after the first valid one as duplicates and not create new refund events.
Catch will reject requests that reuse a merchant_refund_id value with a refund_amount other than the value in the original, successful request. Catch treats these as invalid refund requests.
Path
POST https://<environment>.getcatch.com/v1/purchases/<purchase_id>/refunds
Variable name
Description
Possible values
<environment>
The Catch environment in which you’re making the request.
Within appeasement_details, Contains details on total appeasement amount and currency
Why does Catch ask for appeasement information?
Catch offers a configurable reward option that allows a merchant to set reward offers on specific SKUs. If this configurable reward option is in use, Catch reviews the SKUs returned to understand how to best handle the user's earned rewards. While a returned SKU may indicate the need to cancel a SKU-based reward, appeasements provided to the customer, such as a return of shipping costs, will not impact SKU-based rewards. For clarity of intent, we expect refunds to be itemized across the order's SKUs (via the Items array) and any appeasements (via the Appeasement Details object).
Total Amount object
Parameter Name
Necessity
Format
Description
amount
optional
integer
The sum of all appeasements, in cents.
currency
optional
string (ISO 4217)
The currency in which the amounts are represented.