Paytronix Server API Reference

• JSON and XML Encoding Details
  • Encoding of Types
  • Optional and Required Fields
• API Authentication
  • Integration Identifier and Secret
  • Anonymous authentication
  • Guest email authentication
  • B2B authentication
  • OAuth authentication
• API Change Log
  • 23.10
  • 23.6
  • 22.27
  • 22.25
  • 21.18
  • 21.8
  • 20.18
  • 19.18
  • 14.17
• Apple Passbook Service
  • Endpoints
    • Retrieve URL to Passbook Pass
  • Error Codes
• Balance Transfer Service
  • Endpoints
    • Transfer Balances
  • Error Codes
• Campaign Feedback Service
  • Endpoints
    • Load a Pending Reward (Encoded)
    • Load a Pending Reward (Encrypted)
    • Load a Pending Reward
  • Reply Objects
  • Error Codes
• 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
• 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
  • Using Coupons
• Checkin Service
  • Endpoints
    • Check in to a Store
  • Error Codes
• Coupon Service
  • Request Objects
    • Endpoints
      • Validate Coupon Usage
      • Report Coupon Usage
      • Void Coupon Usage
• CSR Service
  • Endpoints
    • Add Account Comment
    • Get Account Comments
  • JSON Object Reference
  • Error Codes
• Enrollment Service
  • User Fields and Account Fields
    • Set, Clear or Keep Style Fields
    • Phone Number Validation
  • 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
  • Endpoints
    • Get Mobile App Configuration
  • Error Codes
• Feature Service
  • Endpoints
    • Is Feature Enabled
• Geolocation Service
  • Endpoints
    • Coordinates by Address
• Gift Transfer Service
  • General Lifecycle
  • Endpoints
    • Transfer Out
    • Get Gifting Configuration
    • Accept Transfer In
    • Reject Transfer In
    • Fetch Pending Transfer
    • Fetch Pending Transfers To Account
    • Fetch Transfer History For Account
    • Request Objects
    • Reply Objects
• Google Wallet (Android Pay) Service
  • Endpoints
    • Generate Save to Android Pay JWT
    • Generate Save to Android Pay Loyalty Object
    • Save Android Pay Object to a Paytronix Loyalty Account
    • Google Pay SmartTap Bounceback
  • Error Codes
• Guest Authentication Service
  • Endpoints
    • authenticateGuestPassword
    • authenticateGuest
• 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
    • Referral status Values
    • Message Frequency Values
    • Language Preference Values
  • Reply Objects
  • Error Codes
• Guest Management Service
  • Endpoints
    • Generate And Send Guest Reset Password Code
    • Send Guest Reset Password Code
    • Reset Guest Password
• Message Service
  • Endpoints
    • Get Notifications for Guest
    • Get Notifications for Guest by Printed Card Number
    • Delete Notification
    • Delete Notification by Printed Card Number
    • Format Message
  • Constant Values
    • messageContextType Values
    • sourceType Values
    • eventType Values
    • targetType Values
  • Reply Objects
  • Error Codes
• OAuth Service
  • Key Terms
  • Endpoints
    • requestGuestToken
    • Guest Identification
      • Grant by Username and Password
      • Grant by Authorization Grant
      • Grant by Refresh Token
      • Grant by User Fields
        • Fields
  • requestAuthorizationGrant
  • Reply Objects
    • Success Access Refresh Token Response
    • Success Access Token Response
    • Authorization Grant Success
    • Authorization Grant Failure
  • Example use of access token to authenticate with other services
    • Authorization
    • EnrollmentService - editUser endpoint
    • GuestService - userInformation endpoint
    • Expired access tokens
  • Errors
    • Insufficient information to authenticate
    • Error Codes
• One To One Service
  • Endpoints
    • Get One To One User Progress
    • Get One To One User Information
  • Reply Objects
  • Error Codes
• 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
    • Credit Card Type Values
  • Error Codes
• Push Messaging Services
• Region Event Service
  • Endpoints
    • Get Region Definitions
    • Post Region Event
  • Reply Objects
  • Error Codes
• REST Message Service
  • Endpoints
    • Send Marketing Message By Printed Card Number
    • Send Marketing Message By Account Id
    • Send Transactional Message By Printed Card Number
    • Send Transactional Message By Account Id
    • Send Transactional Message By Email Address
  • Constant Values
    • deliveryMethod Values
    • Request Objects
    • Response Objects
  • Error Codes
• 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
    • cardType Values
    • paymentMethodType Values
    • webSaleItemType Values
    • webSaleProgramType 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
• Store Service
  • Endpoints
    • Get Store Locations Near a Point
    • Get Store Locations Near a Postal Code
    • Get Store Locations in a State or Province
    • Get Store Locations by Group
    • Get Store Details
    • Get All Store Locations for a Merchant
    • Create a Store
    • Edit a Store
    • Update Store Metadata
    • Response Objects
  • Reply Objects
  • Error Codes
• Subscription Service
  • General Lifecycle
  • Endpoints
    • Subscribe
    • Update Payment Method
    • Get Account Subscription Info
    • Get Subscription Info
    • Unsubscribe
    • Change Plan
  • Reply Objects
    • Account Subscription Info
    • Subscription Info
    • Payment Info
  • Request Objects
    • Payment Method
  • Credit Card Type Values
  • Error Codes
• 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
    • Question Types
  • Error Codes
• Tour Service
  • Endpoints
    • Get Active Tours
    • Get Tour Status
  • Reply Objects
  • Error Codes
• Transaction Service
  • Request and Reply Formatting
    • Request Objects
  • 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
      • Error Codes
  • Reply Objects
  • Error Codes
• Upland Service
  • Endpoints
    • Set User Fields
  • JSON Object Reference
  • Phone Number Validation
  • Error Codes