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