Punchh

Punchh Gift Cards API

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

Documentation GitHub OpenAPI

Operations 15

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api2/mobile/gift_cards/purchase Buy a new gift card in the app · Purchase Gift Card #

Ask an LLM

“How does a guest buy a brand-new gift card for themselves in the app?”

“Is there a minimum amount for purchasing a gift card?”

Tell an agent

Buy a {amount} gift card with design {design_id}.

Purchase a {amount} gift card using saved card {transaction_token}.

POST /api2/mobile/gift_cards/{uuid}/reload Add funds to an existing gift card · Reload Gift Card #

Ask an LLM

“Can a guest top up the balance on a gift card they already have?”

“Can I reload a gift card using a saved payment card?”

Tell an agent

Reload gift card {uuid} with {amount}.

Top up gift card {uuid} by {amount} using saved card {transaction_token}.

POST /api2/mobile/gift_cards Add a physical gift card to the app · Import Physical Gift Card #

Ask an LLM

“How can a guest load a plastic gift card into their app wallet?”

“Does importing a physical card need its security PIN?”

Tell an agent

Import physical gift card {card_number} with PIN {epin}.

Add my plastic gift card {card_number} to the app and name it {name}.

PUT /api2/mobile/gift_cards/{uuid} Rename a gift card or set auto-reload · Update Gift Card #

Ask an LLM

“Can a guest turn on auto-reload when their gift card balance gets low?”

“How do I make one gift card the preferred card in the app?”

Tell an agent

Rename gift card {uuid} to {name}.

Turn on auto-reload for gift card {uuid}: add {default_amount} when the balance drops below {threshold_amount}.

DELETE /api2/mobile/gift_cards/{uuid} Remove a gift card from the guest's app · Delete Gift Card #

Ask an LLM

“Can a guest hide a gift card from their app without deleting it from the system?”

“What does the business see after a guest removes a gift card?”

Tell an agent destructive · confirm first

Remove gift card {uuid} from my app.

Delete gift card {uuid} from the guest's wallet.

GET /api2/mobile/gift_cards/ List a guest's active gift cards · Fetch Gift Cards #

Ask an LLM

“Which gift cards does the guest currently have in their app?”

“Is a passcode needed to see a guest's gift cards?”

Tell an agent

List my active gift cards using passcode {passcode}.

Show all gift cards in the guest's wallet; passcode is {passcode}.

GET /api2/mobile/gift_cards/{uuid}/balance Check a gift card's balance · Fetch Gift Card Balance #

Ask an LLM

“How much money is left on a particular gift card?”

“Can I look up the current balance and details of one gift card?”

Tell an agent

Check the balance of gift card {uuid}.

How much is left on gift card {uuid}? Show me.

GET /api2/mobile/gift_cards/{uuid}/history View a gift card's transaction history · Fetch Gift Card Transaction History #

Ask an LLM

“Where can a guest see past purchases and reloads on a gift card?”

“Can I pull the transaction history of a single gift card?”

Tell an agent

Show the transaction history for gift card {uuid}.

List every charge and reload on gift card {uuid}.

POST /api2/mobile/gift_cards/{uuid}/transfer Transfer a gift card or part of its balance · Transfer Gift Card or Balance #

Ask an LLM

“Can a guest send part of a gift card balance to a friend?”

“How do I hand over an entire gift card to another user by email?”

Tell an agent

Transfer {amount} from gift card {uuid} to {recipient_email}.

Give the whole gift card {uuid} to the user with phone {recipient_phone}.

POST /api2/mobile/gift_cards/{uuid}/share Share a gift card with another user · Share Gift Card #

Ask an LLM

“Can two people use the same gift card from their own apps?”

“How does a guest share their gift card with a family member?”

Tell an agent

Share gift card {uuid} with {recipient_email}.

Let the user with phone {recipient_phone} use gift card {uuid} too.

