Update a Payment

This endpoint is only relevant to Forage SDK integrations.

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

A POST request to /payments/{payment_ref}/ updates an existing Payment. On success, the API responds with the Payment.

The status property of the Payment 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

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.