Getting Started With PAR Integrations

Overview

PAR integrations require varying levels of procedural steps to be completed as part of the release process with an integration partner. The following describes the process to integrate with PAR:

1. Contracts

2. Discovery, scoping, and kick-off

3. Develop MVP (minimum viable product)

4. Self-certification and verification

5. Documentation and training

The Process

Step 1 - Contracts

The PAR MDNA and PAR API Limited License Agreements are signed by the integration partner and PAR.

PAR API Limited License Agreement – A non-negotiable legal document related to consumption of PAR APIs and webhooks

Step 2 - Discovery, Scoping, and Kick-off

1. Discovery - The integration partner must fill out the Partner Registration Form, which captures details about integration and software security aspects. The integration partner and PAR meet to understand the architecture and capabilities of the partner's systems. PAR reviews architecture and assesses feasibility of the integration.

2. Scoping - The integration partner creates the first draft of technical documentation. PAR reviews the scope, assesses the internal roadmap, and considers the integration request. If PAR accepts the integration request, the integration partner and PAR meet to align on the required features and functionality for an MVP release of the integration. During this call, we will detail the scope using the Feature Matrix as applicable. This lists base and recommended use cases to develop for various integrations.

3. Kick-off - PAR reviews the proposed technical design. The integration partner and PAR meet to ensure that an environment has been provisioned and access to any required tools has been provided. If there are no other blockers, then MVP development may begin.

Step 3 - Develop MVP (Minimum Viable Product)

1. The integration partner starts development based on the agreed-upon scope.

2. The integration partner completes development and informs PAR Punchh.

Step 4 - Self-certification and Verification

The integration partner is responsible for self-certifcation, while both PAR Punchh and the integration partner are responsible for verification.

1. The integration partner has completed the development required to enable the customer's requested features and functionality.

2. The integration partner has completed initial QA testing using the test cases provided by PAR Punchh (as applicable).

3. The customer has accepted the partner's integration and provided approval in writing.

4. The integration partner informs PAR Punchh when the preceding steps have been completed and the customer has provided written approval for an MVP release.

5. PAR Punchh arranges a verification call with the integration partner to review the integration and ensure it meets standards for PAR Punchh and the customer.

For more information, see Integration Verification Calls - What To Expect

Step 5 - Documentation and Training

The integration partner provides PAR Punchh with final versions of technical documentation detailing the architecture of the integration. This must include:

Technical design documents (TDD)
Data sequence diagrams
Data mapping
Security, authentication, and API usage

Integration Verification Calls - What To Expect

1. PAR will schedule and arrange the verification call within 14 business days of receiving readiness confirmation from the integration partner and the customer.

2. A PAR integration verification call typically involves a virtual meeting (1-2 hours) where the integration partner will screen-share the application's interface and conduct various transactions and tests.

3. PAR will require the integration partner's team to test processing specific items, user interface, profile display, check-ins (accruals), redemptions, etc. PAR suggests using a pre-designated testing account pre-loaded with "offers" (discounts).

4. PAR will provide feedback on any items that need further development or any test cases that do not pass when applicable. PAR will schedule a follow-up verification call when further development is required.

5. PAR will provide written approval for an MVP release for the mutual customer requesting the integration after verification is complete.

Fully Certified Integrations (Extensible)

PAR accepts the strategic partner's integrations into our certification process on a case-by-case basis. The following requirements must be met before PAR will evaluate the integration partner's qualification for entry into the certification queue:

1. The integration partner developed business logic to ingest and use the required metadata to support the following Punchh loyalty programs:

Points Unlock Redeemables
Points Convert to Currency (Banked Rewards)
Points Convert to Rewards

2. The integration partner developed business logic to support the redemption of all loyalty program agnostic offers/discounts ("rewards" and "coupon/promo codes").

3. The integration partner developed business logic to support the redemption of all loyalty program dependent offers/discounts ("redeemables" and "banked currency").

4. The integration partner developed secure authentication using a PAR-approved method.

5. The integration partner has completed and passed all test cases in the PAR-provided certification matrix when applicable.

Note: PAR provides our integration partners with many self-service tools that can be used for validation, testing, and QA prior to going through the verification process. These tools include Postman collections, data sequence diagrams, sample applications, and certification matrices. These tools may not be available or applicable to all integration verticals.

Resources

Contracts

Documentation and Training

Technical design documents (TDD), including the following:

Data sequence diagrams [Link Coming Soon!]
Data mapping [Link Coming Soon!]
Security, authentication, and API usage [Link Coming Soon!]

Basic Concepts

Here is the prerequisite reading applicable to all loyalty integrations:

Punchh Support Portal

The Punchh Support Portal contains an extensive knowledge base with FAQs as well as the Punchh product documentation, including:

Platform user guides
POS installation/configuration guides
Platform and POS release notes
Partner-enablement guides

To view the Punchh product documentation on the Punchh Support Portal, you must log in to a Punchh platform production environment. If you already have access to a production environment, follow the instructions here to access the Punchh Support Portal.

Overview of Punchh Developer Welcome Pack