Paytronix OAuth API

openapi: 3.2.0
info:
  title: Paytronix Server O Auth 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: OAuth
  description: Guest authentication and token issuance.
paths:
  /oauth/requestGuestToken.json:
    post:
      operationId: requestGuestToken
      summary: Request Guest Token
      description: Authenticate a guest in a merchant program and issue an OAuth access token. Supports password, one_time_password, authorization_code, refresh_token, and fieldset grant types.
      tags:
      - OAuth
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GuestTokenRequest'
            examples:
              RequestGuestTokenRequestExample:
                summary: Default requestGuestToken request
                x-microcks-default: true
                value:
                  merchantId: 1000
                  grant_type: password
                  username: jdoe
                  password: s3cret
                  scope: user_read account_read
                  refresh_token: string
      responses:
        '200':
          description: Token issued.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GuestTokenResponse'
              examples:
                RequestGuestToken200Example:
                  summary: Default requestGuestToken 200 response
                  x-microcks-default: true
                  value:
                    access_token: 9f8c1a2b3c4d5e6f
                    token_type: bearer
                    expires_in: 1800
                    refresh_token: 1a2b3c4d5e6f7a8b
                    scope: user_read account_read
                    username: jdoe
        '400':
          description: Invalid grant or credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReply'
              examples:
                RequestGuestToken400Example:
                  summary: Default requestGuestToken 400 response
                  x-microcks-default: true
                  value:
                    result: failure
                    errorCode: invalid_grant
                    errorMessage: The supplied credentials were not valid.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    GuestTokenRequest:
      type: object
      required:
      - merchantId
      - grant_type
      properties:
        merchantId:
          type: integer
          example: 1000
        grant_type:
          type: string
          example: password
          enum:
          - password
          - one_time_password
          - authorization_code
          - refresh_token
          - http://paytronix.com/oauth/fieldset
        username:
          type: string
          example: jdoe
        password:
          type: string
          example: s3cret
        scope:
          type: string
          example: user_read account_read
        refresh_token:
          type: string
    ErrorReply:
      type: object
      description: Standard failure envelope returned across PXS services.
      properties:
        result:
          type: string
          example: failure
        errorCode:
          type: string
          example: invalid_grant
        errorMessage:
          type: string
          example: The supplied credentials were not valid.
    GuestTokenResponse:
      type: object
      properties:
        access_token:
          type: string
          example: 9f8c1a2b3c4d5e6f
        token_type:
          type: string
          example: bearer
        expires_in:
          type: integer
          example: 1800
        refresh_token:
          type: string
          example: 1a2b3c4d5e6f7a8b
        scope:
          type: string
          example: user_read account_read
        username:
          type: string
          example: jdoe
  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.