Paytronix

Paytronix is a cloud-based digital guest engagement platform for restaurants and convenience stores, providing loyalty programs, gift and stored-value cards, online ordering, branded mobile apps, messaging, and analytics to more than 1,800 brands. Paytronix publishes extensive public integration documentation describing a REST-based Server API with 40-plus services spanning guests, enrollment, transactions, checks, payments, gift, messaging, campaigns, stores, and mobile wallet passes. Authentication supports OAuth, client credentials (integration identifier and secret via HTTP Basic), and B2B flows. A separate Online Ordering API is documented for ordering integrations, making Paytronix a developer-friendly guest engagement provider.

Paytronix publishes 12 APIs on the APIs.io network, including Check API, Enrollment API, Gift API, and 9 more. Tagged areas include Restaurant, Loyalty, Gift Cards, Online Ordering, and Guest Engagement.

The Paytronix catalog on APIs.io includes 2 JSON-LD contexts and 2 Spectral governance rulesets.

Paytronix’s developer surface includes authentication, documentation, API reference, pricing, support, engineering blog, and 10 more developer resources.

🌐 Visit website 📡 Source on GitHub

44.7/100 developing ▼ -8.5 Agent 37/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6

AccessSelf serve

12 APIs 6 Features 4 Use Cases

RestaurantLoyaltyGift CardsOnline OrderingGuest EngagementPaymentsMessaging

Kin Score

Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6

Composite quality — 44.7/100 · developing

Contract Quality 14.9 / 25

Developer Ergonomics 6.5 / 20

Commercial Clarity 7.9 / 20

Operational Transparency 3.4 / 13

Governance 8.3 / 12

Discoverability 7.4 / 10

Agent readiness — 37/100 · agent ready

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 0 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 0 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/paytronix: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 12

Individual APIs this provider publishes, each with its own machine-readable definition.

Paytronix Check API

Check-based point accrual, reward computation, and posting.

Paytronix Enrollment API

Card creation, activation, registration, and demographic editing.

Paytronix Gift API

Gift card sale, reload, balance, redeem, and exchange.

Paytronix Guest API

Guest account and user information lookup and management.

Paytronix Menu Items API

Menu item retrieval.

Paytronix OAuth API

Guest authentication and token issuance.

Paytronix Orders API

Order creation, retrieval, and submission.

Paytronix Payment API

Stored-value recharge, saved payment methods, and auto recharge.

Paytronix Restaurants API

Restaurant and location discovery.

Paytronix Search API

Geospatial and full-text search across restaurants and menu items.

Paytronix Store API

Store and location lookup and management.

Paytronix Transaction API

Loyalty and stored-value transaction processing at the POS.

Scroll for all 12

Open Collections 2

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Paytronix Online Ordering API

OPEN COLLECTION

Paytronix Server API

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Paytronix Plans Pricing

2 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Paytronix Rate Limits

2 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Paytronix Finops

FINOPS

Features 6

Notable capabilities this provider offers.

Loyalty Programs

Points, tiers, rewards, challenges, and referrals managed through the Server API Guest, Transaction, and Check services.

Gift And Stored Value

Sell, reload, redeem, balance, and exchange gift and stored-value cards via the Gift and Transaction services.

Online Ordering

Restaurant and menu discovery, search, and order creation and submission across six order methods via the Online Ordering API.

Payments

Stored-value recharge, saved payment methods, auto recharge, and Stripe/Apple Pay/Spreedly integration via the Payment service.

Guest Enrollment

Create, activate, and register virtual and physical cards with configurable enrollment fields via the Enrollment service.

Messaging And Campaigns

Guest messaging, campaign feedback, and message-frequency preferences managed through the messaging services.

Semantic Vocabularies 2

JSON-LD contexts and semantic vocabularies used across these APIs.

Paytronix Online Ordering Api Context

11 classes · 37 properties

JSON-LD

Paytronix Server Api Context

33 classes · 116 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

Paytronix API Rules

5 rules · 3 warnings 2 info

SPECTRAL

Paytronix API Rules

39 rules · 5 errors 21 warnings 13 info

SPECTRAL

JSON Schema 45

Standalone JSON Schema definitions for this provider's data models.

Coordinates

2 properties

JSON SCHEMA

Customer

4 properties

JSON SCHEMA

DeliveryAddress

5 properties

JSON SCHEMA

Facets

0 properties

JSON SCHEMA

MenuItem

6 properties

JSON SCHEMA

MenuItemSearchResults

3 properties

JSON SCHEMA

OrderInput

