Welcome to the Paytronix Integration Documentation¶
This documentation describes how to integrate to Paytronix.
- Welcome
- Paytronix API Primer
- Guest Website
- Mobile Application
- Registration
- Mobile Application Login
- Account Balance
- User Information
- Editing a User’s Information
- Check In
- Nearby Stores
- iOS Push Messaging Services
- Android Push Messaging Services
- Apple Passbook
- Sign in with Apple
- Single Sign On
- Paytronix Server API Reference
- JSON and XML Encoding Details
- API Authentication
- API Change Log
- Apple Passbook Service
- Balance Transfer Service
- Campaign Feedback Service
- Challenge Service
- Endpoints
- Get Active Challenges for Guest
- Get Active Challenges for Group
- Get Eligible Challenges for Guest
- Get Eligible Challenges for Group
- Get Historical Challenges for Guest
- Get Historical Challenges for Group
- Opt-in to a Challenge for a Guest
- Opt-out of a Challenge for a Guest
- Get Detail of a Challenge Occurrence
- Get Charitable Organizations For Challenge
- Reply Objects
- Endpoints
- Check Service
- General Flow - POS
- General Flow - Online Ordering
- Request Objects
- Endpoints
- Check Compute Point Accrual
- Check Compute Applicable Rewards
- Check Simulate Accrual And Redemption
- Check Simulate Coupon
- Check Post And Accrue Points With Redeem
- Get Check
- Check Post and Accrue Points
- Check Multi Post and Accrue Points
- Check Redeem Only
- Check Upload Batches
- Check Post
- Post Price Match Discounts
- Get Price Match Discounts By Store Code
- Get All Price Match Discounts
- Reply Objects
- Error Codes
- Endpoints
- Using Coupons
- Checkin Service
- Coupon Service
- CSR Service
- Enrollment Service
- User Fields and Account Fields
- Field Validation Errors
- Enforcing Field Uniqueness
- Endpoints
- Create an Account and Set Fields
- Create and Register an Account
- Create and Register an Account with CardNumber
- Create and Register an account for an eClub Program
- Activate a Card and Set Fields
- Activate and Register an Account
- Add a Secondary Address For User
- Delete a Secondary Address For User
- Delete User
- Delete User By Printed Card Number
- Edit an Address For User
- Edit User Fields
- Edit User or Account Fields
- Edit User or Account Fields for an eClub Account
- Register an Active Account
- Change External Accounts Linked to an Account
- Get User and Account Field Settings for an eClub Program
- Get User and Account Field Settings for a Program
- Get Configured Perks by Perk Type
- Send Email Verification Challenge
- Edit Related Guest
- Add Related Guest
- Remove Related Guest
- Validate Related Guest
- Complete Email Verification
- Begin an Automatic Account Combine Workflow
- Get Candidate Accounts for Automatic Combine
- Complete an Automatic Combine Workflow
- Enroll with Mobile Phone via SMS
- Send SMS Enroll text message to with Mobile Phone for an active account
- Common Enrollment Service Response
- Reply Objects
- Error Codes
- External Configuration Service
- Feature Service
- Geolocation Service
- Gift Transfer Service
- Google Wallet (Android Pay) Service
- Guest Authentication Service
- Guest Service
- Endpoints
- Get Printed Card Number For External Account
- Get Account Information (Balance Inquiry) By Printed Card Number
- Get Account Information (Balance Inquiry) By Account Id
- Use Your Email As A Username
- Get Account Information for eClub Account
- Get User Information by Username
- Get User Information by Printed Card Number
- Get User Information by AccountId
- Get User Information for an eClub Account
- Get User And Account Information for By Printed Card Number
- Get Transaction History for Account By Printed Card Number
- Get Transaction History for Account by Account ID
- Get Transaction Annotation for Account and Transaction
- Attach Another Card to a User
- Combine Attached Card Balances
- Attach and Combine Cards
- Check If Cards Can Be Combined
- Enable / Disable a Card
- Get List of Referrals For User By Username
- Get List of Referrals For User By Printed Card Number
- Get List of Referrals For User By Account ID
- Add Referrals By Username
- Add Referrals By Printed Card Number
- Add Referrals By Account ID
- Create Referral Code By Username
- Create Referral Code By Printed Card Number
- Create Referral Code By Account ID
- Validate a Referral Code
- Get Pending Event Rewards By Printed Card Number
- Get Pending Event Rewards By Account ID
- Apply Visit Code
- Validate Visit Code
- Update Message Frequency
- Update User Language Preference
- Constant Values
- Reply Objects
- Error Codes
- Endpoints
- Guest Management Service
- Message Service
- OAuth Service
- One To One Service
- Payment Service
- Endpoints
- Recharge a Stored Value Card with a Credit Card
- Enable Automatic Recharge for a Stored Value Card
- Disable Auto Recharge for a Stored Value Card
- Delete Saved Credit Card Attached to Stored Value Card
- Get Payment Configuration
- Get Saved Credit Card Information
- Check Card Auto Recharge Status
- Get Recharge History
- Enable Auto Recharge Threshold Monitoring
- Disable Auto Recharge Threshold Monitoring
- Get Pending Monitored Auto Recharge Events
- Add Payment Method
- Edit Payment Method Usages
- Delete Payment Method
- Get Saved Payment Method
- Get Saved Payment Methods
- Create Checkout Session
- Get Payment Intent
- Capture Payment Intent
- Cancel Payment Intent
- Validate Merchant For Apple Pay
- Register Merchant Domain for Apple Pay
- Unregister Merchant Domain for Apple Pay
- Get Apple Pay Merchant Details
- Reply Objects
- Error Codes
- Endpoints
- Push Messaging Services
- Region Event Service
- REST Message Service
- Sale Service
- Flow For Non Logged In User
- Endpoints
- Get Sale Configuration for Program
- Get Sale Configuration for Account
- Get Loyalty Card Sale Config
- Execute Sale Without an Account
- Execute Sale With an Account
- Execute Loyalty Card Sale
- Calculate Total Price of a Sale Without an Account
- Calculate Total Price of a Sale With an Account
- Calculate Reward Yourself Points Value For Items With an Account
- Constant Values
- Reply Objects
- Error Codes
- Social Group Service
- Endpoints
- Get Social Groups Containing Friends of a Member by External Account
- Get Social Groups Containing Friends of a Member by Email Address
- Request to Join a Social Group by Member External Account
- Request to Join a Social Group by Member Email Address
- Accept a Join Group Request
- Reject a Join Group Request
- Cancel a Join Group Request
- Leave a Social Group
- Get Detail of a Member’s Social Groups
- Create a Social Group
- Invite Friend of a Member to a Social Group by External Account
- Invite Friend of a Member to a Social Group by Email Address
- Get Pending Invitations to Social Groups
- Get Details on Pending Invitation to a Social Group
- Get Pending Invitations to a Social Group
- Accept an Invitation to Join a Social Group
- Reject an Invitation to Join a Social Group
- Cancel an Invitation to Join a Social Group
- Remove Member from a Social Group
- Modify a Social Group Member’s Role in the Group
- Modify Details of a Social Group
- Create an Invitation Message
- Reply Objects
- Error Codes
- Endpoints
- Store Service
- Subscription Service
- Survey Service
- Endpoints
- Get Eligible Surveys by Username
- Get Eligible Surveys by Printed Card Number
- Opt In To Survey by Username
- Opt In To Survey by Printed Card Number
- Get Survey Details by Username
- Get Survey Details by Printed Card Number
- Submit Response to Survey by Username
- Submit Response to Survey by Printed Card Number
- Reply Objects
- Error Codes
- Endpoints
- Tour Service
- Transaction Service
- Request and Reply Formatting
- Endpoints
- Activate a Card
- Void a Card Activation
- Check Balance of a Card
- Identify a Customer Visit
- Add or Redeem Value From a Card Account
- Void an Addition or Redemption of Value From a Card Account
- Activate a Stored Value (Gift) Card
- Void a Stored Value (Gift) Card Activation
- Activate a Batch of Stored Value Cards
- Look Up Customer Accounts Using Phone Number or Other Fields
- Look Up Customer Account Checked in With a Mobile Application
- Query Transaction History of a Card
- Exchange a Physical or Virtual Card with Another
- Retrieve Program Configuration Objects
- Reverse a Previously Submitted Transaction
- Adjust a Wallet Directly for Administrative Purposes
- Status Ping
- Reply Objects
- Error Codes
- Upland Service
- NFC Loyalty
- Order & Delivery
- Errors
- Overview
- Apple Passbook Service
- Campaign Feedback Service
- Checkin Service
- Enrollment Service - Error Codes
- Enrollment Service - Field Validation Errors
- Guest Service
- Message Service
- OAuth Service
- Payment Service
- Region Event Service
- Sale Service
- Social Group Service
- Store Service
- Transaction Service
- Glossary
- Contact Us