Get transaction settlement details

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 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.