---
title: "Get transaction settlement details"
method: GET
path: "/api/pvt/transactions/{transactionId}/settlements"
tags: ["Transaction process"]
---

# Get transaction settlement details

`GET /api/pvt/transactions/{transactionId}/settlements`

Returns settlement data associated with a specific transaction.

The response body of this endpoint may return different information depending on the status of the settlement request for the queried transaction:

- **Transaction settlement not requested or initiated:** The response body does not return any data.

- **Settlement request initiated, but not completed as there are items that have not yet been invoiced in the order:** The response body will only display the `request` array information.

- **Transaction settlement completed:** The response body will display the `request` and `actions` arrays information.

## 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** |
| --------------- | ----------------- | ----------------- |
| PCI Gateway | Payment-Make Payments | **View Payment Data** |

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

- `transactionId` string, required

## Headers

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

## Response `200`

OK

- TransactionSettlementDetails — Transaction settlement details response body information.
  - `requests` Request[], required — Array containing requests information.
    - `id` string, required — Transaction identification. This is the same `transactionId` value sent in the request path.
    - `date` string, required — Transaction settlement date.
    - `value` number, required — Transaction settlement value.
  - `actions` object[], required — Array containing actions information.
    - `paymentId` string, required — Payment identification.
    - `payment` object, required — Object containing the transaction settlement reference route.
      - `href` string, required — Transaction reference settlement route.
    - `date` string, required — Transaction settlement date.
    - `type` string, required — Settlement action date.
    - `value` integer, required — Transaction settlement value.
    - `connectorResponse` string, nullable, required — Connector transaction response information. This object can return different fields according to the internal configuration of each connector (payment provider), for example, `Tid`, `ReturnCode`, `authId`, among others).

## Changes

- **2026-04-20** `7f58d8045a19` — 2 info
  - api tag `Transaction process` added
  - api tag `Transaction Process` removed
- **2024-06-10** `aca4931fa22b` — 2 info
  - the endpoint scheme security `VtexIdclientAutCookie` was added to the API
  - the endpoint scheme security `appKey AND appToken` was added to the API

[Change history](https://skmtc.dev/vtex/apis/payments-gateway-api/changes/api/pvt/transactions/:transactionId/settlements/get.md)

---

[API](https://skmtc.dev/vtex/apis/payments-gateway-api.md) · [All operations](https://skmtc.dev/vtex/apis/payments-gateway-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/payments-gateway-api/revisions/c1c6fd255d0e/schema)