Paytronix Payment API

openapi: 3.2.0
info:
  title: Paytronix Server Payment 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: Payment
  description: Stored-value recharge, saved payment methods, and auto recharge.
paths:
  /payment/recharge.json:
    post:
      operationId: rechargeStoredValue
      summary: Recharge Stored Value Card
      description: Recharge a stored-value card with a given amount using a saved or new payment method.
      tags:
      - Payment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RechargeRequest'
            examples:
              RechargeStoredValueRequestExample:
                summary: Default rechargeStoredValue request
                x-microcks-default: true
                value:
                  merchantId: 1000
                  printedCardNumber: '60490012345678'
                  amount: 25.0
                  paymentMethod:
                    type: CREDIT_CARD
                    token: string
                    lastFour: '4242'
                  address:
                    address1: string
                    address2: string
                    city: string
                    stateProvince: string
                    postalCode: string
                    country: US
      responses:
        '200':
          description: Charge response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeResponse'
              examples:
                RechargeStoredValue200Example:
                  summary: Default rechargeStoredValue 200 response
                  x-microcks-default: true
                  value:
                    result: success
                    amount: 25.0
                    cardType: VISA
                    lastFour: '4242'
                    processorAuthCode: AUTH123
                    transactionState: APPROVED
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /payment/savedPaymentMethods.json:
    get:
      operationId: getSavedPaymentMethods
      summary: Get Saved Payment Methods
      description: List the saved payment methods associated with a stored-value card.
      tags:
      - Payment
      parameters:
      - name: merchantId
        in: query
        required: true
        description: Paytronix-assigned merchant identifier.
        schema:
          type: integer
      - name: printedCardNumber
        in: query
        required: true
        description: Printed card number identifying the account.
        schema:
          type: string
      responses:
        '200':
          description: Saved payment methods.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedPaymentMethodsReply'
              examples:
                GetSavedPaymentMethods200Example:
                  summary: Default getSavedPaymentMethods 200 response
                  x-microcks-default: true
                  value:
                    result: success
                    paymentMethods:
                    - type: CREDIT_CARD
                      cardholderName: Jane Doe
                      lastFour: '4242'
                      defaultUsages:
                      - string
      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
    ChargeResponse:
      type: object
      properties:
        result:
          type: string
          example: success
        amount:
          type: number
          example: 25.0
        cardType:
          type: string
          example: VISA
        lastFour:
          type: string
          example: '4242'
        processorAuthCode:
          type: string
          example: AUTH123
        transactionState:
          type: string
          example: APPROVED
    SavedPaymentMethodsReply:
      type: object
      properties:
        result:
          type: string
          example: success
        paymentMethods:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                example: CREDIT_CARD
              cardholderName:
                type: string
                example: Jane Doe
              lastFour:
                type: string
                example: '4242'
              defaultUsages:
                type: array
                items:
                  type: string
    RechargeRequest:
      type: object
      required:
      - merchantId
      - printedCardNumber
      - amount
      - paymentMethod
      properties:
        merchantId:
          type: integer
          example: 1000
        printedCardNumber:
          type: string
          example: '60490012345678'
        amount:
          type: number
          example: 25.0
        paymentMethod:
          type: object
          properties:
            type:
              type: string
              example: CREDIT_CARD
            token:
              type: string
            lastFour:
              type: string
              example: '4242'
        address:
          $ref: '#/components/schemas/Address'
  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.