6 properties

JSON SCHEMA

OrderItem

5 properties

JSON SCHEMA

Order

10 properties

JSON SCHEMA

Restaurant

13 properties

JSON SCHEMA

RestaurantSearchResults

3 properties

JSON SCHEMA

AccountInformationReply

10 properties

JSON SCHEMA

AccountQueryReply

2 properties

JSON SCHEMA

AccountQueryRequest

3 properties

JSON SCHEMA

ActivateAndRegisterRequest

5 properties

JSON SCHEMA

AddRedeemReply

3 properties

JSON SCHEMA

AddRedeemRequest

4 properties

JSON SCHEMA

Address

6 properties

JSON SCHEMA

CardInfo

3 properties

JSON SCHEMA

ChangeCardStatusRequest

3 properties

JSON SCHEMA

ChargeResponse

6 properties

JSON SCHEMA

Check

4 properties

JSON SCHEMA

ComputeRewardsReply

8 properties

JSON SCHEMA

ComputeRewardsRequest

7 properties

JSON SCHEMA

CreateAndRegisterRequest

7 properties

JSON SCHEMA

EnrollmentConfigReply

2 properties

JSON SCHEMA

EnrollmentReply

6 properties

JSON SCHEMA

GiftBalanceRequest

3 properties

JSON SCHEMA

GiftRedeemRequest

0 properties

JSON SCHEMA

GiftReply

6 properties

JSON SCHEMA

GiftRequest

8 properties

JSON SCHEMA

GuestTokenRequest

6 properties

JSON SCHEMA

GuestTokenResponse

6 properties

JSON SCHEMA

HeaderInfo

6 properties

JSON SCHEMA

Location

8 properties

JSON SCHEMA

LocationsReply

2 properties

JSON SCHEMA

PostAndAccrueRequest

8 properties

JSON SCHEMA

RechargeRequest

5 properties

JSON SCHEMA

SavedPaymentMethodsReply

2 properties

JSON SCHEMA

TransactionHistoryReply

3 properties

JSON SCHEMA

TransactionReply

5 properties

JSON SCHEMA

TransactionRequest

3 properties

JSON SCHEMA

UserInformationReply

4 properties

JSON SCHEMA

WalletBalance

3 properties

JSON SCHEMA

WalletContent

3 properties

JSON SCHEMA

Scroll for all 45

JSON Structure 45

JSON Structure definitions describing this provider's data shapes.

Online Ordering Api Coordinates Structure

2 properties

JSON STRUCTURE

Online Ordering Api Customer Structure

4 properties

JSON STRUCTURE

Online Ordering Api Delivery Address Structure

5 properties

JSON STRUCTURE

Online Ordering Api Facets Structure

0 properties

JSON STRUCTURE

Online Ordering Api Menu Item Search Results Structure

3 properties

JSON STRUCTURE

Online Ordering Api Menu Item Structure

6 properties

JSON STRUCTURE

Online Ordering Api Order Input Structure

6 properties

JSON STRUCTURE

Online Ordering Api Order Item Structure

5 properties

JSON STRUCTURE

Online Ordering Api Order Structure

10 properties

JSON STRUCTURE

Online Ordering Api Restaurant Search Results Structure

3 properties

JSON STRUCTURE

Online Ordering Api Restaurant Structure

13 properties

JSON STRUCTURE

Server Api Account Information Reply Structure

10 properties

JSON STRUCTURE

Server Api Account Query Reply Structure

2 properties

JSON STRUCTURE

Server Api Account Query Request Structure

3 properties

JSON STRUCTURE

Server Api Activate And Register Request Structure

5 properties

JSON STRUCTURE

Server Api Add Redeem Reply Structure

3 properties

JSON STRUCTURE

Server Api Add Redeem Request Structure

4 properties

JSON STRUCTURE

Server Api Address Structure

6 properties

JSON STRUCTURE

Server Api Card Info Structure

3 properties

JSON STRUCTURE

Server Api Change Card Status Request Structure

3 properties

JSON STRUCTURE

Server Api Charge Response Structure

6 properties

JSON STRUCTURE

Server Api Check Structure

4 properties

JSON STRUCTURE

Server Api Compute Rewards Reply Structure

8 properties

JSON STRUCTURE

Server Api Compute Rewards Request Structure

7 properties

JSON STRUCTURE

Server Api Create And Register Request Structure

7 properties

JSON STRUCTURE

Server Api Enrollment Config Reply Structure

2 properties

JSON STRUCTURE

Server Api Enrollment Reply Structure

6 properties

