Update a pre-authorization

Updates information for a specific pre-authorization request.

⚠️ This call can only be used for pre-authorizations that have not yet been captured or canceled.

Also known as authorization hold, card authorization or pre-auth, pre-authorization is the practice of holding this balance as unavailable until either the merchant clears the transaction, also called settlement, or the hold falls off.

This operation does not appear in statements but the available balance will be updated.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

{
  "value": 55,
  "settle": true,
  "installments": 1
}