VTEX · Schema

4.DoauthorizationRequest

Authorize new transaction request body information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
transactionId	string	Transaction identification.
softDescriptor	string	Custom field for a transaction that can be displayed on the customer's invoice.
prepareForRecurrency	boolean	Indicates whether the transaction supports recurrence.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/4.DoauthorizationRequest",
  "title": "4.DoauthorizationRequest",
  "required": [
    "transactionId",
    "softDescriptor",
    "prepareForRecurrency"
  ],
  "type": "object",
  "description": "Authorize new transaction request body information.",
  "properties": {
    "transactionId": {
      "type": "string",
      "description": "Transaction identification.",
      "example": "7ECE7DF3EEE14647B05DB904164923E8"
    },
    "softDescriptor": {
      "type": "string",
      "description": "Custom field for a transaction that can be displayed on the customer's invoice.",
      "example": "company_name_description_code",
      "nullable": true
    },
    "prepareForRecurrency": {
      "type": "boolean",
      "description": "Indicates whether the transaction supports recurrence.",
      "example": false
    }
  }
}