JSON STRUCTURE

Server Api Gift Balance Request Structure

3 properties

JSON STRUCTURE

Server Api Gift Redeem Request Structure

0 properties

JSON STRUCTURE

Server Api Gift Reply Structure

6 properties

JSON STRUCTURE

Server Api Gift Request Structure

8 properties

JSON STRUCTURE

Server Api Guest Token Request Structure

6 properties

JSON STRUCTURE

Server Api Guest Token Response Structure

6 properties

JSON STRUCTURE

Server Api Header Info Structure

6 properties

JSON STRUCTURE

Server Api Location Structure

8 properties

JSON STRUCTURE

Server Api Locations Reply Structure

2 properties

JSON STRUCTURE

Server Api Post And Accrue Request Structure

8 properties

JSON STRUCTURE

Server Api Recharge Request Structure

5 properties

JSON STRUCTURE

Server Api Saved Payment Methods Reply Structure

2 properties

JSON STRUCTURE

Server Api Transaction History Reply Structure

3 properties

JSON STRUCTURE

Server Api Transaction Reply Structure

5 properties

JSON STRUCTURE

Server Api Transaction Request Structure

3 properties

JSON STRUCTURE

Server Api User Information Reply Structure

4 properties

JSON STRUCTURE

Server Api Wallet Balance Structure

3 properties

JSON STRUCTURE

Server Api Wallet Content Structure

3 properties

JSON STRUCTURE

Scroll for all 45

Examples 45

Example request and response payloads for these APIs.

Online Ordering Api Coordinates Example

2 fields

EXAMPLE

Online Ordering Api Customer Example

4 fields

EXAMPLE

Online Ordering Api Delivery Address Example

5 fields

EXAMPLE

Online Ordering Api Facets Example

0 fields

EXAMPLE

Online Ordering Api Menu Item Example

6 fields

EXAMPLE

Online Ordering Api Menu Item Search Results Example

3 fields

EXAMPLE

Online Ordering Api Order Example

10 fields

EXAMPLE

Online Ordering Api Order Input Example

6 fields

EXAMPLE

Online Ordering Api Order Item Example

5 fields

EXAMPLE

Online Ordering Api Restaurant Example

13 fields

EXAMPLE

Online Ordering Api Restaurant Search Results Example

3 fields

EXAMPLE

Server Api Account Information Reply Example

10 fields

EXAMPLE

Server Api Account Query Reply Example

2 fields

EXAMPLE

Server Api Account Query Request Example

3 fields

EXAMPLE

Server Api Activate And Register Request Example

5 fields

EXAMPLE

Server Api Add Redeem Reply Example

3 fields

EXAMPLE

Server Api Add Redeem Request Example

4 fields

EXAMPLE

Server Api Address Example

6 fields

EXAMPLE

Server Api Card Info Example

3 fields

EXAMPLE

Server Api Change Card Status Request Example

3 fields

EXAMPLE

Server Api Charge Response Example

6 fields

EXAMPLE

Server Api Check Example

4 fields

EXAMPLE

Server Api Compute Rewards Reply Example

8 fields

EXAMPLE

Server Api Compute Rewards Request Example

7 fields

EXAMPLE

Server Api Create And Register Request Example

7 fields

EXAMPLE

Server Api Enrollment Config Reply Example

2 fields

EXAMPLE

Server Api Enrollment Reply Example

6 fields

EXAMPLE

Server Api Gift Balance Request Example

3 fields

EXAMPLE

Server Api Gift Redeem Request Example

9 fields

EXAMPLE

Server Api Gift Reply Example

6 fields

EXAMPLE

Server Api Gift Request Example

8 fields

EXAMPLE

Server Api Guest Token Request Example

6 fields

EXAMPLE

Server Api Guest Token Response Example

6 fields

EXAMPLE

Server Api Header Info Example

6 fields

EXAMPLE

Server Api Location Example

8 fields

EXAMPLE

Server Api Locations Reply Example

2 fields

EXAMPLE

Server Api Post And Accrue Request Example

8 fields

EXAMPLE

Server Api Recharge Request Example

5 fields

EXAMPLE

Server Api Saved Payment Methods Reply Example

2 fields

EXAMPLE

Server Api Transaction History Reply Example

3 fields

EXAMPLE

Server Api Transaction Reply Example

5 fields

EXAMPLE

Server Api Transaction Request Example

3 fields

EXAMPLE

Server Api User Information Reply Example

4 fields

EXAMPLE

Server Api Wallet Balance Example

3 fields

EXAMPLE

