VTEX · Schema

1.RetrieveToken

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
applicationId string This value is always identified as `vtex`.
token string Payment Provider Token. Used to identify the context after you receive the redirected user to your site.
View JSON Schema on GitHub

JSON Schema

vtex-1retrievetoken-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/1.RetrieveToken",
  "title": "1.RetrieveToken",
  "required": [
    "applicationId",
    "token"
  ],
  "type": "object",
  "properties": {
    "applicationId": {
      "type": "string",
      "description": "This value is always identified as `vtex`."
    },
    "token": {
      "type": "string",
      "description": "Payment Provider Token. Used to identify the context after you receive the redirected user to your site."
    }
  },
  "example": {
    "applicationId": "vtex",
    "token": "358a5bea-07d0-4122-888a-54ab70b5f02f"
  }
}