put https://{accountName}.{environment}.com.br/api/giftcardproviders/
Create or update a giftcard provider from a store.
Warning
- You should provide an
appKey
andappToken
that will be sent using the headersX-PROVIDER-API-AppKey
andX-PROVIDER-API-AppToken
, respectively. These headers should be validated by your application.
Response body has the following properties:
Name | Type | Mandatory | Description |
---|---|---|---|
id |
string | Yes | Gift Card provider’s id |
serviceUrl |
string | Yes | URL from the provider |
oauthProvider |
string | Yes | Provider’s authentication |
caption |
string | Description about the provider | |
preAuthEnabled |
boolean | Yes | Related to the pre-authorization that can happen on the transaction generated through the provider |
cancelEnabled |
boolean | Yes | It says if it is possible to cancel the transaction, generated through the provider |
appToken |
string | Credential that will identify the provider inside VTEX | |
appKey |
string | Credential that will identify the provider inside VTEX | |
_self |
object | Yes | It is an object that carries an auto reference from the provider at the Hub (on its API) |
↳href |
string | Yes | This is one of the fields inside the _self . It is exactly the route that identifies this provider on the Hub’s API, but it is not the same thing as the serviceURL |
Response body example:
{
"id": "",
"serviceUrl": "",
"oauthProvider": "",
"caption": "",
"preAuthEnabled": true,
"cancelEnabled": true,
"appToken": "",
"appKey": "",
"_self": {
"href": ""
}
}