This endpoint is only relevant to Fully Hosted and Custom integrations.

If you’re building with a Forage SDK, then use the Payment Refunds endpoints.

Learn more about the high-level phases of an SDK integration in the Forage JS Quickstart, or check out the Payments API introduction for a list of resources by integration type.

This request will attempt to refund all payments associated with the referenced Order to their original payment method, net of any already processed refunds.

If there are still-processing refunds associated with the order, then this endpoint will return a 400 response until those refunds have resolved.

Once each refund is processed successfully, a POST request will be made to your client indicating whether that refund succeeded or failed. Note that the number of webhook requests you receive will equal the number of refunds attached to this order.

Click Try It! to start a request and see the response here!