Server Api Wallet Content Example

3 fields

EXAMPLE

Scroll for all 45

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Paytronix Authentication

http · 2 schemes

SECURITY

Paytronix Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Paytronix Agentic Access

30 operations · 17 acting

AGENTIC

Use Cases 4

What developers build with this provider.

Branded Loyalty Mobile App

Authenticate guests with the OAuth Service and surface balances, tiers, and transaction history from the Guest service.

Point-Of-Sale Loyalty Integration

Activate cards, accrue points, and redeem rewards at the register using the Transaction and Check services.

Gift Card Program

Sell and redeem gift cards online and in store with the Gift service and stored-value recharge via the Payment service.

Online And Mobile Ordering

Build ordering experiences with restaurant/menu search and order submission through the Online Ordering API.

Integrations 5

Pre-built integrations with other platforms and tools.

Stripe

Payment processing via checkout sessions and payment intents in the Payment service.

Apple Pay

Apple Pay merchant validation and domain registration in the Payment service.

Spreedly

Card tokenization via Spreedly iframe parameters in the Payment service.

Apple Wallet

Mobile wallet passes via the Apple Passbook service.

Google Wallet

Mobile wallet passes via the Google Wallet (Android Pay) service.

Resources

Documentation 2

Reference material describing how the API behaves

Documentation

Documentation

APIReference

APIReference

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

Design & Contract 2

Pagination, idempotency, versioning, errors, and events

SpectralRules

SpectralRules

Vocabulary

Vocabulary

Build 1

SDKs, sample code, and the tooling you integrate with

GitHubOrganization

GitHubOrganization

Access & Security 2

Authentication, authorization, and security posture

DomainSecurity

DomainSecurity

Authentication

Authentication

Operate 2

Status, limits, changes, and where to get help

Support

Support

RateLimits

RateLimits

Commercial 3

Pricing, plans, and the legal terms of use

Pricing

Pricing

Plans

Plans

FinOps

FinOps

Company 3

The organization behind the API

Website

Website

Blog

Blog

LinkedIn

Source (apis.yml)

aid: paytronix
name: Paytronix
description: Paytronix is a cloud-based digital guest engagement platform for restaurants and convenience stores, providing
  loyalty programs, gift and stored-value cards, online ordering, branded mobile apps, messaging, and analytics to more than
  1,800 brands. Paytronix publishes extensive public integration documentation describing a REST-based Server API with 40-plus
  services spanning guests, enrollment, transactions, checks, payments, gift, messaging, campaigns, stores, and mobile wallet
  passes. Authentication supports OAuth, client credentials (integration identifier and secret via HTTP Basic), and B2B flows.
  A separate Online Ordering API is documented for ordering integrations, making Paytronix a developer-friendly guest engagement
  provider.
type: Index
accessModel:
  pricing: unknown
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/paytronix.png
tags:
- Restaurant
- Loyalty
- Gift Cards
- Online Ordering
- Guest Engagement
- Payments
- Messaging
url: https://raw.githubusercontent.com/api-evangelist/paytronix/refs/heads/main/apis.yml
created: '2026-06-02'
modified: '2026-06-03'
specificationVersion: '0.19'
apis:
- aid: paytronix:paytronix-check-api
  name: Paytronix Check API
  description: Check-based point accrual, reward computation, and posting.
  humanURL: https://developers.paytronix.com/pxs_api_reference/index.html
  baseURL: https://m{merchantId}.api.paytronix.com/rest/26.6
  tags:
  - Check
  properties:
  - type: OpenAPI
    url: openapi/paytronix-check-api-openapi.yml
  - type: Documentation
    url: https://developers.paytronix.com/pxs_api_reference/index.html
  - type: Authentication
    url: https://developers.paytronix.com/pxs_api_reference/oauth.html
  - type: GettingStarted
    url: https://developers.paytronix.com/welcome/index.html
  - type: JSONSchema
    url: json-schema/server-api-account-information-reply-schema.json
  - type: JSONStructure
    url: json-structure/server-api-account-information-reply-structure.json
  - type: Examples
    url: examples/server-api-account-information-reply-example.json
  - type: JSONLD
    url: json-ld/paytronix-server-api-context.jsonld
  - type: Documentation
    url: http://docs.opendining.net/
  - type: JSONSchema
    url: json-schema/online-ordering-api-order-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-api-order-structure.json
  - type: Examples
    url: examples/online-ordering-api-order-example.json
  - type: JSONLD
    url: json-ld/paytronix-online-ordering-api-context.jsonld
