# Punchh Mobile API

**Canonical:** https://apis.io/apis/punchh/punchh-mobile-api/  
**Provider:** Punchh — https://apis.io/providers/punchh/  
**Base URL:** https://{server_name}.punchh.com  
**Documentation:** https://developers.partech.com/docs/dev-portal-mobile

Punchh Mobile API is one of 15 APIs that [Punchh](https://apis.io/providers/punchh/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 16 JSON Schema definitions. Tagged areas include Badges, Beacons, Challenges, Check-ins, and Collectibles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a JSON-LD context, and 16 JSON Schemas.

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 environm Published by PAR on the mobile section of the PAR developer portal; 116 operations. Certification required.

## Machine-readable artifacts (33)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/openapi/punchh-mobile-api-openapi.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/overlays/punchh-mobile-api-overlay.yaml
- **Documentation** — https://developers.partech.com/docs/dev-portal-mobile
- **APIReference** — https://developers.partech.com/docs/dev-portal-mobile
- **GettingStarted** — https://developers.partech.com/docs/dev-portal-mobile/make-your-first-mobile-api-call
- **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
- **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
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/apis.yml

## Other Punchh APIs (12)

- [Punchh Redemptions 1.0 (Legacy) API - Mobile](https://apis.io/apis/punchh/punchh-mobile-redemptions-legacy/)
- [Punchh Redemptions 2.0 (New) API - Mobile](https://apis.io/apis/punchh/punchh-mobile-redemptions-v2/)
- [Punchh Subscription API - Mobile](https://apis.io/apis/punchh/punchh-mobile-subscription/)
- [Punchh Redemptions 1.0 (Legacy) API - Online Ordering](https://apis.io/apis/punchh/punchh-online-ordering-redemptions-legacy/)
- [Punchh Redemptions 2.0 (New) API - Online Ordering](https://apis.io/apis/punchh/punchh-online-ordering-redemptions-v2/)
- [Punchh Online Ordering and SSO API](https://apis.io/apis/punchh/punchh-online-ordering-sso-api/)
- [Punchh Subscription API - Online Ordering](https://apis.io/apis/punchh/punchh-online-ordering-subscription/)
- [Punchh Platform Functions API](https://apis.io/apis/punchh/punchh-platform-functions-api/)
- [Punchh Headless Offers API - Platform Functions](https://apis.io/apis/punchh/punchh-platform-functions-headless-offers/)
- [Punchh Offers Ingestion API - Platform Functions](https://apis.io/apis/punchh/punchh-platform-functions-offers-ingestion/)
- [Punchh Subscription API - Platform Functions](https://apis.io/apis/punchh/punchh-platform-functions-subscription/)
- [Punchh POS API](https://apis.io/apis/punchh/punchh-pos-api/)

## Tags

Badges, Beacons, Challenges, Check-ins, Collectibles, Coupons, Drive-Thru, Feedback, File Upload, Game, Gift Cards, Invitations

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/punchh/punchh-mobile-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/punchh/.