Google Wallet (Android Pay) Service
===================================

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

.. contents:: Topics

Endpoints
---------

Generate Save to Android Pay JWT
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. http: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:

   * :ref:`b2b_auth`
   * :ref:`oauth_auth`

   :jsonparam Integer merchantId: *(required)* Paytronix-assigned merchant ID to perform the operation in.
   :jsonparam String printedCardNumber: *(required)* Printed card number for which to save to Android Pay.
   :jsonparam String url: *(required)* Domain of web page on which the JWT will be used to render the Save to Android Pay button.

.. http:response:: success

   :jsonparam String result: *(required)*  ``success``
   :jsonparam String jwt: *(required)*  The generated JSON Web Token
   :jsonparam String theme: *(required)* Theme of button to display. Possible values are: dark and light.
   :jsonparam String size: *(required)* Size of button to display. Possible values are: standard and small.

.. http:response:: failure

   :jsonparam String result: *(required)*  ``failure``
   :jsonparam String errorCode: *(required)*  The error code of the failure.
   :jsonparam String errorMessage: *(required)*  The (human readable) error message of the failure.


Generate Save to Android Pay Loyalty Object
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. http: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:

   * :ref:`b2b_auth`
   * :ref:`oauth_auth`

   :jsonparam Integer merchantId: *(required)* Paytronix-assigned merchant ID to perform the operation in.
   :jsonparam String printedCardNumber: *(required)* Printed card number for which to save to Android Pay.

.. http:response:: success

   :jsonparam String result: *(required)*  ``success``
   :jsonparam String classId: *(refquired)* classId field
   :jsonparam String objectId: *(refquired)* id field
   :jsonparam String accountName: *(optional)* accountName field
   :jsonparam String accountId: *(refquired)* accountId field
   :jsonparam String barcodeType: *(refquired)* barcode type
   :jsonparam String barcodeValue: *(refquired)* barcode value
   :jsonparam String barcodeLabel: *(refquired)* barcode label, deprecated as of version 18.25
   :jsonparam List[List[String,String]] infoModuleRows: *(optional)* List of infoModuleData rows. Each row may contain up to 2 columns and each column contains a label and value
   :jsonparam List[String,String]: *(optional)* List of (uri, description) objects
   :jsonparam String loyaltyPointsLabel: *(optional)* loyaltyPoints.label
   :jsonparam String loyaltyPointsBalance: *(optional)* loyaltyPoints.balance.string
   :jsonparam String welcomeMessage: *(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
   :jsonparam List[String] linkedOfferIds: *(optional)* linkedOfferIds
   :jsonparam Long version: *(refquired)* new version value for insert or update

.. http:response:: failure

   :jsonparam String result: *(required)*  ``failure``
   :jsonparam String errorCode: *(required)*  The error code of the failure.
   :jsonparam String errorMessage: *(required)*  The (human readable) error message of the failure.


Save Android Pay Object to a Paytronix Loyalty Account
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. http: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:

   * :ref:`b2b_auth`
   * :ref:`oauth_auth`

   :jsonparam Integer merchantId: *(required)* Paytronix-assigned merchant ID to perform the operation in.
   :jsonparam String printedCardNumber: *(required)* Printed card number for which to save to Android Pay.
   :jsonparam String code: *(required)* Android Pay loyalty object ID.

.. http:response:: success

   :jsonparam String result: *(required)* ``success``
   :jsonparam String value: *(required)* ``ok``

.. http:response:: failure

   :jsonparam String result: *(required)*  ``failure``
   :jsonparam String errorCode: *(required)*  The error code of the failure.
   :jsonparam String errorMessage: *(required)*  The (human readable) error message of the failure.


Google Pay SmartTap Bounceback
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. http:post:: googlewallet/smartTapBounceback.json

   Send a Google SmartTap Bounceback request after Google Pay. For Signin, please supply printedCardNumber. For Enroll, please do NOT include printedCardNumber.

   The following authentication methods are allowed for this endpoint:

   * :ref:`b2b_auth`
   * :ref:`oauth_auth`

   :jsonparam Integer merchantId: *(required)* Paytronix-assigned merchant ID to perform the operation in.
   :jsonparam Long googleMerchantId: *(required)* Google-assigned merchant ID to perform the operation in.
   :jsonparam String stuid: *(required)* SmartTap unique identifier, a Google generated base64 encoded tap ID fetched from NFC terminal
   :jsonparam String printedCardNumber: *(optional)* Printed card number for which to perform SmartTap Signin.

.. http:response:: success

   :jsonparam String result: *(required)* ``success``
   :jsonparam String value: *(required)* ``ok``

.. http:response:: failure

   :jsonparam String result: *(required)*  ``failure``
   :jsonparam String errorCode: *(required)*  The error code of the failure.
   :jsonparam String errorMessage: *(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                 |
+--------------------------------+-------------------------------------------+