Punchh Gift Cards API

The Gift Cards API from Punchh — 14 operation(s) for gift cards.

Operations 15

POST /api2/mobile/gift_cards/purchase Purchase Gift Card #
POST /api2/mobile/gift_cards/{uuid}/reload Reload Gift Card #
POST /api2/mobile/gift_cards Import Physical Gift Card #
PUT /api2/mobile/gift_cards/{uuid} Update Gift Card #
DELETE /api2/mobile/gift_cards/{uuid} Delete Gift Card #
GET /api2/mobile/gift_cards/ Fetch Gift Cards #
GET /api2/mobile/gift_cards/{uuid}/balance Fetch Gift Card Balance #
GET /api2/mobile/gift_cards/{uuid}/history Fetch Gift Card Transaction History #
POST /api2/mobile/gift_cards/{uuid}/transfer Transfer Gift Card or Balance #
POST /api2/mobile/gift_cards/{uuid}/share Share Gift Card #
DELETE /api2/mobile/gift_cards/{uuid}/revoke Revoke Sharing #
POST /api2/mobile/gift_cards/gift Gift a Gift Card #
PATCH /api2/mobile/gift_cards/{uuid}/consolidate Consolidate Gift Cards #
POST /api2/mobile/gift_cards/{uuid}/tip Tip via Gift Card #
GET /api2/mobile/gift_cards/{uuid}/epin Get Gift Card EPIN #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-access-token-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-create-user-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-login-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-mark-offers-read-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-transaction-details-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-transaction-details-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-update-user-profile-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-user-session-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-access-token-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-create-user-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-login-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-mark-offers-read-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-transaction-details-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-transaction-details-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-update-user-profile-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-user-session-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-checkin-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-checkin-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-redemption-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-redemption-response-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-checkin-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-checkin-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-redemption-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-redemption-response-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/platform-functions-redeemable-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/platform-functions-redeemable-structure.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-access-token-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-create-user-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-login-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-mark-offers-read-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-transaction-details-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-transaction-details-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-update-user-profile-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-user-session-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-ld/punchh-mobile-context.jsonld
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-mobile.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-mobile.opencollection.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-checkin-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-checkin-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-redemption-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-redemption-response-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-ld/punchh-online-ordering-context.jsonld
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-online-ordering.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-online-ordering.opencollection.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/platform-functions-redeemable-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-ld/punchh-platform-functions-context.jsonld
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-platform-functions.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-platform-functions.opencollection.json

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/punchh-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 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.

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

OpenAPI Specification

punchh-gift-cards-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Mobile Gift Cards API
  version: '1.0'
  contact:
    name: Punchh Dev Support
    url: https://developers.punchh.com
  description: 'Punchh provides a robust platform for offering loyalty programs to customers. When a business integrates its back-end with the Punchh server, the Punchh APIs become instrumental in executing loyalty programs for enrolled customers, primarily via business-branded mobile apps and websites tailored by Punchh.


    To establish integration with the Punchh APIs, you need to understand how they are invoked and what responses are returned by the Punchh server. You can call APIs using any suitable API test client, such as Postman. Thus, the response to every API call made in Postman under a chosen environment (in app and/or platform) is reflected in the app and/or platform.'
