Update an OrderPayment

✅

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

If you're building with a Forage SDK, then use the Payments endpoints.

🚧

To keep your app secure, requests to update an OrderPayment should only be generated on the server-side.

A PATCH request to /orders/{order_ref}/payments/{payment_ref}/ updates an existing Forage OrderPayment.

On success, the API responds with the updated OrderPayment object.

The status property of the OrderPayment determines what data can be updated. If the status is processing, cancelled, or succeeded, then only the following Payment fields can be modified:

• metadata
• external_order_id

During these statuses, Forage ignores attempts to update other OrderPayment fields.