VTEX · Schema

CreateAuthorizationTokenRequest

Create authorization token request body information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
applicationId	string	VTEX application identifier.
returnUrl	string	The base URL you need to use to form the final URL when redirecting the merchant back to VTEX.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateAuthorizationTokenRequest",
  "title": "CreateAuthorizationTokenRequest",
  "required": [
    "applicationId",
    "returnUrl"
  ],
  "type": "object",
  "description": "Create authorization token request body information.",
  "properties": {
    "applicationId": {
      "type": "string",
      "description": "VTEX application identifier.",
      "example": "vtex"
    },
    "returnUrl": {
      "type": "string",
      "description": "The base URL you need to use to form the final URL when redirecting the merchant back to VTEX.",
      "example": "https://admin.mystore.example.com/provider-return?authorizationCode="
    }
  }
}