Inbound Request (BETA)

Forwards a request back to your endpoint using the inboundRequestsUrl provided in the POST /payments payload.

The :action part of the path will be the same you have used to call the inboundRequestsUrl.

Request body

Name Type Mandatory Description
transactionId string Yes VTEX transaction ID related to this payment
paymentId string Yes VTEX payment ID from this payment
authorizationId string Provider's unique identifier for the authorization
tid string Provider's unique identifier for the transaction
requestData object Yes
body string Yes The original request body (when sending a JSON, it's gonna be a serialized version of it)
requestId string Yes The unique identifier for this request to ensure its idempotency

Response body

Name Type Mandatory Description
paymentId string Yes The same paymentId sent in the request
responseData object Yes
statusCode int Yes Your desired status code
contentType string Yes Your desired content-type
content string Yes Your desired content body
code string Provider's operation/error code to be logged
message string Provider's operation/error message to be logged
requestId string Yes The same requestId sent in the request

Request examples and their responses

curl --location --request POST 'https://{{providerApiEndpoint}}/payments/{{paymentId}}/refunds' \
--header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}' \
--header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
    "requestId": "LA4E20D3B4E07B7E871F5B5BC9F91",
    "transactionId": "D3AA1FC8372E430E8236649DB5EBD08E",
    "paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
    "authorizationId": "{{authorizationId}}",
    "tid": "{{tid}}",
    "requestData": {
        "body": "{{originalRequestBody}}"
  "requestId": "LA4E20D3B4E07B7E871F5B5BC9F91",
  "paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
  "responseData": {
    "statusCode": 200,
    "contentType": "application/json",
    "content": "{\"myAttribute\":\"anyValue\"}"
Click Try It! to start a request and see the response here!