Google Wallet (Android Pay) Service

Future Release - The Google Wallet (Android Pay) Service provides endpoints for managing Android Pay loyalty objects.

Endpoints

Generate Save to Android Pay JWT

POST googlewallet/generateSaveToAndroidPayJWT.json

Obtain JSON Web Token and other information that can be used to save a Paytronix loyalty account to Android Pay.

The following authentication methods are allowed for this endpoint:

JSON Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID to perform the operation in.
  • printedCardNumber (String) – (required) Printed card number for which to save to Android Pay.
  • url (String) – (required) Domain of web page on which the JWT will be used to render the Save to Android Pay button.
"result": "success"
JSON Parameters:
 
  • result (String) – (required) success
  • jwt (String) – (required) The generated JSON Web Token
  • theme (String) – (required) Theme of button to display. Possible values are: dark and light.
  • size (String) – (required) Size of button to display. Possible values are: standard and small.
"result": "failure"
JSON Parameters:
 
  • result (String) – (required) failure
  • errorCode (String) – (required) The error code of the failure.
  • errorMessage (String) – (required) The (human readable) error message of the failure.

Generate Save to Android Pay Loyalty Object

POST googlewallet/generateSaveToAndroidPayLoyaltyObject.json

Obtain information that can be used to create a Android Pay loyalty object linked to a Paytronix account.

The following authentication methods are allowed for this endpoint:

JSON Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID to perform the operation in.
  • printedCardNumber (String) – (required) Printed card number for which to save to Android Pay.
"result": "success"
JSON Parameters:
 
  • result (String) – (required) success
  • classId (String) – (refquired) classId field
  • objectId (String) – (refquired) id field
  • accountName (String) – (optional) accountName field
  • accountId (String) – (refquired) accountId field
  • barcodeType (String) – (refquired) barcode type
  • barcodeValue (String) – (refquired) barcode value
  • barcodeLabel (String) – (refquired) barcode label
  • infoModuleFontColor (String) – (optional) infoModuleData.hexFontColor
  • infoModuleBackgroundColor (String) – (optional) infoModuleData.hexBackgroundColor
  • infoModuleRows (List[List[String,String]]) – (optional) List of infoModuleData rows. Each row may contain up to 2 columns and each column contains a label and value
  • List[String,String](optional) List of (uri, description) objects
  • loyaltyPointsLabel (String) – (optional) loyaltyPoints.label
  • loyaltyPointsBalance (String) – (optional) loyaltyPoints.balance.string
  • welcomeMessage (String) – (optional) A message configured in Paytronix to be displayed when the first time a loyalty object is created and linked to guest’s google account
  • welcomeMessageLogoUrl (String) – (optional) URL for welcome message logo
  • linkedOfferIds (List[String]) – (optional) linkedOfferIds
  • version (Long) – (refquired) new version value for insert or update
"result": "failure"
JSON Parameters:
 
  • result (String) – (required) failure
  • errorCode (String) – (required) The error code of the failure.
  • errorMessage (String) – (required) The (human readable) error message of the failure.

Save Android Pay Object to a Paytronix Loyalty Account

POST googlewallet/saveAndroidPayObjectToLoyaltyAccount.json

Link an Google Android Pay loyalty object to an existing Paytronix loyalty account.

The following authentication methods are allowed for this endpoint:

JSON Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID to perform the operation in.
  • printedCardNumber (String) – (required) Printed card number for which to save to Android Pay.
  • code (String) – (required) Android Pay loyalty object ID.
"result": "success"
JSON Parameters:
 
  • result (String) – (required) success
  • value (String) – (required) ok
"result": "failure"
JSON Parameters:
 
  • result (String) – (required) failure
  • errorCode (String) – (required) The error code of the failure.
  • errorMessage (String) – (required) The (human readable) error message of the failure.

Error Codes

The caller of the endpoint can use the returned message to display to the end user or, if different wording is desired, can provide their own mapping of code to message.

Code Message
system_error could not load given card