DELETE /api2/mobile/gift_cards/{uuid}/revoke Stop sharing a gift card with someone · Revoke Sharing #

Ask an LLM

“How do I take back access to a gift card I shared with someone?”

“Can a guest revoke another user's sharing rights on a gift card?”

Tell an agent destructive · confirm first

Revoke {sharer_email}'s access to gift card {uuid}.

Stop sharing gift card {uuid} with {sharer_email}.

POST /api2/mobile/gift_cards/gift Buy a gift card as a gift for someone · Gift a Gift Card #

Ask an LLM

“Can a guest buy a gift card and send it straight to a friend?”

“What do I need to send someone a gift card by phone number?”

Tell an agent

Send a {amount} gift card to {recipient_email}.

Gift a {amount} card with design {design_id} to phone {recipient_phone}.

PATCH /api2/mobile/gift_cards/{uuid}/consolidate Merge one gift card's balance into another · Consolidate Gift Cards #

Ask an LLM

“Can a guest combine two gift cards into one balance?”

“What happens to the source gift card after its balance is consolidated?”

Tell an agent destructive · confirm first

Move the full balance of gift card {source_card} into gift card {uuid}.

Consolidate {source_card} into {uuid} for the user with token {access_token}.

POST /api2/mobile/gift_cards/{uuid}/tip Leave a tip using a gift card · Tip via Gift Card #

Ask an LLM

“Can a guest pay a tip on their order with a gift card?”

“Is a gift card tip limited by the card's balance?”

Tell an agent

Tip {tip} on check-in {checkin_id} using gift card {uuid}.

Leave a {tip} gratuity from gift card {uuid} for order {checkin_id}.

GET /api2/mobile/gift_cards/{uuid}/epin Get a gift card's EPIN · Get Gift Card EPIN #

Ask an LLM

“Where does a guest find the security PIN for their digital gift card?”

“Does retrieving a gift card EPIN require the app passcode?”

Tell an agent

Show the EPIN for gift card {uuid}.

Get the security PIN of gift card {uuid} with passcode {passcode}.

Documentation

https://developers.partech.com/docs/dev-portal-mobile

https://developers.partech.com/docs/dev-portal-mobile

https://developers.partech.com/docs/dev-portal-mobile/make-your-first-mobile-api-call

https://developers.partech.com/docs/dev-portal-online-ordering

https://developers.partech.com/docs/dev-portal-online-ordering

https://developers.partech.com/docs/dev-portal-online-ordering/make-your-first-sso-api-call

https://developers.partech.com/docs/dev-portal-platform-functions

https://developers.partech.com/docs/dev-portal-platform-functions

https://developers.partech.com/docs/dev-portal-platform-functions/make-your-first-platform-function-api-call

https://developers.partech.com/docs/dev-portal-pos

https://developers.partech.com/docs/dev-portal-pos

https://developers.partech.com/docs/dev-portal-pos/make-your-first-pos-api-call

Specifications

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

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-access-token-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-create-user-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-login-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-mark-offers-read-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-transaction-details-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-transaction-details-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-update-user-profile-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-user-session-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-access-token-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-create-user-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-login-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-mark-offers-read-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-transaction-details-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-transaction-details-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-update-user-profile-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-user-session-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-checkin-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-checkin-response-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-redemption-request-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-redemption-response-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-checkin-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-checkin-response-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-redemption-request-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-redemption-response-structure.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/platform-functions-redeemable-schema.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/platform-functions-redeemable-structure.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-access-token-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-create-user-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-login-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-mark-offers-read-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-transaction-details-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-transaction-details-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-update-user-profile-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-user-session-example.json

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

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-mobile.opencollection.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-checkin-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-checkin-response-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-redemption-request-example.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-redemption-response-example.json

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

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-online-ordering.opencollection.json

https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/platform-functions-redeemable-example.json

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

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: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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: 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.
servers:
- url: https://SERVER_NAME_GOES_HERE.punchh.com
tags:


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