v50

latestOpenAPI 3.0.0raw.githubusercontent.com2025-08-28250234.8 KB

Account

Partially or totally refund a settlement

Refunds a value from an already settled transaction.

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:

Product	Category	Resource
Credit Control	Main	Main Access
Credit Control	Statements	Create Statements

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.

post/api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/refunds

Path parameters

creditAccountIdstring required

Example:01bce461-9g03-12ds-8217-b3d39271e15b

Credit account identification.

transactionIdstring required

Example:B2E754DCD7304D22866CB6F221CF0FEB

Pre-authorization identification.

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

valuenumber required

Refund amount. This number must always be less than or equal to the value of the captured transaction.

Example request

{
  "value": 30
}

Response

valuenumber required

Refunded amount.