VTvtex
Transaction process

Update additional data

Changed on

This request is used to update any information that has previously been sent on endpoint Send additional data, if required.

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:

ProductCategoryResource
PCI GatewayPayment-Make PaymentsProcess 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.

patch/api/pvt/transactions/{transactionId}/additional-data

Request

  • Base URL
    https://apiexamples.vtexpayments.com.br
  • URL
    https://apiexamples.vtexpayments.com.br/api/pvt/transactions/{transactionId}/additional-data
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

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

OK

This endpoint does not return a response body.

Changes

  • 7f58d8045a19Revision changes
    • info

      api tag Transaction process added

    • info

      api tag Transaction Process removed

  • aca4931fa22bRevision changes
    • info

      the endpoint scheme security VtexIdclientAutCookie was added to the API

    • info

      the endpoint scheme security appKey AND appToken was added to the API