Properties
| Name | Type | Description |
|---|---|---|
| serviceUrl | string | URL from the provider. |
| oauthProvider | string | Provider's authentication. |
| preAuthEnabled | boolean | Related to the pre-authorization that can happen on the transaction generated through the provider. |
| cancelEnabled | boolean | Indicates whether it is possible to cancel the transaction, generated through the provider. |
| appKey | string | Credential provided by the merchant that VTEX will use for identification. |
| appToken | string | Credential provided by the merchant that VTEX will use for identification. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CreateUpdateGiftCardProviderbyIDRequest",
"title": "CreateUpdateGiftCardProviderbyIDRequest",
"required": [
"serviceUrl",
"oauthProvider",
"preAuthEnabled",
"cancelEnabled"
],
"type": "object",
"properties": {
"serviceUrl": {
"type": "string",
"description": "URL from the provider.",
"example": "https://api.vtex.com.br/example"
},
"oauthProvider": {
"type": "string",
"description": "Provider's authentication.",
"example": "vtex"
},
"preAuthEnabled": {
"type": "boolean",
"description": "Related to the pre-authorization that can happen on the transaction generated through the provider.",
"example": true
},
"cancelEnabled": {
"type": "boolean",
"description": "Indicates whether it is possible to cancel the transaction, generated through the provider.",
"example": true
},
"appKey": {
"type": "string",
"description": "Credential provided by the merchant that VTEX will use for identification.",
"example": "key"
},
"appToken": {
"type": "string",
"description": "Credential provided by the merchant that VTEX will use for identification.",
"example": "token"
}
}
}
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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-createupdategiftcardproviderbyidrequest"
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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.