At VTEX, payment providers have the option of using Payment Provider Protocol (PPP) endpoints to record additional information that they consider essential for processing a transaction. This can include data related to orders or other platform modules, payment identifiers created by the provider, and internal operations logs.

To use this functionality, it is necessary to create metadata information fields on the PPP endpoints.

To use metadata in the provider's payment transactions, follow the steps below:

1. Update the provider manifest to include the metadataFields array and forward it to VTEX. This array must contain a maximum of 3 strings, each with a maximum length of 20 characters, which will represent the names of the metadata fields to be sent by the provider. See an example below:

2. Add the connectorMetadata array to the request body of the following endpoints (Create Payment, Cancel Payment, Settle Payment, Refund Payment and Inbound Request (BETA)). The array must contain the following information:

   • name: string that identifies the name of the metadata field inserted in the provider manifest (maximum limit of 20 characters).
   • value: string containing the metadata (maximum limit of 200 characters).

See an example below:

3. After sending one of the endpoint requests from the previous step, the response body will return the payment and metadata information, indicating that they were stored in the VTEX gateway. See an example of the response body from the Refund Payment endpoint.