CancelPaymentRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CancelPaymentRequest",
  "title": "CancelPaymentRequest",
  "required": [
    "paymentId",
    "requestId",
    "authorizationId"
  ],
  "type": "object",
  "description": "Cancel payment request body information.",
  "properties": {
    "paymentId": {
      "type": "string",
      "description": "VTEX payment identifier.",
      "example": "F5C1A4E20D3B4E07B7E871F5B5BC9F91"
    },
    "requestId": {
      "type": "string",
      "description": "VTEX request identifier.",
      "example": "D12D9B80972C462980F5067A3A126837"
    },
    "authorizationId": {
      "type": "string",
      "description": "Payment authorization identifier (in case it was authorized previous to the cancellation request).",
      "example": "5784589"
    },
    "tid": {
      "type": "string",
      "description": "Provider's unique identifier for the transaction.",
      "example": "10022005181543584603"
    },
    "transactionId": {
      "type": "string",
      "description": "VTEX transaction ID related to this payment.",
      "example": "D3AA1FC8372E430E8236649DB5EBD08E"
    },
    "nsu": {
      "type": "string",
      "description": "Provider's unique sequential number for the transaction.",
      "example": "NSU987432"
    },
    "sandboxMode": {
      "type": "boolean",
      "description": "Indicates whether or not this request is being sent from a sandbox environment.",
      "example": false
    },
    "merchantSettings": {
      "type": "array",
      "description": "Custom fields (for the given provider) which the merchant must fill. Each element of this array is a key-value pair.",
      "items": {
        "type": "object",
        "description": "Merchant settings information.",
        "required": [
          "name",
          "value"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The custom field name.",
            "example": "Public Merchant ID Test."
          },
          "value": {
            "type": "string",
            "description": "The custom field value.",
            "example": "1"
          }
        }
      }
    },
    "connectorMetadata": {
      "type": "array",
      "description": "Array containing metadata fields sent from the provider to the payment gateway.",
      "items": {
        "type": "object",
        "description": "Metadata fields information.",
        "required": [
          "name",
          "value"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the metadata to be stored in the gateway (limited to 20 characters).",
            "example": "MetadataName"
          },
          "value": {
            "type": "string",
            "description": "The value of the metadata stored (limited to 200 characters).",
            "example": "MetadataValue"
          }
        }
      }
    }
  }
}