Shift4

Shift4 Gift Cards API

The Gift Cards API from Shift4 — 9 operation(s) for gift cards.

GitHub OpenAPI

Operations 9

POST /giftcards/activate Activate #
POST /giftcards/allocate Allocate #
POST /giftcards/deactivate Deactivate #
POST /giftcards/cashout Cashout #
POST /giftcards/cashback Cashback #
POST /giftcards/reactivate Reactivate #
POST /giftcards/reload Reload #
POST /giftcards/balance Balance #
POST /giftcards/cancel Cancel #

Documentation

📖
Documentation
https://docs.shift4.com/guides/core-concepts/capturing-sales
📖
APIReference
https://docs.shift4.com/apis/payments-platform-rest/openapi
📖
Documentation
https://docs.shift4.com/guides/core-concepts/understanding-card-tokens
📖
Documentation
https://docs.shift4.com/guides/device-functionality/commerce-engine
📖
Documentation
https://docs.shift4.com/guides/alternative-payments/ach
📖
Documentation
https://docs.shift4.com/guides/alternative-payments
📖
Documentation
https://docs.shift4.com/guides/advanced-concepts/3d-secure
📖
Documentation
https://docs.shift4.com/guides/core-concepts/payment-links

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/shift4/refs/heads/main/openapi/shift4-gift-cards-api-openapi.yml

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • 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/shift4-gift-cards-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

shift4-gift-cards-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.7.57
  title: Shift4 Payment Gift Cards API
  contact:
    url: https://www.shift4.com/contact-us/
servers:
- url: https://api.shift4test.com/api/rest/v1
  description: Host Direct Test URL
- url: https://api.shift4api.net/api/rest/v1
  description: Host Direct Production URL
