Punchh

Punchh Check Ins API

The Check-ins API from Punchh — 6 operation(s) for check-ins.

Documentation GitHub OpenAPI

Operations 6

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/checkins/barcode Earn points by scanning a receipt barcode · Create Loyalty Check-in by Barcode #

Ask an LLM

“How does a guest get points by scanning the barcode on their receipt?”

“Can a guest type in the receipt barcode manually instead of scanning it?”

Tell an agent

Check me in with receipt barcode {bar_code}.

Create a check-in for barcode {bar_code} at location {location_id}.

POST /api2/mobile/checkins/qrcode Earn points by scanning a QR code · Create Loyalty Check-in by QR Code #

Ask an LLM

“Can guests earn loyalty points by scanning a QR code in the app?”

“Does a QR check-in record the guest's GPS location?”

Tell an agent

Check me in with QR code {qr_decoded}.

Create a QR check-in for {qr_decoded} at latitude {latitude}, longitude {longitude}.

POST /api2/mobile/checkins/receipt_image Earn points by uploading a receipt photo · Create Loyalty Check-in by Receipt Image #

Ask an LLM

“Can a guest snap a photo of a receipt to get loyalty credit?”

“When are points added for a receipt image check-in?”

Tell an agent

Submit receipt image {receipt_url} for a check-in.

Claim points with receipt photo {receipt_url} from location {location_id}.

GET /api2/mobile/checkins List a guest's check-ins · Fetch Check-ins #

Ask an LLM

“Where can a guest see all of their past check-ins?”

“Which visits has a guest checked in for?”

Tell an agent

List all my check-ins.

Show every check-in for app client {client}.

GET /api2/mobile/checkins/account_balance Get a guest's rewards and banked balance · Account Balance #

Ask an LLM

“What membership level and banked currency does a guest have?”

“Can I see a guest's reward IDs along with their account balance?”

Tell an agent

Show my account balance and membership level.

Get reward and banked currency details for app client {client}.

GET /api2/mobile/checkins/transactions Get details of one transaction · Transaction Details #

Ask an LLM

“How can a guest see what happened on a specific transaction?”

“Can I look up a check-in transaction by its ID?”

Tell an agent

Show details of transaction {transaction_id}.

Get what I earned on transaction {transaction_id}.

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://artifacts.apis.io/punchh/openapi/punchh-check-ins-api-openapi.yml

Schemas & Data

https://artifacts.apis.io/punchh/json-schema/mobile-access-token-schema.json

https://artifacts.apis.io/punchh/json-schema/mobile-create-user-request-schema.json

https://artifacts.apis.io/punchh/json-schema/mobile-login-request-schema.json

https://artifacts.apis.io/punchh/json-schema/mobile-mark-offers-read-request-schema.json

https://artifacts.apis.io/punchh/json-schema/mobile-transaction-details-request-schema.json

https://artifacts.apis.io/punchh/json-schema/mobile-transaction-details-schema.json

https://artifacts.apis.io/punchh/json-schema/mobile-update-user-profile-request-schema.json

https://artifacts.apis.io/punchh/json-schema/mobile-user-session-schema.json

https://artifacts.apis.io/punchh/json-structure/mobile-access-token-structure.json

https://artifacts.apis.io/punchh/json-structure/mobile-create-user-request-structure.json

https://artifacts.apis.io/punchh/json-structure/mobile-login-request-structure.json

https://artifacts.apis.io/punchh/json-structure/mobile-mark-offers-read-request-structure.json

https://artifacts.apis.io/punchh/json-structure/mobile-transaction-details-request-structure.json

https://artifacts.apis.io/punchh/json-structure/mobile-transaction-details-structure.json

https://artifacts.apis.io/punchh/json-structure/mobile-update-user-profile-request-structure.json

https://artifacts.apis.io/punchh/json-structure/mobile-user-session-structure.json

https://artifacts.apis.io/punchh/json-schema/online-ordering-online-order-checkin-request-schema.json

https://artifacts.apis.io/punchh/json-schema/online-ordering-online-order-checkin-response-schema.json

https://artifacts.apis.io/punchh/json-schema/online-ordering-online-order-redemption-request-schema.json

https://artifacts.apis.io/punchh/json-schema/online-ordering-online-order-redemption-response-schema.json

https://artifacts.apis.io/punchh/json-structure/online-ordering-online-order-checkin-request-structure.json

https://artifacts.apis.io/punchh/json-structure/online-ordering-online-order-checkin-response-structure.json

https://artifacts.apis.io/punchh/json-structure/online-ordering-online-order-redemption-request-structure.json

https://artifacts.apis.io/punchh/json-structure/online-ordering-online-order-redemption-response-structure.json

https://artifacts.apis.io/punchh/json-schema/platform-functions-redeemable-schema.json

https://artifacts.apis.io/punchh/json-structure/platform-functions-redeemable-structure.json

Other Resources

https://artifacts.apis.io/punchh/examples/mobile-access-token-example.json

https://artifacts.apis.io/punchh/examples/mobile-create-user-request-example.json

https://artifacts.apis.io/punchh/examples/mobile-login-request-example.json

https://artifacts.apis.io/punchh/examples/mobile-mark-offers-read-request-example.json

https://artifacts.apis.io/punchh/examples/mobile-transaction-details-example.json

https://artifacts.apis.io/punchh/examples/mobile-transaction-details-request-example.json

https://artifacts.apis.io/punchh/examples/mobile-update-user-profile-request-example.json

https://artifacts.apis.io/punchh/examples/mobile-user-session-example.json

https://artifacts.apis.io/punchh/json-ld/punchh-mobile-context.jsonld

PostmanCollection

https://artifacts.apis.io/punchh/collections/punchh-mobile.postman_collection.json

https://artifacts.apis.io/punchh/collections/punchh-mobile.opencollection.json

https://artifacts.apis.io/punchh/examples/online-ordering-online-order-checkin-request-example.json

https://artifacts.apis.io/punchh/examples/online-ordering-online-order-checkin-response-example.json

https://artifacts.apis.io/punchh/examples/online-ordering-online-order-redemption-request-example.json

https://artifacts.apis.io/punchh/examples/online-ordering-online-order-redemption-response-example.json

https://artifacts.apis.io/punchh/json-ld/punchh-online-ordering-context.jsonld

PostmanCollection

https://artifacts.apis.io/punchh/collections/punchh-online-ordering.postman_collection.json

https://artifacts.apis.io/punchh/collections/punchh-online-ordering.opencollection.json

https://artifacts.apis.io/punchh/examples/platform-functions-redeemable-example.json

https://artifacts.apis.io/punchh/json-ld/punchh-platform-functions-context.jsonld

PostmanCollection

https://artifacts.apis.io/punchh/collections/punchh-platform-functions.postman_collection.json

https://artifacts.apis.io/punchh/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-check-ins-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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 Check Ins 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 (54 KB total) ---
# Full source: https://artifacts.apis.io/punchh/openapi/punchh-check-ins-api-openapi.yml