- aid: paytronix:paytronix-enrollment-api
  name: Paytronix Enrollment API
  description: Card creation, activation, registration, and demographic editing.
  humanURL: https://developers.paytronix.com/pxs_api_reference/index.html
  baseURL: https://m{merchantId}.api.paytronix.com/rest/26.6
  tags:
  - Enrollment
  properties:
  - type: OpenAPI
    url: openapi/paytronix-enrollment-api-openapi.yml
  - type: Documentation
    url: https://developers.paytronix.com/pxs_api_reference/index.html
  - type: Authentication
    url: https://developers.paytronix.com/pxs_api_reference/oauth.html
  - type: GettingStarted
    url: https://developers.paytronix.com/welcome/index.html
  - type: JSONSchema
    url: json-schema/server-api-account-information-reply-schema.json
  - type: JSONStructure
    url: json-structure/server-api-account-information-reply-structure.json
  - type: Examples
    url: examples/server-api-account-information-reply-example.json
  - type: JSONLD
    url: json-ld/paytronix-server-api-context.jsonld
  - type: Documentation
    url: http://docs.opendining.net/
  - type: JSONSchema
    url: json-schema/online-ordering-api-order-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-api-order-structure.json
  - type: Examples
    url: examples/online-ordering-api-order-example.json
  - type: JSONLD
    url: json-ld/paytronix-online-ordering-api-context.jsonld
- aid: paytronix:paytronix-gift-api
  name: Paytronix Gift API
  description: Gift card sale, reload, balance, redeem, and exchange.
  humanURL: https://developers.paytronix.com/pxs_api_reference/index.html
  baseURL: https://m{merchantId}.api.paytronix.com/rest/26.6
  tags:
  - Gift
  properties:
  - type: OpenAPI
    url: openapi/paytronix-gift-api-openapi.yml
  - type: Documentation
    url: https://developers.paytronix.com/pxs_api_reference/index.html
  - type: Authentication
    url: https://developers.paytronix.com/pxs_api_reference/oauth.html
  - type: GettingStarted
    url: https://developers.paytronix.com/welcome/index.html
  - type: JSONSchema
    url: json-schema/server-api-account-information-reply-schema.json
  - type: JSONStructure
    url: json-structure/server-api-account-information-reply-structure.json
  - type: Examples
    url: examples/server-api-account-information-reply-example.json
  - type: JSONLD
    url: json-ld/paytronix-server-api-context.jsonld
  - type: Documentation
    url: http://docs.opendining.net/
  - type: JSONSchema
    url: json-schema/online-ordering-api-order-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-api-order-structure.json
  - type: Examples
    url: examples/online-ordering-api-order-example.json
  - type: JSONLD
    url: json-ld/paytronix-online-ordering-api-context.jsonld
- aid: paytronix:paytronix-guest-api
  name: Paytronix Guest API
  description: Guest account and user information lookup and management.
  humanURL: https://developers.paytronix.com/pxs_api_reference/index.html
  baseURL: https://m{merchantId}.api.paytronix.com/rest/26.6
  tags:
  - Guest
  properties:
  - type: OpenAPI
    url: openapi/paytronix-guest-api-openapi.yml
  - type: Documentation
    url: https://developers.paytronix.com/pxs_api_reference/index.html
  - type: Authentication
    url: https://developers.paytronix.com/pxs_api_reference/oauth.html
  - type: GettingStarted
    url: https://developers.paytronix.com/welcome/index.html
  - type: JSONSchema
    url: json-schema/server-api-account-information-reply-schema.json
  - type: JSONStructure
    url: json-structure/server-api-account-information-reply-structure.json
  - type: Examples
    url: examples/server-api-account-information-reply-example.json
  - type: JSONLD
    url: json-ld/paytronix-server-api-context.jsonld
  - type: Documentation
    url: http://docs.opendining.net/
  - type: JSONSchema
    url: json-schema/online-ordering-api-order-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-api-order-structure.json
  - type: Examples
    url: examples/online-ordering-api-order-example.json
  - type: JSONLD
    url: json-ld/paytronix-online-ordering-api-context.jsonld
