find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/vtex-provider-api"

All apis

curl "https://apis.io/api/v1/apis?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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: VTex GiftCard Hub Provider API
  description: '>ℹ️ Check the new Payments onboarding guide.'
  contact: {}
  version: '1.0'
servers:
- url: https://{accountName}.{environment}.com.br
  description: VTEX server URL.
  variables:
    accountName:
      description: Name of the VTEX account. Used as part of the URL.
      default: apiexamples
    environment:
      description: Environment to use. Used as part of the URL.
      enum:
      - vtexcommercestable
      default: vtexcommercestable
security:
- appKey: []
  appToken: []
- VtexIdclientAutCookie: []
tags:
- name: Provider
paths:
  /api/giftcardproviders:
    get:
      tags:
      - Provider
      summary: VTex List All GiftCard Providers
      description: 'Returns a collection of gift card providers from a store.


        ## Permissions


        Any user or application key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:


        | **Product** | **Category** | **Resource** |

        | --------------- | ----------------- | ----------------- |

        | GiftCard | GiftCard | **View Gift Card providers** |


        There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see Authentication overview.


        >❗ To prevent integrations from having excessive permissions, consider the best practices for managing app keys when assigning License Manager roles to integrations.'
      operationId: ListAllGiftCardProviders
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: Accept
        in: header
        description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: REST-Range
        in: header
        description: Pagination control. This query variable must follow the format `_resources={from}-{to}_`.
        required: false
        style: simple
        schema:
          type: string
          default: resources=0-49
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Gift card provider identification.
                    serviceUrl:
                      type: string
                      description: URL from the provider.
                    oauthProvider:
                      type: string
                      description: Provider's authentication.
                    preAuthEnabled:
                      type: boolean
                      description: Related to the pre-authorization that can happen on the transaction generated through the provider.
                    cancelEnabled:
                      type: boolean
                      description: Indicates whether it is possible to cancel the transaction, generated through the provider.
                    _self:
                      type: object
                      description: Object that carries an auto reference from the provider at the Hub (on its API).
                      properties:
                        href:
                          type: string
                          description: 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`.
              example:
              - id: GiftCardExample
                serviceUrl: https://api.vtex.com.br/basedevmkp
                oauthProvider: vtex
                preAuthEnabled: true
                cancelEnabled: true
                _self:
                  href: cosmet/giftcardproviders/GiftCardExample
              - id: GiftCardExample2
                serviceUrl: https://giftcard--cosmetics2.myvtex.com/my-provider
                oauthProvider: vtex
                caption: My Updated Gift Card Provider
                preAuthEnabled: true
                cancelEnabled: true
                _self:
                  href: cosmet/giftcardproviders/GiftCardExample2
      deprecated: false
  /api/giftcardproviders/{giftCardProviderId}:
    get:
      tags:
      - Provider
      summary: VTex Get GiftCard Provider by ID
      description: 'Returns a gift card provider from a store.


        ## Permissions


        Any user or application key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:


        | **Product** | **Category** | **Resource** |

        | --------------- | ----------------- | ----------------- |

        | GiftCard | GiftCard | **View Gift Card providers** |


        There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see Authentication overview.


        >❗ To prevent integrations from having excessive permissions, consider the best practices for managing app keys when assigning License Manager roles to integrations.'
      operationId: GetGiftCardProviderbyID
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: Accept
        in: header
        description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: giftCardProviderId
        in: path
        description: Gift card provider identification.
        required: true
        style: simple
        schema:
          type: string
          example: GiftCardExample
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Gift card provider identification.
                  serviceUrl:
                    type: string
                    description: URL from the provider.
                  oauthProvider:
                    type: string
                    description: Provider's authentication.
                  caption:
                    type: string
                    description: Description about the provider.
                  preAuthEnabled:
                    type: boolean
                    description: Related to the pre-authorization that can happen on the transaction generated through the provider.
                  cancelEnabled:
                    type: boolean
                    description: Indicates whether it is possible to cancel the transaction, generated through the provider.
                  _self:
                    type: object
                    description: Object that carries an auto reference from the provider at the Hub (on its API).
                    items:
                      type: object
                      properties:
                        href:
                          type: string
                          description: 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`.
              example:
                id: GiftCardExample
                serviceUrl: https://api.vtex.com.br/basedevmkp
                oauthProvider: vtex
                caption: My Updated Gift Card Provider
                preAuthEnabled: true
                cancelEnabled: true
                _self:
                  href: cosmet/giftcardproviders/GiftCardExample
        '500':
          description: Object reference not set to an instance of an object (The gift card provider described does not exist).
      deprecated: false
    put:
      tags:
      - Provider
      summary: VTex Create/Update GiftCard Provider by ID
      description: 'Create or update a gift card provider from a store.


        ## Permissions


        Any user or application key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:


        | **Product** | **Category** | **Resource** |

        | --------------- | ----------------- | ----------------- |

        | GiftCard | GiftCard | **Edit Gift Card providers** |


        There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see Authentication overview.


        >❗ To prevent integrations from having excessive permissions, consider the best practices for managing app keys when assigning License Manager roles to integrations.'
      operationId: Create/UpdateGiftCardProviderbyID
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: Accept
        in: header
        description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: giftCardProviderId
        in: path
        description: Gift card provider identification.
        required: true
        style: simple
        schema:
          type: string
          example: GiftCardExample
      requestBody:
        content:
          application/vnd.vtex.giftcardproviders.v1+json:
            schema:
              $ref: '#/components/schemas/CreateUpdateGiftCardProviderbyIDRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Gift card provider identification.
                  serviceUrl:
                    type: string
                    description: URL from the provider.
                  oauthProvider:
                    type: string
                    description: Provider's authentication.
                  preAuthEnabled:
                    type: boolean
                    description: Related to the pre-authorization that can happen on the transaction generated through the provider.
                  cancelEnabled:
                    type: boolean
                    description: Indicates whether it is possible to cancel the transaction, generated through the provider.
                  _self:
                    type: object
                    description: Object that carries an auto reference from the provider at the Hub (on its API).
                    items:
                      type: object
                      properties:
                        href:
                          type: string
                          description: 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`.
              example:
                id: GiftCardExample3
                serviceUrl: https://api.vtex.com.br/basedevmkp
                oauthProvider: vtex
                preAuthEnabled: true
                cancelEnabled: true
                _self:
                  href: cosmetics2/giftcardproviders/GiftCardExample3
      deprecated: false
    delete:
      tags:
      - Provider
      summary: VTex Delete GiftCard Provider by ID
      description: 'Delete a gift card provider from a store.


        ## Permissions


        Any user or application key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:


        | **Product** | **Category** | **Resource** |

        | --------------- | ----------------- | ----------------- |

        | GiftCard | GiftCard | **Edit Gift Card providers** |


        There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about authentication at VTEX, see Authentication overview.


        >❗ To prevent integrations from having excessive permissions, consider the best practices for managing app keys when assigning License Manager roles to integrations.'
      operationId: DeleteGiftCardProviderbyID
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: Accept
        in: header
        description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: giftCardProviderId
        in: path
        description: Gift card provider identification.
        required: true
        style: simple
        schema:
          type: string
          example: GiftCardExample
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        '404':
          description: 'The gift card provider described does not exist.

            '
      deprecated: false
components:
  schemas:
    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
  securitySchemes:
    appKey:
      type: apiKey
      in: header
      name: X-VTEX-API-AppKey
      description: Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
    appToken:
      type: apiKey
      in: header
      name: X-VTEX-API-AppToken
      description: Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys).
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'