Create a PaymentRefund

✅

This endpoint is only relevant to Forage SDK integrations.

If you’re building with the Fully Hosted or Custom Forage Checkout UI instead, then use the Order Refunds endpoints.

🚧

This endpoint does not return the customer's updated EBT balance.

On immediate success, the PaymentRefund status in the response body is processing, so the balance returned reflects a pre-refund amount. To retrieve a customer's updated EBT balance after status is succeeded, send a GET to /payments/{payment_ref}/refunds.

Creates a new refund object and immediately begins processing the
refund.

Unlike adding a payment, which is not processed until the payment is
captured, this request will have immediate financial side effects.

HTTP Status Code

This endpoint always returns a 201 status code if the Refund was
submitted for processing, even if the refund attempt fails, because a
Refund object is created on the Forage server to preserve a record of
the failed Refund attempt. Therefore, even if your app receives a 201
HTTP status code from the Forage Payments API, it will still need to
check the status of the Refund response is succeeded. If the
status is failed, please check the refund_errors field in the
response for more detail.