Log In

Update an EBT Payment for deferred capture


This documentation is deprecated.

Please refer to the public page at: https://docs.joinforage.app/reference/update-a-payment

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.

Click Try It! to start a request and see the response here!