Paytronix

Paytronix Gift API

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

Documentation GitHub OpenAPI

Operations 4

POST /gift/sell.json Sell Gift Card #

POST /gift/reload.json Reload Gift Card #

POST /gift/balance.json Get Gift Card Balance #

POST /gift/redeem.json Redeem Gift Card #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/paytronix-gift-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Paytronix Server Gift 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: Gift
  description: Gift card sale, reload, balance, redeem, and exchange.
paths:
  /gift/sell.json:
    post:
      operationId: sellGiftCard
      summary: Sell Gift Card
      description: Activate a gift card and add the initial value to it.
      tags:
      - Gift
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GiftRequest'
            examples:
              SellGiftCardRequestExample:
                summary: Default sellGiftCard request
                x-microcks-default: true
                value:
                  merchantId: 1000
                  storeCode: '1'
                  cardInfo:
                    printedCardNumber: '60490012345678'
                    magstripe: string
                    cardTemplateCode: '1'
                  amount: 25.0
                  checkNumber: string
                  cashier: string
                  terminalId: string
                  externalTransactionId: string
      responses:
        '200':
          description: Gift transaction reply.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GiftReply'
              examples:
                SellGiftCard200Example:
                  summary: Default sellGiftCard 200 response
                  x-microcks-default: true
                  value:
                    result: success
                    pxTransactionId: GIFT-44556
                    printedCardNumber: '70123456789012'
                    currentBalance: 50.0
                    errorCode: string
                    errorMessage: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /gift/reload.json:
    post:
      operationId: reloadGiftCard
      summary: Reload Gift Card
      description: Add value to a gift card that has already been activated.
      tags:
      - Gift
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GiftRequest'
            examples:
              ReloadGiftCardRequestExample:
                summary: Default reloadGiftCard request
                x-microcks-default: true
                value:
                  merchantId: 1000
                  storeCode: '1'
                  cardInfo:
                    printedCardNumber: '60490012345678'
                    magstripe: string
                    cardTemplateCode: '1'
                  amount: 25.0
                  checkNumber: string
                  cashier: string
                  terminalId: string
                  externalTransactionId: string
      responses:
        '200':
          description: Gift transaction reply.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GiftReply'
              examples:
                ReloadGiftCard200Example:
                  summary: Default reloadGiftCard 200 response
                  x-microcks-default: true
                  value:
                    result: success
                    pxTransactionId: GIFT-44556
                    printedCardNumber: '70123456789012'
                    currentBalance: 50.0
                    errorCode: string
                    errorMessage: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /gift/balance.json:
    post:
      operationId: getGiftBalance
      summary: Get Gift Card Balance
      description: Retrieve the current balance of a gift card.
      tags:
      - Gift
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GiftBalanceRequest'
            examples:
              GetGiftBalanceRequestExample:
                summary: Default getGiftBalance request
                x-microcks-default: true
                value:
                  merchantId: 1000
                  storeCode: '1'
                  cardInfo:
                    printedCardNumber: '60490012345678'
                    magstripe: string
                    cardTemplateCode: '1'
      responses:
        '200':
          description: Gift transaction reply with current balance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GiftReply'
              examples:
                GetGiftBalance200Example:
                  summary: Default getGiftBalance 200 response
                  x-microcks-default: true
                  value:
                    result: success
                    pxTransactionId: GIFT-44556
                    printedCardNumber: '70123456789012'
                    currentBalance: 50.0
                    errorCode: string
                    errorMessage: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /gift/redeem.json:
    post:
      operationId: redeemGiftCard
      summary: Redeem Gift Card
      description: Redeem value from a gift card, optionally including a tip.
      tags:
      - Gift
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GiftRedeemRequest'
            examples:
              RedeemGiftCardRequestExample:
                summary: Default redeemGiftCard request
                x-microcks-default: true
                value:
                  merchantId: 1000
                  storeCode: '1'
                  cardInfo:
                    printedCardNumber: '60490012345678'
                    magstripe: string
                    cardTemplateCode: '1'
                  amount: 25.0
                  checkNumber: string
                  cashier: string
                  terminalId: string
                  externalTransactionId: string
                  tip: 5.0
      responses:
        '200':
          description: Gift transaction reply.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GiftReply'
              examples:
                RedeemGiftCard200Example:
                  summary: Default redeemGiftCard 200 response
                  x-microcks-default: true
                  value:
                    result: success
                    pxTransactionId: GIFT-44556
                    printedCardNumber: '70123456789012'
                    currentBalance: 50.0
                    errorCode: string
                    errorMessage: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    GiftBalanceRequest:
      type: object
      required:
      - merchantId
      - storeCode
      - cardInfo
      properties:
        merchantId:
          type: integer
          example: 1000
        storeCode:
          type: string
          example: '1'
        cardInfo:
          $ref: '#/components/schemas/CardInfo'
    GiftRedeemRequest:
      allOf:
      - $ref: '#/components/schemas/GiftRequest'
      - type: object
        properties:
          tip:
            type: number
            example: 5.0
    CardInfo:
      type: object
      description: Identifies a card for transaction operations.
      properties:
        printedCardNumber:
          type: string
          example: '60490012345678'
        magstripe:
          type: string
        cardTemplateCode:
          type: string
          example: '1'
    GiftReply:
      type: object
      properties:
        result:
          type: string
          example: success
        pxTransactionId:
          type: string
          example: GIFT-44556
        printedCardNumber:
          type: string
          example: '70123456789012'
        currentBalance:
          type: number
          example: 50.0
        errorCode:
          type: string
        errorMessage:
          type: string
    GiftRequest:
      type: object
      required:
      - merchantId
      - storeCode
      - cardInfo
      - amount
      properties:
        merchantId:
          type: integer
          example: 1000
        storeCode:
          type: string
          example: '1'
        cardInfo:
          $ref: '#/components/schemas/CardInfo'
        amount:
          type: number
          example: 25.0
        checkNumber:
          type: string
        cashier:
          type: string
        terminalId:
          type: string
        externalTransactionId:
          type: string
  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.

Paytronix Gift API

Operations 4

Documentation

Specifications

Schemas & Data

Other Resources