PAR Pay Service API — Overview

The PAR Pay Service API provides a unified interface for processing credit card and gift card payment transactions. It enables merchants and integrators to handle the full payment lifecycle — from authorization and capture to refunds and voids — along with gift card management operations such as issuing, activating, redeeming, and balance inquiries.

The API also includes transaction query endpoints for retrieving transaction history and status across both credit card and gift card operations, as well as health check endpoints for monitoring application health and readiness.

Prerequisites

The brand should be onboarded first in order to use these APIs. Contact your Punchh representative for the onboarding process.

Authentication

All API requests require two credentials sent as headers:

Header	Type	Description
Authorization	Bearer JWT	A valid JWT token using the Bearer scheme.
X-LocationId	API Key	A valid Location ID identifying the merchant location.

API Groups

The PAR Pay Service API is organized into five groups:

Authentication

Endpoint for obtaining access tokens.

Method	Endpoint	Description
POST	/oauth/token	Obtain a JWT access token using client credentials

Credit Card

Endpoints for processing credit card transactions and managing saved cards.

Method	Endpoint	Description
POST	/creditcard/v1/purchase	Process a credit card purchase transaction
POST	/creditcard/v1/preauth	Preauthorize a credit card transaction without capturing funds
POST	/creditcard/v1/capture	Capture a previously preauthorized transaction
POST	/creditcard/v1/void	Void a previously preauthorized or captured transaction
POST	/creditcard/v1/refund	Refund a previously completed transaction
GET	/creditcard/v1/iframeurl	Retrieve a hosted iFrame URL for secure card data entry
GET	/creditcard/v1/googlepayconfiguration	Retrieve Google Pay configuration details
GET	/creditcard/v1/creditcards	Retrieve saved credit cards for a user
PATCH	/creditcard/v1/creditcards	Update the preferred status of a saved credit card

See Credit Card Payment Flow for detailed transaction flows and diagrams.

Gift Card

Endpoints for gift card transactions, issuance, and saved card management.

Method	Endpoint	Description
POST	/giftcard/v1/redeem	Redeem an amount from a gift card
POST	/giftcard/v1/balanceInquiry	Check the current balance of a gift card
POST	/giftcard/v1/reload	Reload a gift card with a specified amount
POST	/giftcard/v1/refund	Refund an amount back to a gift card
POST	/giftcard/v1/balanceTransfer	Transfer balance from one gift card to another
POST	/giftcard/v1/virtual/issue	Issue a new virtual gift card
POST	/giftcard/v1/savegiftcard	Save a gift card to a user's account
POST	/giftcard/v1/sharegiftcard	Share a saved gift card with another user
POST	/giftcard/v1/gift	Gift a digital gift card to a recipient
POST	/giftcard/v1/combine	Combine multiple gift card balances into a single target card
GET	/giftcard/v1/giftcards	Retrieve saved gift cards for a user
PATCH	/giftcard/v1/giftcards	Update the preferred status of a saved gift card

See Gift Card Flow for detailed transaction flows and diagrams.

Transactions

Endpoints for querying transaction history and status.

Method	Endpoint	Description
GET	/transactions/v1/status/{id}	Get the status of a specific transaction (credit card or gift card)
GET	/transactions/v1	List transactions with filters and pagination

Health Check

Endpoints for monitoring application health and readiness.

Method	Endpoint	Description
GET	/health	Check overall application health status
GET	/health/ready	Check application readiness with component-level health details

See Health Check Flow for detailed health check and readiness diagrams.