- aid: paytronix:paytronix-menu-items-api
  name: Paytronix Menu Items API
  description: Menu item retrieval.
  humanURL: https://developers.paytronix.com/pxs_api_reference/index.html
  baseURL: https://m{merchantId}.api.paytronix.com/rest/26.6
  tags:
  - Menu Items
  properties:
  - type: OpenAPI
    url: openapi/paytronix-menu-items-api-openapi.yml
  - type: Documentation
    url: https://developers.paytronix.com/pxs_api_reference/index.html
  - type: Authentication
    url: https://developers.paytronix.com/pxs_api_reference/oauth.html
  - type: GettingStarted
    url: https://developers.paytronix.com/welcome/index.html
  - type: JSONSchema
    url: json-schema/server-api-account-information-reply-schema.json
  - type: JSONStructure
    url: json-structure/server-api-account-information-reply-structure.json
  - type: Examples
    url: examples/server-api-account-information-reply-example.json
  - type: JSONLD
    url: json-ld/paytronix-server-api-context.jsonld
  - type: Documentation
    url: http://docs.opendining.net/
  - type: JSONSchema
    url: json-schema/online-ordering-api-order-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-api-order-structure.json
  - type: Examples
    url: examples/online-ordering-api-order-example.json
  - type: JSONLD
    url: json-ld/paytronix-online-ordering-api-context.jsonld
- aid: paytronix:paytronix-oauth-api
  name: Paytronix OAuth API
  description: Guest authentication and token issuance.
  humanURL: https://developers.paytronix.com/pxs_api_reference/index.html
  baseURL: https://m{merchantId}.api.paytronix.com/rest/26.6
  tags:
  - OAuth
  properties:
  - type: OpenAPI
    url: openapi/paytronix-oauth-api-openapi.yml
  - type: Documentation
    url: https://developers.paytronix.com/pxs_api_reference/index.html
  - type: Authentication
    url: https://developers.paytronix.com/pxs_api_reference/oauth.html
  - type: GettingStarted
    url: https://developers.paytronix.com/welcome/index.html
  - type: JSONSchema
    url: json-schema/server-api-account-information-reply-schema.json
  - type: JSONStructure
    url: json-structure/server-api-account-information-reply-structure.json
  - type: Examples
    url: examples/server-api-account-information-reply-example.json
  - type: JSONLD
    url: json-ld/paytronix-server-api-context.jsonld
  - type: Documentation
    url: http://docs.opendining.net/
  - type: JSONSchema
    url: json-schema/online-ordering-api-order-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-api-order-structure.json
  - type: Examples
    url: examples/online-ordering-api-order-example.json
  - type: JSONLD
    url: json-ld/paytronix-online-ordering-api-context.jsonld
- aid: paytronix:paytronix-orders-api
  name: Paytronix Orders API
  description: Order creation, retrieval, and submission.
  humanURL: https://developers.paytronix.com/pxs_api_reference/index.html
  baseURL: https://m{merchantId}.api.paytronix.com/rest/26.6
  tags:
  - Orders
  properties:
  - type: OpenAPI
    url: openapi/paytronix-orders-api-openapi.yml
  - type: Documentation
    url: https://developers.paytronix.com/pxs_api_reference/index.html
  - type: Authentication
    url: https://developers.paytronix.com/pxs_api_reference/oauth.html
  - type: GettingStarted
    url: https://developers.paytronix.com/welcome/index.html
  - type: JSONSchema
    url: json-schema/server-api-account-information-reply-schema.json
  - type: JSONStructure
    url: json-structure/server-api-account-information-reply-structure.json
  - type: Examples
    url: examples/server-api-account-information-reply-example.json
  - type: JSONLD
    url: json-ld/paytronix-server-api-context.jsonld
  - type: Documentation
    url: http://docs.opendining.net/
  - type: JSONSchema
    url: json-schema/online-ordering-api-order-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-api-order-structure.json
  - type: Examples
    url: examples/online-ordering-api-order-example.json
  - type: JSONLD
    url: json-ld/paytronix-online-ordering-api-context.jsonld
- aid: paytronix:paytronix-payment-api
  name: Paytronix Payment API
  description: Stored-value recharge, saved payment methods, and auto recharge.
  humanURL: https://developers.paytronix.com/pxs_api_reference/index.html
  baseURL: https://m{merchantId}.api.paytronix.com/rest/26.6
  tags:
  - Payment
  properties:
  - type: OpenAPI
    url: openapi/paytronix-payment-api-openapi.yml
  - type: Documentation
    url: https://developers.paytronix.com/pxs_api_reference/index.html
  - type: Authentication
    url: https://developers.paytronix.com/pxs_api_reference/oauth.html
  - type: GettingStarted
    url: https://developers.paytronix.com/welcome/index.html
  - type: JSONSchema
    url: json-schema/server-api-account-information-reply-schema.json
  - type: JSONStructure
    url: json-structure/server-api-account-information-reply-structure.json
  - type: Examples
    url: examples/server-api-account-information-reply-example.json
  - type: JSONLD
    url: json-ld/paytronix-server-api-context.jsonld
  - type: Documentation
    url: http://docs.opendining.net/
  - type: JSONSchema
    url: json-schema/online-ordering-api-order-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-api-order-structure.json
  - type: Examples
    url: examples/online-ordering-api-order-example.json
  - type: JSONLD
    url: json-ld/paytronix-online-ordering-api-context.jsonld
