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="
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-1retrievetokenrequest"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.