Transaction process

Send additional data

This request sends additional data related to the transaction, such as profile information, shopping cart, shipping data, among others.

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}/additional-data

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

namestring required

Dataset name. This information must be sent in escaped JSON format.

valuestring required

Dataset values. This information must be sent in escaped JSON format.

Response

This endpoint does not return a response body.

Changes

Changed in 8 of the 52 revisions of this API.546

Apr 20, 20267f58d8045a192See the full diff
- ○
  api tag Transaction process added
  api-tag-added
- ○
  api tag Transaction Process removed
  api-tag-removed
Jun 10, 2024aca4931fa22b2See the full diff
- ○
  the endpoint scheme security VtexIdclientAutCookie was added to the API
  api-security-added
- ○
  the endpoint scheme security appKey AND appToken was added to the API
  api-security-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 6, 2024f2ac9712d7ce1See the full diff
- ○
  request body became optional
  request-body-became-optional
Jan 22, 20243e832ee956c61See the full diff
- ▲
  the items/value request property type/format changed from object/ to string/
  request-property-type-changed
Jan 22, 20246284eed6393b1See the full diff
- ▲
  the items/name request property type/format changed from object/ to string/
  request-property-type-changed
Jan 22, 2024dc85c746512522See the full diff
- ▲
  added the new required request property items/name
  new-required-request-property
- ▲
  added the new required request property items/value
  new-required-request-property
- ●
  removed the request property items/clientProfileData
  request-property-removed
- ●
  removed the request property items/shippingData
  request-property-removed
Jan 16, 20245f4eed6283ef1See the full diff
- ○
  the request property items/shippingData/address/country became nullable
  request-property-became-nullable
Jan 16, 2024a38afb87a11b12See the full diff
- ▲
  the request's body type/format changed from object/ to array/
  request-body-type-changed
- ●
  removed the request property clientProfileData
  request-property-removed
- ●
  removed the request property shippingData
  request-property-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history