- aid: paytronix:paytronix-restaurants-api
  name: Paytronix Restaurants API
  description: Restaurant and location discovery.
  humanURL: https://developers.paytronix.com/pxs_api_reference/index.html
  baseURL: https://m{merchantId}.api.paytronix.com/rest/26.6
  tags:
  - Restaurants
  properties:
  - type: OpenAPI
    url: openapi/paytronix-restaurants-api-openapi.yml
  - type: Documentation
    url: https://developers.paytronix.com/pxs_api_reference/index.html
  - type: Authentication
    url: https://developers.paytronix.com/pxs_api_reference/oauth.html
  - type: GettingStarted
    url: https://developers.paytronix.com/welcome/index.html
  - type: JSONSchema
    url: json-schema/server-api-account-information-reply-schema.json
  - type: JSONStructure
    url: json-structure/server-api-account-information-reply-structure.json
  - type: Examples
    url: examples/server-api-account-information-reply-example.json
  - type: JSONLD
    url: json-ld/paytronix-server-api-context.jsonld
  - type: Documentation
    url: http://docs.opendining.net/
  - type: JSONSchema
    url: json-schema/online-ordering-api-order-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-api-order-structure.json
  - type: Examples
    url: examples/online-ordering-api-order-example.json
  - type: JSONLD
    url: json-ld/paytronix-online-ordering-api-context.jsonld
- aid: paytronix:paytronix-search-api
  name: Paytronix Search API
  description: Geospatial and full-text search across restaurants and menu items.
  humanURL: https://developers.paytronix.com/pxs_api_reference/index.html
  baseURL: https://m{merchantId}.api.paytronix.com/rest/26.6
  tags:
  - Search
  properties:
  - type: OpenAPI
    url: openapi/paytronix-search-api-openapi.yml
  - type: Documentation
    url: https://developers.paytronix.com/pxs_api_reference/index.html
  - type: Authentication
    url: https://developers.paytronix.com/pxs_api_reference/oauth.html
  - type: GettingStarted
    url: https://developers.paytronix.com/welcome/index.html
  - type: JSONSchema
    url: json-schema/server-api-account-information-reply-schema.json
  - type: JSONStructure
    url: json-structure/server-api-account-information-reply-structure.json
  - type: Examples
    url: examples/server-api-account-information-reply-example.json
  - type: JSONLD
    url: json-ld/paytronix-server-api-context.jsonld
  - type: Documentation
    url: http://docs.opendining.net/
  - type: JSONSchema
    url: json-schema/online-ordering-api-order-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-api-order-structure.json
  - type: Examples
    url: examples/online-ordering-api-order-example.json
  - type: JSONLD
    url: json-ld/paytronix-online-ordering-api-context.jsonld
- aid: paytronix:paytronix-store-api
  name: Paytronix Store API
  description: Store and location lookup and management.
  humanURL: https://developers.paytronix.com/pxs_api_reference/index.html
  baseURL: https://m{merchantId}.api.paytronix.com/rest/26.6
  tags:
  - Store
  properties:
  - type: OpenAPI
    url: openapi/paytronix-store-api-openapi.yml
  - type: Documentation
    url: https://developers.paytronix.com/pxs_api_reference/index.html
  - type: Authentication
    url: https://developers.paytronix.com/pxs_api_reference/oauth.html
  - type: GettingStarted
    url: https://developers.paytronix.com/welcome/index.html
  - type: JSONSchema
    url: json-schema/server-api-account-information-reply-schema.json
  - type: JSONStructure
    url: json-structure/server-api-account-information-reply-structure.json
  - type: Examples
    url: examples/server-api-account-information-reply-example.json
  - type: JSONLD
    url: json-ld/paytronix-server-api-context.jsonld
  - type: Documentation
    url: http://docs.opendining.net/
  - type: JSONSchema
    url: json-schema/online-ordering-api-order-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-api-order-structure.json
  - type: Examples
    url: examples/online-ordering-api-order-example.json
  - type: JSONLD
    url: json-ld/paytronix-online-ordering-api-context.jsonld
