How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Punchh Check User Balance API

The Check User Balance API from Punchh — 4 operation(s) for check user balance.

Punchh Check User Balance API is one of 46 APIs that Punchh publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 26 JSON Schema definitions.

Tagged areas include Check User Balance. 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 26 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://SERVER_NAME_GOES_HERE.punchh.com.

4 operations 4 paths 11 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{server_name}.punchh.com
Resource Areas
1

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Check User Balance 4
GET
/api/auth/checkins/balance
Fetch Account Balance of User
sso_account_balance 6 params body → 200401412422
GET
/api/auth/rewards
List Available Rewards
sso_list_available_rewards 5 params body → 200401412422
GET
/api/auth/users/balance
Fetch User Balance
sso_fetch_user_balance 6 params body → 200
GET
/api/auth/balance_timelines
Balance Timelines
sso_balance_timelines 5 params body → 200400

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Account-Balance (17 properties), Account-balance-details (15 properties), hero-content (4 properties), background-content (4 properties). Each schema is shown below with its type and property counts.

Messages
object
The messages object is returned in response to the Messages API (see the details below).
1 property
Redeemables-Attributes
array
Converted-Category-Balance
array
Coupons
array
Account-balance-details
object
15 properties
Notifications
array
Returns the details of the notifications received by a user. A maximum of 10 notifications will be fetched.
cta
array
Account-Balance
object
17 properties
background-content
object
This is the content that makes the background of the message. { "type": "image", "url": "IMAGEURL", "alttext": "Black Background Image", "initialframe": "" }
4 properties
hero-content
object
This is the first visual content that a user encounters when the user views a rich message. This can be an image or a video. { "type": "image", "url": "IMAGEUR…
4 properties
Rewards-Attribute
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

punchh-check-user-balance-api-openapi.yml Raw ↑

Other APIs Punchh publishes across the network.

Punchh POS API
Punchh Api2 API
Punchh Auth API
Punchh Badges API
Punchh Beacons API
Punchh Business Admin Users API
Punchh Business Migration Users API
Punchh Challenges API
Punchh Check In API
Punchh Check Ins API
Punchh Collectibles API
Punchh Coupons API
Where this information came from

This is an independent, third-party profile of Punchh Check User Balance API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.