v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-202547455.8 KB

Transaction flow

Refund the transaction

Refunds the amount of the transaction that was previously settled.

After a transaction is settled, this request can be used to partially or fully refund the transaction amount.

Due to acquirer rules, it is not possible to perform this step online against the acquirer, and, if an error occurrs, we notify the seller company responsible by email to manually check the transaction status against the acquirer.

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
PCI Gateway	Payment-Make Payments	Process payments

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/pvt/transactions/{transactionId}/refunding-request

Path parameters

transactionIdstring required

Example:A3BDE325F76B4B758B398D900DF06150

Transaction 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

Purchase value. The value must be described without using separation for decimals, e.g. to capture a value of 320.50, send 32050.

freightnumber

Freigth value, if applicable.

taxnumber

Tax value, if applicable.

minicartobject

This field is filled with the content of the cart of the transaction, which can be obtained using Get Orders or Transaction Details endpoints. It should only be included for transactions with split payment.

Response

idstring nullable required

Settle request identification.

tokenstring required

Token identification.

statusnumber required

Status code.

statusDetailstring required

Status detail information.

processingDatestring required

Settlement processing date.

refundedValueinteger required

Refunded value.

refundedTokenstring nullable required

Refund operation token.

messagestring nullable required

Custom message.

codestring nullable required

Custom code.

connectorRefundedValuenumber required

Refunded value by connector (provider).

cancelledValueinteger required

Cancelled value.