Skip to main content

Set up Chase Google Pay through REST API

Zuora

Set up Chase Google Pay through REST API

Zuora supports setting up Google Pay and processing Google Pay payments and refunds with the Chase Paymentech Orbital Gateway integrations. You can use REST APIs to create Google Pay payment methods on Chase, and then it can be used to process payments and refunds through the UI and the REST APIs.

Limitations

  • Zuora’s implementation of Google Pay on Chase does not support 3D Secure, and therefore European processing is not supported.
  • Google Pay is not compatible with Zuora's Payment Pages 2.0 feature.
  • Creation of Google Pay payment methods is only supported through the REST API. It is not supported through the Zuora UI.
  • Gateway reconciliation for Google Pay is not supported yet.

Configure Google Pay for Chase Paymentech Orbital Gateway

Prerequisites

  • Ensure that you have enabled the Google Pay integration for your Chase merchant account to be able to generate Google Pay tokens and process Google Pay transactions. To do this, you must provide Chase with Zuora’s Orbital Submitter ID, which is 056839.
  • Ensure that a Chase Paymentech Orbital Gateway instance is in active use in your Zuora tenant.

Procedure

Take the following steps to set up the Google Pay payment method on the Chase Paymentech Orbital Gateway integration:

  1. Obtain a Google Pay token.
  2. Activate Google Pay on Chase in Zuora.
  3. Add a Google Pay on Chase in Zuora.

Obtain a Google Pay token

After Google Pay is enabled for your Chase merchant account on the Chase platform, obtain a Google Pay token from the Google Pay API PaymentData response. For more information about the fields that this token contains, see Google Pay API documentation.

Activate Google Pay on Chase in Zuora

After Zuora Global Support has enabled Google Pay for your tenant, take the following steps to enable Google Pay on Chase in Zuora:

  1. In your Zuora tenant, navigate to Settings > Payments > Payment Method.
  2. Click Edit and then select Google Pay.
  3. Click Save. The Google Pay payment method is then activated in your Zuora tenant.

Note that no update is required for your existing Chase Paymentech Orbital Gateway instance in Zuora to support Google Pay.

Add a Google Pay on Chase in Zuora

After you have enabled and activated Google Pay on Chase for your Zuora tenant, you can create a Google Pay payment method and associate it with a customer account. 

Google Pay payment methods on Chase can only be created through the REST APIs. You can use the Create a payment method API operation to create a new Google Pay payment method, and the following fields must be specified in the request:

  • accountKey: Specify the customer account ID. This field is required unless the Orphan Payment Method feature is enabled.
  • type: Specify GooglePay.
  • googlePaymentToken: Specify the stringified Google Pay token.

Stored credential profiles will be automatically created and activated during the creation of the payment methods. If the Verify new payment method setting is enabled on the gateway instance configuration page, the network transaction ID (NTI) will be added when creating the payment method. See Overview of support for stored credential transactions for more information.

The following code is a sample request for creating a new Google Pay on Chase payment method:

Method and endpoint POST  https://rest.apisandbox.zuora.com/apps/v1/payment-methods
Request body
{
  "accountKey": "2c92c0f97911f46a0179147510484b90",
  "type": "GooglePay",
  "googlePaymentToken": "{\"signature\":\"MEUCICeJTEEW+a9ak93yk8pYg4xGlPJbrBNjD8b6vahxD5TRAiEAyMiNhzosJDl2N46Dojzc53bwbT/O0t+VToLCqr01qs4\\u003d\",\"protocolVersion\":\"ECv1\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"aXpc95j3gEFJfaHF8PEpybNuV/k/IDKMa/FkbNnj2p/uaH8ll99hAUwWkH5EnHr2NwNgLuj3j9IhDomWI9gJ4n2fQlsQ9FsNuqsJjct/QuNvlzooLhu76HlzE3mScXcTUqPI1fgC8s/CVNz06aCUd7/oNMzyCw6VploO9abxp3zcpRvAO39bScaO3fri2Kl0WGozyiS0egXcUzMOpPxDw03SjmpgU/X5FjmxayOBUNxM9r/yOQyvY9mTUHOK855XVl3Xf9dpj6GDnDMp4bvCW8zpXWr76Snwtvv41dIaLxNWsBP0lS5PpJ5K1/rSRZg/dauIKQbWGmTTL24vz4Om7hVu25L7XrSM6F2PRUE4rqMblVDvXAlVsD+149r2fjXsB4DXmvGmwaDcuFeTDuI3ov7GDetgW3Fdl+n7RtBOK/luJYs76a9nPbVLhN/aKU5Hpd0ZrIO8ZUOoUYr6WuecD24tTzwic3k921eLJez8IJnG1k05kiqPpHEqMeLyP/WovjH/U7Vu3iDrH4yAxMEuh0MMi0tTgjXlVEezVnsU\\\",\\\"ephemeralPublicKey\\\":\\\"BGNnBpAd6WypQEYJmDH/DhUZ9mX2b/wJK6as8g6hZmDCDpHSWFC1BZ42UBrX/hrF/UarrT24CMcWLZp6fYl6PNw\\\\u003d\\\",\\\"tag\\\":\\\"j9fPmiEL/zj8R+0JRrTC1NgV9VVCYQ9zYaB7uZrEz9U\\\\u003d\\\"}\"}"
}

In addition to the Create a payment method operation, you can also use the following operations to create a Google Pay payment method on Chase together with other objects:

Once a Google Pay payment method on Chase is created, it cannot be edited. 

View and export payment method data

After a Google Pay payment method on Chase is successfully created, you can view this payment method from the customer account details page in the Zuora UI. 

You can use Data Source Export to export the Google Pay payment method data. The following four fields contain data of the Google Pay payment method. The definition data of Google Pay payment methods, excluding the encrypted fields such as the PAN field, can be exported through the Method Specific Data field of the Payment Method data source. For security reasons, the encrypted fields are removed from export results. 

  • Method Specific Data: The JSON string containing definition information of the Google Pay payment method.
  • Method Reference Id: The identification reference of the Google Pay payment method.
  • User Reference Id: The identification reference of the user or customer account.
  • Sub-Type: The identification reference indicating the subtype of the Google Pay payment method.

The following table provides the mapping relationship between Zuora data source fields and Google Pay fields.

Data source field Google Pay field Description
Method Reference Id MaskedPAN The masked DPAN or PAN number.
Sub-Type GoogleCardType The brand or type of the card. For example, Visa and Mastercard.

For details about Data Source Exports, see Create a Data Source Export.

Make payments with Google Pay

After a Google Pay payment method on Chase has been added to a customer account, it can be used to make payments and refunds through the Zuora UI and all Payments API operations except for CRUD operations.

Zuora’s payment numbers are used as references when processing payments. When a payment method is created, a random string is generated and temporarily used as the payment number. It will be updated later with a real Zuora payment number in payment processing.

As described in Add a Google Pay on Chase in Zuora, when creating a Google Pay payment method on Chase through the REST API, a stored credential profile will be automatically created for the payment method. The profile contains important information such as NetworkTransactionId to ensure the success of the subsequence payments. If the stored credential profile is canceled, expired, or modified, subsequent payments might fail. Therefore, it is strongly not recommended to perform the following operations through either the Zuora UI or REST APIs:

  • Cancel Stored Credential Profile
  • Expire Stored Credential Profile
  • Add another Stored Credential Profile