Log In

Update a Payment


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

A PATCH request to /payments/{payment_ref}/ updates an existing Forage Payment.

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

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

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

You need to use this endpoint if you're building an integration that defers payment capture to the server.