---
title: "Partially or totally refund a settlement"
method: POST
path: "/api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/refunds"
tags: ["Account"]
---

# Partially or totally refund a settlement

`POST /api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/refunds`

## Request

- Base URL: `https://apiexamples.vtexcommercestable.com.br`
- URL: `https://apiexamples.vtexcommercestable.com.br/api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/refunds`
- Auth: one of:
  - API key in header `X-VTEX-API-AppKey` and API key in header `X-VTEX-API-AppToken`
  - API key in header `VtexIdclientAutCookie`

Refunds a value from an already settled transaction.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Path parameters

- `creditAccountId` string, required
- `transactionId` string, required

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Request body

- object
  - `value` number, required: Refund amount. This number must always be less than or equal to the value of the captured transaction.

## Response `200`

OK

- object
  - `value` number, required: Refunded amount.

## Changes

- **2023-12-21** `0cfe5b381175`: 7 warning
  - the optional response header `connection` removed for the status `200`
  - the optional response header `content-length` removed for the status `200`
  - the optional response header `content-type` removed for the status `200`
  - the optional response header `date` removed for the status `200`
  - …3 more
- **2023-11-24** `c8735f67eb83`: 2 breaking, 1 info
  - the `value` request property type changed from `string` to `number`
  - removed the required property `id` from the response with the `200` status
  - the `value` request property default value `20` was removed

[Operation history](https://skmtc.dev/vtex/apis/customer-credit-api/changes/api/creditcontrol/accounts/:creditAccountId/transactions/:transactionId/refunds/post.md)

---

[API](https://skmtc.dev/vtex/apis/customer-credit-api.md) - [All operations](https://skmtc.dev/vtex/apis/customer-credit-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vtex/apis/customer-credit-api/revisions/831ad1f05e7d?raw)