VTEX Transaction API

openapi: 3.2.0
info:
  title: Vtex Transaction API
  version: '1.0'
  contact: {}
  description: 'Operations tagged Transaction across 2 of this provider''s published API definitions: vtex-gift-card-hub-openapi-original.yml, vtex-gift-card-openapi-original.yml. Each path carries the servers of the definition it was published in.'
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
- url: https://{accountName}.{environment}.com.br/api/
  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: Transaction
paths:
  /api/giftcardproviders/{giftCardProviderId}/giftcards:
    post:
      tags:
      - Transaction
      summary: VTex Create GiftCard in GiftCard Provider
      description: 'Creates a gift card in a gift card provider.


        ## Permissions


        Any user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).


        >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.'
      operationId: CreateGiftCardinGiftCardProvider
      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/CreateGiftCardinGiftCardProviderRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Gift card identification.
                  emissionDate:
                    type: string
                    description: Gift card emission date.
                  expiringDate:
                    type: string
                    description: Gift card expiration date.
                  caption:
                    type: string
                    description: Field to be filled in if a loyalty program must be created for the gift card.
                  provider:
                    type: string
                    description: Provider name.
                  discount:
                    type: boolean
                    deprecated: true
                  currencyCode:
                    type: string
                    description: Currency code in ISO 4217.
                  transaction:
                    type: object
                    description: Transaction information.
                    properties:
                      href:
                        type: string
                        description: Gift card resource URL. The number described in the URL refers to the gift card identification.
              example:
                id: '38'
                emissionDate: '2023-06-27T17:02:19.17'
                expiringDate: '2023-09-27T17:02:19.17'
                caption: Loyalty Program
                provider: GiftCardExample
                discount: 'false'
                currencyCode: USD
                transactions:
                  href: cosmetics2/giftcardproviders/GiftCardExample/giftcards/38/transactions
      deprecated: false
    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
  /api/giftcardproviders/{giftCardProviderId}/giftcards/_search:
    post:
      tags:
      - Transaction
      summary: VTex Get GiftCard from GiftCard Provider
      description: 'Returns all gift cards from a gift card provider according to the filters.


        ## Permissions


        Any user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).


        >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.'
      operationId: GetGiftCardfromGiftCardProvider
      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
      - 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/GetGiftCardfromGiftCardProviderRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Gift card identification.
                    provider:
                      type: string
                      description: Gift card provider name.
                    balance:
                      type: number
                      description: Gift card current balance.
                    _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: '262498'
                provider: GiftCardExample
                balance: 45.5
                _self:
                  href: cosmet/giftcardproviders/GiftCardExample/giftcards/262498
      deprecated: false
    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
  /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}:
    get:
      tags:
      - Transaction
      summary: VTex Get GiftCard from GiftCard Provider by ID
      description: 'Returns a specific gift card from a gift card provider.


        ## Permissions


        Any user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).


        >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.'
      operationId: GetGiftCardfromGiftCardProviderbyID
      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
      - name: giftCardId
        in: path
        description: Gift card identification.
        required: true
        style: simple
        schema:
          type: string
          example: '5'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Gift card identification.
                  redemptionToken:
                    type: string
                    description: Gift card redemption token.
                  redemptionCode:
                    type: string
                    description: Gift card identification code used at checkout. Minimum of 6 characters.
                  balance:
                    type: number
                    description: Gift card current balance. For newly created gift cards, the balance will be 0.0.
                  emissionDate:
                    type: string
                    description: Gift card emission date.
                  expiringDate:
                    type: string
                    description: Gift card expiration date.
                  currencyCode:
                    type: string
                    description: Currency code in ISO 4217.
                  discount:
                    type: boolean
                    deprecated: true
                  transactions:
                    type: object
                    description: Transactions information.
                    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: '5'
                redemptionToken: 32ScL57220Vapb8pc50HJ3mWH1cl1L8x
                redemptionCode: '***********ASDQ'
                balance: 870
                emissionDate: '2014-04-24T20:22:58.163'
                expiringDate: '2016-01-01T00:00:00'
                currencyCode: USD
                discount: false
                transactions:
                  href: cards/954/transactions
      deprecated: false
    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
  /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions:
    get:
      tags:
      - Transaction
      summary: VTex List All GiftCard Transactions
      description: 'Returns the IDs of all transactions performed on a gift card.


        ## Permissions


        Any user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).


        >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.'
      operationId: ListAllGiftCardTransactions
      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
      - name: giftCardId
        in: path
        description: Gift card identification.
        required: true
        style: simple
        schema:
          type: string
          example: 7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  cardId:
                    type: string
                    description: Gift card identification.
                  id:
                    type: string
                    description: Transaction identification.
                  _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:
              - cardId: 7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70
                id: jac68316306453f4b8tr3fdb892dfba1
                _self:
                  href: cosmetics2/giftcardproviders/GiftCardExample3/giftcards/7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70/transactions/jac68316306453f4b8tr3fdb892dfba1
              - cardId: 7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70
                id: g4a348e1d1f146ba25e19bb016cc6f18
                _self:
                  href: cosmetics2/giftcardproviders/GiftCardExample3/giftcards/7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70/transactions/g4a348e1d1f146ba25e19bb016cc6f18
      deprecated: false
    post:
      tags:
      - Transaction
      summary: VTex Create GiftCard Transaction
      description: 'Creates a transaction (credit or debit) to a gift card.


        ## Permissions


        Any user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).


        >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.'
      operationId: CreateGiftCardTransaction
      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
      - name: giftCardId
        in: path
        description: Gift card identification.
        required: true
        style: simple
        schema:
          type: string
          example: '6'
      requestBody:
        content:
          application/vnd.vtex.giftcardproviders.v1+json:
            schema:
              $ref: '#/components/schemas/CreateGiftCardTransactionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  cardId:
                    type: string
                    description: Gift card identification.
                  id:
                    type: string
                    description: Transaction identification.
                  _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:
                cardId: '24'
                id: 68347b311ce5407c90fa5316975d047a
                _self:
                  href: gatewayqa/giftcards/24/transactions/68347b311ce5407c90fa5316975d047a
      deprecated: false
    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
  /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{transactionId}:
    get:
      tags:
      - Transaction
      summary: VTex Get GiftCard Transaction by ID
      description: 'Returns a specific transaction from a gift card.


        ## Permissions


        Any user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).


        >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.'
      operationId: GetGiftCardTransactionbyID
      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
      - name: giftCardId
        in: path
        description: Gift card identification.
        required: true
        style: simple
        schema:
          type: string
          example: 7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70
      - name: transactionId
        in: path
        description: Transaction identification.
        required: true
        style: simple
        schema:
          type: string
          example: jac68316306453f4b8tr3fdb892dfba1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: number
                    description: Transaction value.
                  description:
                    type: string
                    description: Transaction description.
                  date:
                    type: string
                    description: Date of the transaction in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`)
                  requestId:
                    type: string
                    description: VTEX request identifier.
                  settlement:
                    type: object
                    description: Settlement transaction information.
                    properties:
                      href:
                        type: string
                        description: Gift card resource URL. The first number described in the URL refers to the gift card identification. The second number, refers to the transaction identification.
                  cancellation:
                    type: object
                    description: Cancellation transaction information.
                    properties:
                      href:
                        type: string
                        description: Gift card resource URL. The first number described in the URL refers to the gift card identification. The second number, refers to the transaction identification.
                  authorization:
                    type: object
                    description: Authorization transaction information.
                    properties:
                      href:
                        type: string
                        description: Gift card resource URL. The first number described in the URL refers to the gift card identification. The second number, refers to the transaction identification.
                  operation:
                    type: string
                    description: Operation information (`Credit` or `Debit`).
              example:
                value: 140
                description: GiftCardHub
                date: '2023-06-02T18:24:49.252855Z'
                requestId: '3'
                settlement:
                  href: cosmetics2/giftcardproviders/GiftCardExample3/giftcards/7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70/transactions/jac68316306453f4b8tr3fdb892dfba1/settlements
                cancellation:
                  href: cosmetics2/giftcardproviders/GiftCardExample3/giftcards/7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70/transactions/jac68316306453f4b8tr3fdb892dfba1/cancellations
                authorization:
                  href: cosmetics2/giftcardproviders/GiftCardExample3/giftcards/7d1dfc17-989e-4t21-8b7f-5103c6a5b925c_70/transactions/jac68316306453f4b8tr3fdb892dfba1/authorization
                operation: Credit
      deprecated: false
    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
  /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/authorization:
    get:
      tags:
      - Transaction
      summary: VTex Get GiftCard Transaction Authorization
      description: "Returns information about a gift card transaction authorization. \n\n## Permissions\n\nAny user or [application key](https://developers.vtex.com/docs/guides/authentication-overview#application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:\n\n| **Product** | **Category** | **Resource** |\n| --------------- | ----------------- | ----------------- |\n| GiftCard | GiftCard | **View Gift Card providers** |\n\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).\n\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: GetGiftCardAuthorizationTransaction
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: 

# --- truncated at 32 KB (100 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/openapi/vtex-transaction-api-openapi.yml