patch https://{environment}.joinforage.app/api/payments//
Update Payment Requests Server-Side
To keep your app secure, requests to update a
Paymentshould 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:
metadataexternal_order_id
During these statuses, Forage ignores attempts to update other Payment fields.
Required For Server-Side Capture
You need to use this endpoint if you're building an integration that defers payment capture to the server.