VTEX · Schema

1.RetrieveTokenRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
applicationId string This value is always identified as `vtex`.
returnUrl string VTEX website URL. You will redirect the user after they complete login on the payment provider's website. The URL should contain a query string parameter called `authorizationCode` which will be passe
View JSON Schema on GitHub

JSON Schema

vtex-1retrievetokenrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/1.RetrieveTokenRequest",
  "title": "1.RetrieveTokenRequest",
  "required": [
    "applicationId",
    "returnUrl"
  ],
  "type": "object",
  "properties": {
    "applicationId": {
      "type": "string",
      "description": "This value is always identified as `vtex`."
    },
    "returnUrl": {
      "type": "string",
      "description": "VTEX website URL. You will redirect the user after they complete login on the payment provider's website. The URL should contain a query string parameter called `authorizationCode` which will be passed empty and which you must fill in before returning the user."
    }
  },
  "example": {
    "applicationId": "vtex",
    "returnUrl": "https://storevtex.vtexpayments.com/?authorizationCode="
  }
}