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 POST request to /orders/{order_ref}/payments/{payment_ref}/ updates an existing OrderPayment. On success, the API responds with the OrderPayment.

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

  • metadata
  • external_order_id

Forage ignores attempts to update other fields.

In the case of a failed status, this endpoint can be used to set an updated payment_method and then reattempt the charge.

Language
Authorization
OAuth2
URL