Paytronix Store API

openapi: 3.2.0
info:
  title: Paytronix Server Store API
  version: '26.6'
  description: The Paytronix Server (PXS) REST API exposes the guest engagement platform used by 1,800-plus restaurant and convenience-store brands. It spans loyalty and stored-value accounts, enrollment and registration, transactions and point accrual, gift card sales and redemption, stored-value recharge and payment, store/location lookup, and guest authentication. All requests and responses are JSON. Operations authenticate with an integration identifier and secret sent as an HTTP Basic authorization header; guest-scoped operations additionally use an OAuth bearer token issued by the OAuth Service. This specification was generated from the public Paytronix integration documentation at https://developers.paytronix.com.
  contact:
    name: Kin Lane
    email: kin@apievangelist.com
  x-generated-from: documentation
  x-source-url: https://developers.paytronix.com/pxs_api_reference/index.html
  x-last-validated: '2026-06-03'
servers:
- url: https://m{merchantId}.api.{server}.com/rest/{release}
  description: Paytronix REST base URL. The hostname embeds the merchant ID (mMID) and the assigned server; the path embeds the release/version (e.g. 26.6).
  variables:
    merchantId:
      default: '1000'
      description: Paytronix-assigned merchant identifier (mMID).
    server:
      default: paytronix
      description: Assigned Paytronix server name.
    release:
      default: '26.6'
      description: API release/version the request body conforms to.
security:
- basicAuth: []
tags:
- name: Store
  description: Store and location lookup and management.
paths:
  /store/nearbyLocations.json:
    get:
      operationId: getNearbyLocations
      summary: Get Nearby Locations
      description: Retrieve store locations within a maximum distance of a latitude and longitude, ordered by distance.
      tags:
      - Store
      parameters:
      - name: merchantId
        in: query
        required: true
        description: Paytronix-assigned merchant identifier.
        schema:
          type: integer
      - name: latitude
        in: query
        required: true
        description: Search center latitude.
        schema:
          type: number
          format: double
      - name: longitude
        in: query
        required: true
        description: Search center longitude.
        schema:
          type: number
          format: double
      - name: maxDistance
        in: query
        required: true
        description: Maximum distance in miles.
        schema:
          type: number
      - name: maxLocations
        in: query
        required: true
        description: Maximum number of results.
        schema:
          type: integer
      - name: storeGroupCode
        in: query
        required: false
        description: Optional store group filter.
        schema:
          type: string
      responses:
        '200':
          description: Nearby locations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationsReply'
              examples:
                GetNearbyLocations200Example:
                  summary: Default getNearbyLocations 200 response
                  x-microcks-default: true
                  value:
                    result: success
                    locations:
                    - code: '1'
                      name: Downtown
                      address:
                        address1: string
                        address2: string
                        city: string
                        stateProvince: string
                        postalCode: string
                        country: US
                      latitude: 42.3601
                      longitude: -71.0589
                      hoursOfOperation: string
                      distance: 1.2
                      metadata: {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /store/stores.json:
    get:
      operationId: getStores
      summary: Get All Stores
      description: Retrieve the complete list of all store locations for a merchant.
      tags:
      - Store
      parameters:
      - name: merchantId
        in: query
        required: true
        description: Paytronix-assigned merchant identifier.
        schema:
          type: integer
      responses:
        '200':
          description: All store locations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationsReply'
              examples:
                GetStores200Example:
                  summary: Default getStores 200 response
                  x-microcks-default: true
                  value:
                    result: success
                    locations:
                    - code: '1'
                      name: Downtown
                      address:
                        address1: string
                        address2: string
                        city: string
                        stateProvince: string
                        postalCode: string
                        country: US
                      latitude: 42.3601
                      longitude: -71.0589
                      hoursOfOperation: string
                      distance: 1.2
                      metadata: {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Address:
      type: object
      properties:
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        stateProvince:
          type: string
        postalCode:
          type: string
        country:
          type: string
          example: US
    LocationsReply:
      type: object
      properties:
        result:
          type: string
          example: success
        locations:
          type: array
          items:
            $ref: '#/components/schemas/Location'
    Location:
      type: object
      properties:
        code:
          type: string
          example: '1'
        name:
          type: string
          example: Downtown
        address:
          $ref: '#/components/schemas/Address'
        latitude:
          type: number
          format: double
          example: 42.3601
        longitude:
          type: number
          format: double
          example: -71.0589
        hoursOfOperation:
          type: string
        distance:
          type: number
          example: 1.2
        metadata:
          type: object
          additionalProperties: true
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with the base64-encoded integration identifier and secret (identifier:secret).
    guestBearer:
      type: http
      scheme: bearer
      bearerFormat: OAuth
      description: OAuth bearer token issued by the OAuth Service for guest-scoped operations.