servers:
- url: https://SERVER_NAME_GOES_HERE.punchh.com
tags:
- name: Gift Cards
paths:
  /api2/mobile/gift_cards/purchase:
    post:
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gift-Card-Object'
              examples:
                default:
                  value:
                    card_background_image: IMAGE_URL_GOES_HERE
                    card_number: CARD_NUMBER_GOES_HERE
                    epin: EPIN_GOES_HERE
                    usb_scannable_card_number: CARD_NUMBER_GOES_HERE
                    created_at: '2016-05-12T03:54:45-06:00'
                    design_id: 1
                    preferred: false
                    name: null
                    last_fetched_amount: 10
                    last_fetched_at: '2016-05-12T03:54:45-06:00'
                    status: active
                    updated_at: '2016-05-12T03:54:45-06:00'
                    users:
                    - user_id: 111111111
                      email: test@example.com
                      first_name: FIRST_NAME_GOES_HERE
                      last_name: LAST_NAME_GOES_HERE
                      fb_uid: null
                      avatar_remote_url: null
                      state: owner
                    uuid: ID_GOES_HERE
                    gift_card_id: ID_GOES_HERE
                    auto_reload_enabled: true
                    gc_user_auto_reload_threshold_amount: 50
                    gc_user_auto_reload_default_amount: 50
                    gc_user_auto_reload_preferred_payment: PAYMENT_CARD_UUID_GOES_HERE
      summary: Purchase Gift Card
      description: Enables a user to purchase a gift card using the app of a business
      operationId: mobile_purchase_gift_card
      tags:
      - Gift Cards
      parameters:
      - $ref: '#/components/parameters/signature'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/Accept-Language'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/User-Agent'
      x-stoplight:
        id: 79eab19c99597
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client:
                  type: string
                  description: OAuth client ID provided by the business
                design_id:
                  type: string
                  description: ID of a particular gift card design selected by the user while purchasing a gift card
                amount:
                  type: string
                  description: Amount with which the user wants to purchase a gift card. The minimum value can be configured in the Punchh platform.
                payment_type:
                  type: string
                  description: This parameter is required when a user makes a payment via saved cards. Send "recurring" as the value of this parameter.
                transaction_token:
                  type: string
                  description: Unique digital identifier/token of the user's payment card, or the UUID of the saved payment card if the value of `payment_type` is "recurring". The transaction token is issued by a payment processor used by a business.
                cardholder_name:
                  type: string
                  description: Name of the person who owns the payment card used to purchase a gift card. Not needed for Apple Pay / Android Wallet
                exp_date:
                  type: string
                  description: Expiration date of the payment card used by the user. Not needed for Apple Pay / Android Wallet
                type:
                  type: string
                  description: Type of payment card used by the user (e.g., Visa, Mastercard, etc.). Not needed for Apple Pay / Android Wallet
                postal_code:
                  type: string
                  description: Zip code as specified by the cardholder in the billing address
            examples:
              Purchase gift card via credit card:
                value:
                  client: CLIENT_GOES_HERE
                  design_id: 13
                  amount: '10'
                  transaction_token: TOKEN_GOES_HERE
                  cardholder_name: FIRST_NAME_GOES_HERE LAST_NAME_GOES_HERE
                  exp_date: 419
                  type: VISA
                  postal_code: 10004
              'Purchase gift card via saved payment card ':
                value:
                  client: CLIENT_GOES_HERE
                  design_id: 13
                  amount: '10'
                  payment_type: recurring
                  transaction_token: SAVED_CARD_UUID_GOES_HERE
                  cardholder_name: FIRST_NAME_GOES_HERE LAST_NAME_GOES_HERE
                  exp_date: 419
                  type: VISA
                  postal_code: 10004
  /api2/mobile/gift_cards/{uuid}/reload:
    parameters:
    - schema:
        type: string
      name: uuid
      in: path
      required: true
    post:
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gift-Card-Object'
              examples:
                default:
                  value:
                    card_background_image: IMAGE_URL_GOES_HERE
                    card_number: CARD_NUMBER_GOES_HERE
                    epin: EPIN_GOES_HERE
                    usb_scannable_card_number: CARD_NUMBER_GOES_HERE
                    created_at: '2016-05-12T03:54:45-06:00'
                    design_id: 1
                    preferred: false
                    name: My first card
                    last_fetched_amount: 42
                    last_fetched_at: '2016-05-12T04:44:01-06:00'
                    status: active
                    type: null
                    updated_at: '2016-05-12T04:44:01-06:00'
                    users:
                    - user_id: 111111111
                      email: test@example.com
                      first_name: FIRST_NAME_GOES_HERE
                      last_name: LAST_NAME_GOES_HERE
                      fb_uid: null
                      avatar_remote_url: null
                      state: owner
                    uuid: ID_GOES_HERE
                    gift_card_id: ID_GOES_HERE
                    auto_reload_enabled: true
                    gc_user_auto_reload_threshold_amount: 50
                    gc_user_auto_reload_default_amount: 50
                    gc_user_auto_reload_preferred_payment: PAYMENT_CARD_UUID_GOES_HERE
      summary: Reload Gift Card
      description: Enables a user to add to the balance of an existing gift card using the app of a business
      operationId: mobile_reload_gift_card
      tags:
      - Gift Cards
      parameters:
      - $ref: '#/components/parameters/signature'
      - $ref: '#/components/parameters/Authorization'
      - schema:
          type: string
        in: path
        name: uuid
        required: true
        description: Unique ID of the gift card issued by and maintained in the Punchh system
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/User-Agent'
      x-stoplight:
        id: b1ac0c8bdfd2e
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client:
                  type: string
                  description: OAuth client ID provided by the business
                amount:
                  type: string
                  description: Amount with which the user wants to purchase a gift card. The minimum value can be configured in the Punchh platform.
                payment_type:
                  type: string
                  description: This parameter is required when a user makes a payment via saved cards. Send "recurring" as the value of this parameter.
                transaction_token:
                  type: string
                  description: Unique digital identifier/token of the user's payment card, or the UUID of the saved payment card if the value of `payment_type` is "recurring". The transaction token is issued by a payment processor used by a business.
                cardholder_name:
                  type: string
                  description: Name of the person who owns the payment card used to purchase a gift card. Not needed for Apple Pay / Android Wallet
                exp_date:
                  type: string
                  description: Expiration date of the payment card used by the user. Not needed for Apple Pay / Android Wallet
                type:
                  type: string
                  description: Type payment card used by the user (e.g., Visa, Mastercard, etc.). Not needed for Apple Pay / Android Wallet
                postal_code:
                  type: string
                  description: Zip code as specified by the cardholder in the billing address
            examples:
              Reload a gift card via credit card:
                value:
                  client: CLIENT_GOES_HERE
                  design_id: 13
                  amount: '10'
                  transaction_token: TOKEN_GOES_HERE
                  cardholder_name: FIRST_NAME_GOES_HERE LAST_NAME_GOES_HERE
                  exp_date: 419
                  type: Mastercard
                  postal_code: 10004
              Reload a gift card via saved payment card:
                value:
                  client: CLIENT_GOES_HERE
                  design_id: 13
                  amount: '10'
                  payment_type: recurring
                  transaction_token: SAVED_CARD_UUID_GOES_HERE
                  cardholder_name: FIRST_NAME_GOES_HERE LAST_NAME_GOES_HERE
                  exp_date: 419
                  type: VISA
                  postal_code: 10004
  /api2/mobile/gift_cards:
    post:
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gift-Card-Object'
              examples:
                default:
                  value:
                    card_background_image: IMAGE_URL_GOES_HERE
                    card_number: CARD_NUMBER_GOES_HERE
                    epin: EPIN_GOES_HERE
                    usb_scannable_card_number: CARD_NUMBER_GOES_HERE
                    created_at: '2016-05-12T03:54:45-06:00'
                    design_id: 1
                    preferred: false
                    name: My first card
                    last_fetched_amount: 42
                    last_fetched_at: '2016-05-12T04:44:01-06:00'
                    status: active
                    type: null
                    updated_at: '2016-05-12T04:44:01-06:00'
                    users:
                    - user_id: 111111111
                      email: test@example.com
                      first_name: FIRST_NAME_GOES_HERE
                      last_name: LAST_NAME_GOES_HERE
                      fb_uid: null
                      avatar_remote_url: null
                      state: owner
                    uuid: ID_GOES_HERE
                    gift_card_id: ID_GOES_HERE
                    auto_reload_enabled: true
                    gc_user_auto_reload_threshold_amount: 50
                    gc_user_auto_reload_default_amount: 50
                    gc_user_auto_reload_preferred_payment: PAYMENT_CARD_UUID_GOES_HERE
      summary: Import Physical Gift Card
      description: Imports a user's physical gift card into the app. The physical gift card is added to the Punchh system.
      operationId: mobile_import_physical_gift_card
      tags:
      - Gift Cards
      parameters:
      - $ref: '#/components/parameters/signature'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/Accept-Language'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/User-Agent'
      x-stoplight:
        id: 074d603d4be19
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client:
                  type: string
                  description: OAuth client ID provided by the business
                design_id:
                  type: string
                  description: 'ID of a particular gift card design selected by the user while purchasing a gift card

                    '
                card_number:
                  type: string
                  description: Card number of the physical gift card
                epin:
                  type: string
                  description: Security PIN associated with the gift card
                name:
                  type: string
                  description: Name assigned to the gift card by a user
            examples:
              default:
                value:
                  client: CLIENT_GOES_HERE
                  design_id: 1
                  card_number: CARD_NUMBER_GOES_HERE
                  epin: EPIN_GOES_HERE
                  name: My first card
  /api2/mobile/gift_cards/{uuid}:
    parameters:
    - schema:
        type: string
      name: uuid
      in: path
      required: true
    put:
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gift-Card-Object'
              examples:
                default:
                  value:
                    card_background_image: IMAGE_URL_GOES_HERE
                    design_id: 1
                    preferred: true
                    name: My first card
                    usb_scannable_card_number: CARD_NUMBER_GOES_HERE
                    users:
                    - state: owner
                      email: test@example.com
                      first_name: null
                      last_name: null
                      avatar_remote_url: null
                      fb_uid: null
                      user_id: 111111111
                    card_number: CARD_NUMBER_GOES_HERE
                    epin: EPIN_GOES_HERE
                    created_at: '2016-06-13T12:42:21-07:00'
                    last_fetched_amount: 0
                    last_fetched_at: '2016-06-13T12:42:21-07:00'
                    status: active
                    updated_at: '2016-06-13T12:42:21-07:00'
                    uuid: ID_GOES_HERE
                    gift_card_id: ID_GOES_HERE
                    auto_reload_enabled: true
                    gc_user_auto_reload_threshold_amount: 50
                    gc_user_auto_reload_default_amount: 50
                    gc_user_auto_reload_preferred_payment: PAYMENT_CARD_UUID_GOES_HERE
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    x-stoplight:
                      id: v6xbmnaj8c2gc
                    items:
                      x-stoplight:
                        id: ybpdyzfk0hkg0
                      type: string
              examples:
                example:
                  value:
                    errors:
                    - You should be the owner of this card to perform this action.
      summary: Update Gift Card
      description: Enables a gift card owner to update the name, design, and preference of a gift card
      operationId: mobile_udpate_gift_card
      tags:
      - Gift Cards
      parameters:
      - $ref: '#/components/parameters/signature'
      - $ref: '#/components/parameters/Authorization'
      - schema:
          type: string
        in: path
        name: uuid
        required: true
        description: Unique ID of the gift card issued by and maintained in the Punchh system.
      - $ref: '#/components/parameters/Accept-Language'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/User-Agent'
      x-stoplight:
        id: 5a6da59e09732
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client:
                  type: string
                  description: OAuth client ID provided by the business
                design_id:
                  type: integer
                  description: 'ID of a particular gift card design selected by the gift card owner while purchasing a gift card


                    <b>Note</b>: As Punchh no longer supports updating the design ID of the gift card via the Update Gift Card API, the parameter is marked deprecated. It will be removed from the request body of the API topic.'
                  x-deprecated: true
                name:
                  type: string
                  description: Name assigned to a gift card by the gift card owner
                preferred:
                  type: boolean
                  description: A "true" value for a gift card indicates that the gift card owner has selected it to be the preferred gift card for payment.
                auto_reload_enabled:
                  type: boolean
                  description: Whether auto-reload is enabled for a gift card or not
                threshold_amount:
                  type: number
                  format: float
                  description: Threshold amount below which a gift card would be eligible for auto-reload
                default_amount:
                  type: number
                  format: float
                  description: Default amount with which a gift card would be auto-reloaded
                payment_card_id:
                  type: string
                  description: UUID of a payment card
            examples:
              default:
                value:
                  client: CLIENT_GOES_HERE
                  name: My first card
                  preferred: true
                  auto_reload_enabled: true
                  threshold_amount: 50
                  default_amount: 50
                  payment_card_id: PAYMENT_CARD_UUID_GOES_HERE
    delete:
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
              examples:
                default:
                  value: "{ \n  \"Gift Card successfully deleted.\"\n}"
      summary: Delete Gift Card
      description: 'Removes a gift card from a user''s app so that it will not be returned in API responses under the gift card list for a user, but does not delete it from the Punchh system


        Note: It will be visible under the user profile in the Punchh platform as "card removed". To delete it from an existing user account in order to add it again for the same user or another user, please file a support ticket.'
      operationId: mobile_delete_gift_card
      tags:
      - Gift Cards
      parameters:
      - schema:
          type: string
        in: path
        name: uuid
        required: true
        description: 'Unique ID of the gift card issued by and maintained in the Punchh system

          '
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/signature'
      - $ref: '#/components/parameters/Accept-Language'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/User-Agent'
      x-stoplight:
        id: 18c84ea58fbd5
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client:
                  type: string
                  description: OAuth client ID provided by the business
              required:
              - client
            examples:
              default:
                value:
                  client: CLIENT_GOES_HERE
  /api2/mobile/gift_cards/:
    get:
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Gift-Card-Object'
              examples:
                default:
                  value:
                  - card_background_image: IMAGE_URL_GOES_HERE
                    card_number: CARD_NUMBER_GOES_HERE
                    epin: EPIN_GOES_HERE
                    usb_scannable_card_number: CARD_NUMBER_GOES_HERE
                    created_at: '2016-05-12T03:54:45-06:00'
                    design_id: 1
                    preferred: true
                    name: My first card
                    last_fetched_amount: 42
                    last_fetched_at: '2016-05-12T04:44:01-06:00'
                    status: active
                    type: null
                    updated_at: '2016-05-12T04:44:01-06:00'
                    users:
                    - user_id: 111111111
                      email: test@example.com
                      first_name: FIRST_NAME_GOES_HERE
                      last_name: LAST_NAME_GOES_HERE
                      fb_uid: null
                      avatar_remote_url: null
                      state: owner
                    uuid: ID_GOES_HERE
                    gift_card_id: ID_GOES_HERE
                  - card_background_image: IMAGE_URL_GOES_HERE
                    card_number: CARD_NUMBER_GOES_HERE
                    epin: EPIN_GOES_HERE
                    usb_scannable_card_number: CARD_NUMBER_GOES_HERE
                    created_at: '2016-05-13T06:15:44-06:00'
                    design_id: 1
                    preferred: false
                    name: My second card
                    last_fetched_amount: 50
                    last_fetched_at: '2016-05-13T06:15:45-06:00'
                    status: active
                    type: null
                    updated_at: '2016-05-13T06:15:46-06:00'
                    users:
                    - user_id: 111111111
                      email: test@example.com
                      first_name: FIRST_NAME_GOES_HERE
                      last_name: LAST_NAME_GOES_HERE
                      fb_uid: null
                      avatar_remote_url: null
                      state: shared
                    - user_id: 111111111
                      email: test@example.com
                      first_name: FIRST_NAME_GOES_HERE
                      last_name: LAST_NAME_GOES_HERE
                      fb_uid: null
                      avatar_remote_url: null
                      state: owner
                    uuid: ID_GOES_HERE
                    gift_card_id: ID_GOES_HERE
                    auto_reload_enabled: true
                    gc_user_auto_reload_threshold_amount: 50
                    gc_user_auto_reload_default_amount: 50
                    gc_user_auto_reload_preferred_payment: PAYMENT_CARD_UUID_GOES_HERE
      summary: Fetch Gift Cards
      description: Returns all of the active gift cards of a user
      operationId: mobile_fetch_gift_cards
      tags:
      - Gift Cards
      parameters:
      - $ref: '#/components/parameters/signature'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/Accept-Language'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/User-Agent'
      x-stoplight:
        id: f72dcf064d8e5
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client:
                  type: string
                  description: OAuth client ID provided by the business
                passcode:
                  type: string
                  description: Passcode is a secondary authentication PIN that must be passed if it is enabled for a business. It can be turned on/off from the Punchh platform.
              required:
              - client
              - passcode
            examples:
              default:
                value:
                  client: CLIENT_GOES_HERE
                  passcode: '123456'
  /api2/mobile/gift_cards/{uuid}/balance:
    parameters:
    - schema:
        type: string
      name: uuid
      in: path
      required: true
    get:
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gift-Card-Object'
              examples:
                default:
                  value:
                    card_background_image: IMAGE_URL_GOES_HERE
                    card_number: CARD_NUMBER_GOES_HERE
                    epin: EPIN_GOES_HERE
                    usb_scannable_card_number: CARD_NUMBER_GOES_HERE
                    created_at: '2016-05-12T03:54:45-06:00'
                    design_id: 1
                    preferred: false
                    name: My first card
                    last_fetched_amount: 42
                    last_fetched_at: '2016-05-12T05:03:23-06:00'
                    status: active
                    type: null
                    updated_at: '2016-05-12T05:03:23-06:00'
                    users:
                    - user_id: 111111111
                      email: test@example.com
                      first_name: FIRST_NAME_GOES_HERE
                      last_name: LAST_NAME_GOES_HERE
                      fb_uid: null
                      avatar_remote_url: null
                      state: owner
                      user_card_id: ID_GOES_HERE
                    uuid: ID_GOES_HERE
                    gift_card_id: ID_GOES_HERE
                    auto_reload_enabled: true
                    gc_user_auto_reload_threshold_amount: 50
                    gc_user_auto_reload_default_amount: 50
                    gc_user_auto_reload_preferred_payment: PAYMENT_CARD_UUID_GOES_HERE
      summary: Fetch Gift Card Balance
      description: Returns the details of a specified gift card
      operationId: mobile_fetch_gift_card_balance
      tags:
      - Gift Cards
      parameters:
      - schema:
          type: string
        in: path
        name: uuid
        required: true
        description: 'Unique ID of the gift card issued by and maintained in the Punchh system

          '
      - $ref: '#/components/parameters/signature'
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/Accept-Language'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/User-Agent'
      x-stoplight:
        id: 2be7804e627a0
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client:
                  type: string
                  description: OAuth client ID provided by the business
              required:
              - client
            examples:
              default:
                value:
                  client: CLIENT_GOES_HERE
  /api2/mobile/gift_cards/{uuid}/history:
    parameters:
    - schema:
        type: string
      name: uuid
      in: path
      required: true
    get:
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    date:
                      type: string
                      enum:
                      - YYYY-MM-DDThh:mm:ssZ
                      format: date-time
                      description: Date/time when the transaction happened, in ISO 8601 format
                    event:
                      type: string
                      description: Title of the transaction event displayed in the app. This respects the locale, so the value of this may change with the requested locale.
                    description:
                      type: string
                      description: Additional information about the transaction event. A 'null' value indicates that no additional details are available.
                    amount:
                      type: number
                      format: float
                      description: 'Amount involved in the transaction

                        '
                    balance:
                      type: number
                      format: float
                      description: Updated balance of the gift card after the transaction
                    event_type:
                      type: string
                      description: "Fixed value of the transaction event that indicates the type of gift card transaction. Logic in the app can be applied based on the values returned in this parameter. For example, color coding in the transaction history can be based on this. Values returned are:\n- reloaded \n- card_added \n- transferred \n- redeemed"
              examples:
                default:
                  value:
                  - date: '2016-05-12T03:54:45-06:00'
                    event: Reloaded
                    description: null
                    amount: $10.00
                    balance: $10.00
                    event_type: reloaded
                  - date: '2016-05-12T04:43:12-06:00'
                    event: Reloaded
                    description: null
                    amount: $15.00
                    balance: $25.00
                    event_type: reloaded
                  - date: '2016-05-12T04:44:01-06:00'
                    event: Reloaded
                    description: null
                    amount: $17.00
                    balance: $42.00
                    event_type: reloaded
      summary: Fetch Gift Card Transaction History
      description: Returns the transaction history of a specified gift card
      operationId: mobile_fetch_gift_card_transaction_history
      tags:
      - Gift Cards
      parameters:
      - $ref: '#/components/parameters/signature'
      - $ref: '#/components/parameters/Authorization'
      - schema:
          type: string
        in: path
        name: uuid
        required: true
        description: 'Unique ID of the gift card issued by and maintained in the Punchh system

          '
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/Accept-Language'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/User-Agent'
      x-stoplight:
        id: a7c0fda10d070
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client:
                  type: string
                  description: OAuth client ID provided by the business
              required:
              - client
            examples:
              default:
                value:
                  client: CLIENT_GOES_HERE
  /api2/mobile/gift_cards/{uuid}/transfer:
    parameters:
    - schema:
        type: string
      name: uuid
      in: path
      required: true
    post:
      responses:
        '200':
          description: ''
          content:
 

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