- aid: paytronix:paytronix-transaction-api
  name: Paytronix Transaction API
  description: Loyalty and stored-value transaction processing at the POS.
  humanURL: https://developers.paytronix.com/pxs_api_reference/index.html
  baseURL: https://m{merchantId}.api.paytronix.com/rest/26.6
  tags:
  - Transaction
  properties:
  - type: OpenAPI
    url: openapi/paytronix-transaction-api-openapi.yml
  - type: Documentation
    url: https://developers.paytronix.com/pxs_api_reference/index.html
  - type: Authentication
    url: https://developers.paytronix.com/pxs_api_reference/oauth.html
  - type: GettingStarted
    url: https://developers.paytronix.com/welcome/index.html
  - type: JSONSchema
    url: json-schema/server-api-account-information-reply-schema.json
  - type: JSONStructure
    url: json-structure/server-api-account-information-reply-structure.json
  - type: Examples
    url: examples/server-api-account-information-reply-example.json
  - type: JSONLD
    url: json-ld/paytronix-server-api-context.jsonld
  - type: Documentation
    url: http://docs.opendining.net/
  - type: JSONSchema
    url: json-schema/online-ordering-api-order-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-api-order-structure.json
  - type: Examples
    url: examples/online-ordering-api-order-example.json
  - type: JSONLD
    url: json-ld/paytronix-online-ordering-api-context.jsonld
common:
- type: AgenticAccess
  url: agentic-access/paytronix-agentic-access.yml
- type: DomainSecurity
  url: security/paytronix-domain-security.yml
- type: Authentication
  url: authentication/paytronix-authentication.yml
- type: Website
  url: https://www.paytronix.com/
- type: Documentation
  url: https://developers.paytronix.com/
- type: APIReference
  url: https://developers.paytronix.com/pxs_api_reference/index.html
- type: Pricing
  url: https://www.paytronix.com/pricing/
- type: Support
  url: https://www.paytronix.com/support/
- type: Blog
  url: https://www.paytronix.com/blog
- type: LinkedIn
  url: https://www.linkedin.com/company/paytronix-systems
- type: GitHubOrganization
  url: https://github.com/paytronix
- type: SpectralRules
  url: rules/paytronix-spectral-rules.yml
- type: Vocabulary
  url: vocabulary/paytronix-vocabulary.yml
- type: Plans
  url: plans/paytronix-plans-pricing.yml
- type: RateLimits
  url: rate-limits/paytronix-rate-limits.yml
- type: FinOps
  url: finops/paytronix-finops.yml
- type: Features
  data:
  - name: Loyalty Programs
    description: Points, tiers, rewards, challenges, and referrals managed through the Server API Guest, Transaction, and
      Check services.
  - name: Gift And Stored Value
    description: Sell, reload, redeem, balance, and exchange gift and stored-value cards via the Gift and Transaction services.
  - name: Online Ordering
    description: Restaurant and menu discovery, search, and order creation and submission across six order methods via the
      Online Ordering API.
  - name: Payments
    description: Stored-value recharge, saved payment methods, auto recharge, and Stripe/Apple Pay/Spreedly integration via
      the Payment service.
  - name: Guest Enrollment
    description: Create, activate, and register virtual and physical cards with configurable enrollment fields via the Enrollment
      service.
  - name: Messaging And Campaigns
    description: Guest messaging, campaign feedback, and message-frequency preferences managed through the messaging services.
- type: UseCases
  data:
  - name: Branded Loyalty Mobile App
    description: Authenticate guests with the OAuth Service and surface balances, tiers, and transaction history from the
      Guest service.
  - name: Point-Of-Sale Loyalty Integration
    description: Activate cards, accrue points, and redeem rewards at the register using the Transaction and Check services.
  - name: Gift Card Program
    description: Sell and redeem gift cards online and in store with the Gift service and stored-value recharge via the Payment
      service.
  - name: Online And Mobile Ordering
    description: Build ordering experiences with restaurant/menu search and order submission through the Online Ordering API.
- type: Integrations
  data:
  - name: Stripe
    description: Payment processing via checkout sessions and payment intents in the Payment service.
  - name: Apple Pay
    description: Apple Pay merchant validation and domain registration in the Payment service.
  - name: Spreedly
    description: Card tokenization via Spreedly iframe parameters in the Payment service.
  - name: Apple Wallet
    description: Mobile wallet passes via the Apple Passbook service.
  - name: Google Wallet
    description: Mobile wallet passes via the Google Wallet (Android Pay) service.
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com