tags:
- name: Gift Cards
paths:
  /giftcards/activate:
    servers:
    - url: https://api.shift4test.com/api/rest/v1
      description: Host Direct Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Host Direct Production URL
    - url: https://192.168.1.10:277/api/rest/v1
      description: Locally Installed UTG URL
    - url: https://192.168.1.20:8085/api/rest/v1
      description: Commerce Engine For On Premise URL
    - url: https://api.shift4test.com/api/rest/v1
      description: Commerce Engine For Cloud Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Commerce Engine For Cloud Production URL
    post:
      tags:
      - Gift Cards
      summary: Activate
      operationId: activate
      security:
      - AccessToken: []
      description: 'This function requests that a new gift card be activated for use or that a new gift card be loaded with funds.


        **Integration Methods:**

        - Host Direct

        - Locally Installed UTG

        - Commerce Engine For On Premise

        - Commerce Engine For Cloud


        See the [Integration Methods](/guides/quickstart#integration-methods) and [URLs Section](/guides/quickstart#urls) sections of the Development Quick Start guide for details regarding each processing option.


        See the [JSON Body Schemas](/guides/quickstart#json-body-schemas) for more details on the various JSON body formats.

        '
      parameters:
      - $ref: '#/components/parameters/InterfaceVersion'
      - $ref: '#/components/parameters/InterfaceName'
      - $ref: '#/components/parameters/CompanyName'
      - $ref: '#/components/parameters/AccessToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/giftcards_activate_comengdevice'
              - $ref: '#/components/schemas/giftcards_activate_comengcloud'
              - $ref: '#/components/schemas/giftcards_activate_utgdevice'
              - $ref: '#/components/schemas/giftcards_activate_token_gtv'
              - $ref: '#/components/schemas/giftcards_activate_token_legacy'
              - $ref: '#/components/schemas/giftcards_activate_p2pe_idtech'
              - $ref: '#/components/schemas/giftcards_activate_p2pe_tdesdukpt_msr'
              - $ref: '#/components/schemas/giftcards_activate_p2pe_onguardsde_msr'
              - $ref: '#/components/schemas/giftcards_activate_unencryptedcard'
      responses:
        '200':
          description: Transaction was processed
          content:
            application/json:
              schema:
                properties:
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        dateTime:
                          $ref: '#/components/schemas/DateTime'
                        amount:
                          $ref: '#/components/schemas/AmountGCResponse'
                        card:
                          $ref: '#/components/schemas/CardResponseGC'
                        device:
                          $ref: '#/components/schemas/DeviceOnlyTIDResponse'
                        merchant:
                          $ref: '#/components/schemas/MerchantResponse'
                        server:
                          $ref: '#/components/schemas/Server'
                        transaction:
                          type: object
                          properties:
                            authSource:
                              $ref: '#/components/schemas/TransactionAuthSource'
                            invoice:
                              $ref: '#/components/schemas/TransactionInvoice'
                            responseCode:
                              $ref: '#/components/schemas/TransactionResponseCode'
              example:
                result:
                - dateTime: '2021-04-15T09:18:23.283-07:00'
                  amount:
                    total: 20
                  card:
                    number: XXXXXXXXXXXX1333
                    balance:
                      amount: 20
                    token:
                      value: '8058471748050009'
                    type: YC
                  device:
                    terminalId: '1742'
                  merchant:
                    mid: 15877
                    name: Merchant XYZ
                  server:
                    name: UTGAPI01CE
                  transaction:
                    authSource: E
                    invoice: '192030'
                    responseCode: A
        '400':
          description: Error
          content:
            application/json:
              schema:
                properties:
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        error:
                          $ref: '#/components/schemas/Error'
                        server:
                          $ref: '#/components/schemas/Server'
              examples:
                Error:
                  $ref: '#/components/examples/GiftCardActivateError'
        '504':
          $ref: '#/components/responses/TimeoutResponse'
  /giftcards/allocate:
    servers:
    - url: https://api.shift4test.com/api/rest/v1
      description: Host Direct Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Host Direct Production URL
    - url: https://192.168.1.10:277/api/rest/v1
      description: Locally Installed UTG URL
    post:
      tags:
      - Gift Cards
      summary: Allocate
      operationId: allocate
      security:
      - AccessToken: []
      description: 'This function requests that a new gift card be allocated for use under a specific Program ID. The new card will be generated during the request and activated with the requested amount.


        **Integration Methods:**

        - Host Direct

        - Locally Installed UTG

        - Commerce Engine For On Premise

        - Commerce Engine For Cloud


        See the [Integration Methods](/guides/quickstart#integration-methods) and [URLs Section](/guides/quickstart#urls) sections of the Development Quick Start guide for details regarding each processing option.

        '
      parameters:
      - $ref: '#/components/parameters/InterfaceVersion'
      - $ref: '#/components/parameters/InterfaceName'
      - $ref: '#/components/parameters/CompanyName'
      - $ref: '#/components/parameters/AccessToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - dateTime
              - amount
              - transaction
              properties:
                dateTime:
                  $ref: '#/components/schemas/DateTime'
                amount:
                  $ref: '#/components/schemas/AmountGC'
                programId:
                  $ref: '#/components/schemas/ProgramId'
                transaction:
                  type: object
                  required:
                  - invoice
                  properties:
                    invoice:
                      $ref: '#/components/schemas/TransactionInvoice'
            example:
              dateTime: '2021-04-15T09:18:23.283-07:00'
              amount:
                total: 25
              programId: '95'
              transaction:
                invoice: '192029'
      responses:
        '200':
          description: Transaction was processed
          content:
            application/json:
              schema:
                properties:
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        dateTime:
                          $ref: '#/components/schemas/DateTime'
                        amount:
                          $ref: '#/components/schemas/AmountGCResponse'
                        card:
                          type: object
                          properties:
                            number:
                              type: string
                              maxLength: 32
                              description: 'The gift card number that was created during the gift card allocate request.

                                '
                            type:
                              $ref: '#/components/schemas/CardTypeGCResp'
                            balance:
                              $ref: '#/components/schemas/CardBalance'
                        merchant:
                          $ref: '#/components/schemas/MerchantResponse'
                        programId:
                          $ref: '#/components/schemas/ProgramId'
                        server:
                          $ref: '#/components/schemas/Server'
                        transaction:
                          type: object
                          properties:
                            invoice:
                              $ref: '#/components/schemas/TransactionInvoice'
                            responseCode:
                              $ref: '#/components/schemas/TransactionResponseCode'
              example:
                result:
                - dateTime: '2021-04-15T09:18:23.283-07:00'
                  amount:
                    total: 20
                  card:
                    number: '1000083000004141494'
                    type: GC
                    balance:
                      amount: 20
                  merchant:
                    mid: 15877
                    name: Merchant XYZ
                  programId: '95'
                  server:
                    name: UTGAPI01CE
                  transaction:
                    invoice: '192029'
                    responseCode: A
        '400':
          description: Error
          content:
            application/json:
              schema:
                properties:
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        error:
                          $ref: '#/components/schemas/Error'
                        server:
                          $ref: '#/components/schemas/Server'
              example:
                result:
                - error:
                    longText: 'ALLOCATE Failed: Need sample error'
                    primaryCode: 9101
                    secondaryCode: 0
                    shortText: ALLOCATE FAILED
                  server:
                    name: U2API01CE
        '504':
          $ref: '#/components/responses/TimeoutResponse'
  /giftcards/deactivate:
    servers:
    - url: https://api.shift4test.com/api/rest/v1
      description: Host Direct Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Host Direct Production URL
    - url: https://192.168.1.10:277/api/rest/v1
      description: Locally Installed UTG URL
    - url: https://192.168.1.20:8085/api/rest/v1
      description: Commerce Engine For On Premise URL
    - url: https://api.shift4test.com/api/rest/v1
      description: Commerce Engine For Cloud Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Commerce Engine For Cloud Production URL
    post:
      tags:
      - Gift Cards
      summary: Deactivate
      operationId: deactivate
      security:
      - AccessToken: []
      description: 'This function requests that an active gift card be deactivated so that it can’t be used to process transactions.  A balance will remain on the gift card (if supported by the processor).  If you want to return the card''s current balance back to the customer, use the [Cashout](/apis/payments-platform-rest/openapi/gift-cards/cashout) endpoint instead.


        **Integration Methods:**

        - Host Direct

        - Locally Installed UTG

        - Commerce Engine For On Premise

        - Commerce Engine For Cloud


        See the [Integration Methods](/guides/quickstart#integration-methods) and [URLs Section](/guides/quickstart#urls) sections of the Development Quick Start guide for details regarding each processing option.


        See the [JSON Body Schemas](/guides/quickstart#json-body-schemas) for more details on the various JSON body formats.

        '
      parameters:
      - $ref: '#/components/parameters/InterfaceVersion'
      - $ref: '#/components/parameters/InterfaceName'
      - $ref: '#/components/parameters/CompanyName'
      - $ref: '#/components/parameters/AccessToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/giftcards_deactivate_comengdevice'
              - $ref: '#/components/schemas/giftcards_deactivate_comengcloud'
              - $ref: '#/components/schemas/giftcards_deactivate_utgdevice'
              - $ref: '#/components/schemas/giftcards_deactivate_token_gtv'
              - $ref: '#/components/schemas/giftcards_deactivate_token_legacy'
              - $ref: '#/components/schemas/giftcards_deactivate_p2pe_idtech'
              - $ref: '#/components/schemas/giftcards_deactivate_p2pe_tdesdukpt_msr'
              - $ref: '#/components/schemas/giftcards_deactivate_p2pe_onguardsde_msr'
              - $ref: '#/components/schemas/giftcards_deactivate_unencryptedcard'
      responses:
        '200':
          description: Transaction was processed
          content:
            application/json:
              schema:
                properties:
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        dateTime:
                          $ref: '#/components/schemas/DateTime'
                        card:
                          $ref: '#/components/schemas/CardResponseDeact'
                        device:
                          $ref: '#/components/schemas/DeviceOnlyTIDResponse'
                        merchant:
                          $ref: '#/components/schemas/MerchantResponse'
                        server:
                          $ref: '#/components/schemas/Server'
                        transaction:
                          type: object
                          properties:
                            authSource:
                              $ref: '#/components/schemas/TransactionAuthSource'
                            invoice:
                              $ref: '#/components/schemas/TransactionInvoice'
                            responseCode:
                              $ref: '#/components/schemas/TransactionResponseCode'
                        universalToken:
                          $ref: '#/components/schemas/UniversalToken'
              example:
                result:
                - dateTime: '2021-04-15T09:18:23.283-07:00'
                  card:
                    entryMode: '1'
                    number: XXXXXXXXXXXX1333
                    present: Y
                    deactivationReason: lost or stolen
                    balance:
                      amount: 20
                    token:
                      value: 0009hfqbt8b396x1
                    type: YC
                  device:
                    terminalId: '1742'
                  merchant:
                    mid: 15877
                    name: Merchant XYZ
                  server:
                    name: UTGAPI01CE
                  transaction:
                    authSource: E
                    invoice: '192032'
                    responseCode: A
        '400':
          $ref: '#/components/responses/CardTokenErrorResponse'
        '504':
          $ref: '#/components/responses/TimeoutResponse'
  /giftcards/cashout:
    servers:
    - url: https://api.shift4test.com/api/rest/v1
      description: Host Direct Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Host Direct Production URL
    - url: https://192.168.1.10:277/api/rest/v1
      description: Locally Installed UTG URL
    - url: https://192.168.1.20:8085/api/rest/v1
      description: Commerce Engine For On Premise URL
    - url: https://api.shift4test.com/api/rest/v1
      description: Commerce Engine For Cloud Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Commerce Engine For Cloud Production URL
    post:
      deprecated: true
      tags:
      - Gift Cards
      summary: Cashout
      operationId: cashout
      security:
      - AccessToken: []
      description: "This function requests that an active gift card be deactivated so that it can’t be used to process transactions.  Any current balance is removed from the card so that the funds can be returned to the consumer as cash. \n\n**This endpoint has been deprecated and should no longer be used. It has been replaced by the [Gift Card Cashback](/apis/payments-platform-rest/openapi/gift-cards/cashback) endpoint.**\n\n**Integration Methods:**\n- Host Direct\n- Locally Installed UTG\n- Commerce Engine For On Premise\n- Commerce Engine For Cloud\n\nSee the [Integration Methods](/guides/quickstart#integration-methods) and [URLs Section](/guides/quickstart#urls) sections of the Development Quick Start guide for details regarding each processing option.\n\nSee the [JSON Body Schemas](/guides/quickstart#json-body-schemas) for more details on the various JSON body formats.\n"
      parameters:
      - $ref: '#/components/parameters/InterfaceVersion'
      - $ref: '#/components/parameters/InterfaceName'
      - $ref: '#/components/parameters/CompanyName'
      - $ref: '#/components/parameters/AccessToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/giftcards_cashout_comengdevice'
              - $ref: '#/components/schemas/giftcards_cashout_comengcloud'
              - $ref: '#/components/schemas/giftcards_cashout_utgdevice'
              - $ref: '#/components/schemas/giftcards_cashout_token_gtv'
              - $ref: '#/components/schemas/giftcards_cashout_token_legacy'
              - $ref: '#/components/schemas/giftcards_cashout_p2pe_idtech'
              - $ref: '#/components/schemas/giftcards_cashout_p2pe_tdesdukpt_msr'
              - $ref: '#/components/schemas/giftcards_cashout_p2pe_onguardsde_msr'
              - $ref: '#/components/schemas/giftcards_cashout_unencryptedcard'
      responses:
        '200':
          description: Transaction was processed
          content:
            application/json:
              schema:
                properties:
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        dateTime:
                          $ref: '#/components/schemas/DateTime'
                        amount:
                          $ref: '#/components/schemas/AmountGCResponse'
                        card:
                          $ref: '#/components/schemas/CardResponseCashout'
                        device:
                          $ref: '#/components/schemas/DeviceOnlyTIDResponse'
                        merchant:
                          $ref: '#/components/schemas/MerchantResponse'
                        server:
                          $ref: '#/components/schemas/Server'
                        transaction:
                          type: object
                          properties:
                            authSource:
                              $ref: '#/components/schemas/TransactionAuthSource'
                            invoice:
                              $ref: '#/components/schemas/TransactionInvoice'
                            responseCode:
                              $ref: '#/components/schemas/TransactionResponseCode'
                        universalToken:
                          $ref: '#/components/schemas/UniversalToken'
              example:
                result:
                - dateTime: '2021-04-15T09:18:23.283-07:00'
                  amount:
                    total: 20
                  card:
                    entryMode: '1'
                    number: XXXXXXXXXXXX1333
                    present: Y
                    deactivationReason: lost or stolen
                    token:
                      value: 0009hfqbt8b396x1
                    type: YC
                  device:
                    terminalId: '1742'
                  merchant:
                    mid: 15877
                    name: Merchant XYZ
                  server:
                    name: UTGAPI01CE
                  transaction:
                    authSource: E
                    invoice: '192034'
                    responseCode: A
        '400':
          $ref: '#/components/responses/CardTokenErrorResponse'
        '504':
          $ref: '#/components/responses/TimeoutResponse'
  /giftcards/cashback:
    servers:
    - url: https://api.shift4test.com/api/rest/v1
      description: Host Direct Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Host Direct Production URL
    - url: https://192.168.1.10:277/api/rest/v1
      description: Locally Installed UTG URL
    - url: https://192.168.1.20:8085/api/rest/v1
      description: Commerce Engine For On Premise URL
    - url: https://api.shift4test.com/api/rest/v1
      description: Commerce Engine For Cloud Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Commerce Engine For Cloud Production URL
    post:
      tags:
      - Gift Cards
      summary: Cashback
      operationId: cashback
      security:
      - AccessToken: []
      description: "This function requests that an active gift card be deactivated so that it can’t be used to process transactions.  Any current balance is removed from the card so that the funds can be returned to the consumer as cash. \n\n**This endpoint replaces the [Gift Card Cashout](/apis/payments-platform-rest/openapi/gift-cards/cashout) endpoint.**\n\n**Integration Methods:**\n- Host Direct\n- Locally Installed UTG\n- Commerce Engine For On Premise\n- Commerce Engine For Cloud\n\nSee the [Integration Methods](/guides/quickstart#integration-methods) and [URLs Section](/guides/quickstart#urls) sections of the Development Quick Start guide for details regarding each processing option.\n\nSee the [JSON Body Schemas](/guides/quickstart#json-body-schemas) for more details on the various JSON body formats.\n"
      parameters:
      - $ref: '#/components/parameters/InterfaceVersion'
      - $ref: '#/components/parameters/InterfaceName'
      - $ref: '#/components/parameters/CompanyName'
      - $ref: '#/components/parameters/AccessToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/giftcards_cashout_comengdevice'
              - $ref: '#/components/schemas/giftcards_cashout_comengcloud'
              - $ref: '#/components/schemas/giftcards_cashout_utgdevice'
              - $ref: '#/components/schemas/giftcards_cashout_token_gtv'
              - $ref: '#/components/schemas/giftcards_cashout_token_legacy'
              - $ref: '#/components/schemas/giftcards_cashout_p2pe_idtech'
              - $ref: '#/components/schemas/giftcards_cashout_p2pe_tdesdukpt_msr'
              - $ref: '#/components/schemas/giftcards_cashout_p2pe_onguardsde_msr'
              - $ref: '#/components/schemas/giftcards_cashout_unencryptedcard'
      responses:
        '200':
          description: Transaction was processed
          content:
            application/json:
              schema:
                properties:
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        dateTime:
                          $ref: '#/components/schemas/DateTime'
                        amount:
                          $ref: '#/components/schemas/AmountGCResponse'
                        card:
                          $ref: '#/components/schemas/CardResponseCashout'
                        device:
                          $ref: '#/components/schemas/DeviceOnlyTIDResponse'
                        merchant:
                          $ref: '#/components/schemas/MerchantResponse'
                        server:
                          $ref: '#/components/schemas/Server'
                        transaction:
                          type: object
                          properties:
                            authSource:
                              $ref: '#/components/schemas/TransactionAuthSource'
                            invoice:
                              $ref: '#/components/schemas/TransactionInvoice'
                            responseCode:
                              $ref: '#/components/schemas/TransactionResponseCode'
                        universalToken:
                          $ref: '#/components/schemas/UniversalToken'
              example:
                result:
                - dateTime: '2021-04-15T09:18:23.283-07:00'
                  amount:
                    total: 20
                  card:
                    entryMode: '1'
                    number: XXXXXXXXXXXX1333
                    present: Y
                    deactivationReason: lost or stolen
                    token:
                      value: 0009hfqbt8b396x1
                    type: YC
                  device:
                    terminalId: '1742'
                  merchant:
                    mid: 15877
                    name: Merchant XYZ
                  server:
                    name: UTGAPI01CE
                  transaction:
                    authSource: E
                    invoice: '192034'
                    responseCode: A
        '400':
          $ref: '#/components/responses/CardTokenErrorResponse'
        '504':
          $ref: '#/components/responses/TimeoutResponse'
  /giftcards/reactivate:
    servers:
    - url: https://api.shift4test.com/api/rest/v1
      description: Host Direct Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Host Direct Production URL
    - url: https://192.168.1.10:277/api/rest/v1
      description: Locally Installed UTG URL
    - url: https://192.168.1.20:8085/api/rest/v1
      description: Commerce Engine For On Premise URL
    - url: https://api.shift4test.com/api/rest/v1
      description: Commerce Engine For Cloud Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Commerce Engine For Cloud Production URL
    post:
      tags:
      - Gift Cards
      summary: Reactivate
      operationId: reactivate
      security:
      - AccessToken: []
      description: 'This function requests that a previously deactivated gift card be reactivated. If there was a balance remaining on the gift card at the time of deactivation, the balance will again become available for use. Funds cannot be added to a gift card during a Reactivate request.


        **Integration Methods:**

        - Host Direct

        - Locally Installed UTG

        - Commerce Engine For On Premise

        - Commerce Engine For Cloud


        See the [Integration Methods](/guides/quickstart#integration-methods) and [URLs Section](/guides/quickstart#urls) sections of the Development Quick Start guide for details regarding each processing option.


        See the [JSON Body Schemas](/guides/quickstart#json-body-schemas) for more details on the various JSON body formats.

        '
      parameters:
      - $ref: '#/components/parameters/InterfaceVersion'
      - $ref: '#/components/parameters/InterfaceName'
      - $ref: '#/components/parameters/CompanyName'
      - $ref: '#/components/parameters/AccessToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/giftcards_reactivate_comengdevice'
              - $ref: '#/components/schemas/giftcards_reactivate_comengcloud'
              - $ref: '#/components/schemas/giftcards_reactivate_utgdevice'
              - $ref: '#/components/schemas/giftcards_reactivate_token_gtv'
              - $ref: '#/components/schemas/giftcards_reactivate_token_legacy'
              - $ref: '#/components/schemas/giftcards_reactivate_p2pe_idtech'
              - $ref: '#/components/schemas/giftcards_reactivate_p2pe_tdesdukpt_msr'
              - $ref: '#/components/schemas/giftcards_reactivate_p2pe_onguardsde_msr'
              - $ref: '#/components/schemas/giftcards_reactivate_unencryptedcard'
      responses:
        '200':
          description: Transaction was processed
          content:
            application/json:
              schema:
                properties:
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        dateTime:
                          $ref: '#/components/schemas/DateTime'
                        card:
                          $ref: '#/components/schemas/CardResponseGC'
                        device:
                          $ref: '#/components/schemas/DeviceOnlyTIDResponse'
                        merchant:
                          $ref: '#/components/schemas/MerchantResponse'
                        server:
                          $ref: '#/components/schemas/Server'
                        transaction:
                          type: object
                          properties:
                            authSource:
                              $ref: '#/components/schemas/TransactionAuthSource'
                            invoice:
                              $ref: '#/components/schemas/TransactionInvoice'
                            responseCode:
                              $ref: '#/components/schemas/TransactionResponseCode'
                        universalToken:
                          $ref: '#/components/schemas/UniversalToken'
              example:
                result:
                - dateTime: '2021-04-15T09:18:23.283-07:00'
                  card:
                    number: XXXXXXXXXXXX1333
                    balance:
                      amount: 30
                    token:
                      value: 0009hfqbt8b396x1
                    type: YC
                  device:
                    terminalId: '1742'
                  merchant:
                    mid: 15877
                    name: Merchant XYZ
                  server:
                    name: UTGAPI01CE
                  transaction:
                    authSource: E
                    invoice: '192033'
                    responseCode: A
        '400':
          $ref: '#/components/responses/CardTokenErrorResponse'
        '504':
          $ref: '#/components/responses/TimeoutResponse'
  /giftcards/reload:
    servers:
    - url: https://api.shift4test.com/api/rest/v1
      description: Host Direct Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Host Direct Production URL
    - url: https://192.168.1.10:277/api/rest/v1
      description: Locally Installed UTG URL
    - url: https://192.168.1.20:8085/api/rest/v1
      description: Commerce Engine For On Premise URL
    - url: https://api.shift4test.com/api/rest/v1
      description: Commerce Engine For Cloud Test URL
    - url: https://api.shift4api.net/api/rest/v1
      description: Commerce Engine For Cloud Production URL
    post:
      tags:
      - Gift Cards
      summary: Reload
      operationId: reload
      security:
      - AccessToken: []
      description: 'This function requests that an active gift card be loaded with additional funds.


        **Integration Methods:**

        - Host Direct

        - Locally Installed UTG

        - Commerce Engine For On Premise

        - Commerce Engine For Cloud


        See the [Integration Methods](/guides/quickstart#i

# --- truncated at 32 KB (161 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shift4/refs/heads/main/openapi/shift4-gift-cards-api-openapi.yml