Skip to main content

Google Pay in QuickStream

Use QuickStream to accept Google Pay with QuickStream REST API. Google Pay allows customers to make purchases using a credit or debit card from their Google wallet. As a business, accepting Google Pay makes it easy for your customers to make purchases using Google Chrome and compatible Android devices.

You can add Google Pay as a payment method to your own payment page by creating a Payment Request button using the QuickStream REST API and then provide the singleUseTokenId to the Transactions API.

Getting started

To accept Google Pay as a payment method in QuickStream, you must integrate with the QuickStream REST API and configure your facility to accept Google Pay. Follow these steps:

  1. Sign in to QuickStream to Configure Google Pay and follow the instructions to accept the terms of service.
  2. Integrate with QuickStream REST API and refer to the guides below to implement Google Pay on the web or in-app.
Google Pay on the Web Google Pay in an App

Reporting

Use these methods to find Google Pay transactions made through QuickStream:

Refunds

Refund Google Pay transactions using QuickStream portal and the REST API.

Settlement and response codes

Supported browsers

Google Pay is supported on browsers and devices compatible with the Payment Request Button.

Google Pay on the Web with QuickStream REST API

Our QuickStream REST API allows you to create a Payment Request Button in your payment form with QuickStream-API.js.

Getting started

This page explains how to add Google Pay on the Web to your existing QuickStream REST API integration. If you haven't done this integration yet, refer to our API reference and the QuickStream-API.js library reference.

To get started with your Google Pay on the Web integration:

  1. Register with the Google Pay & Wallet Console and use the assigned merchant ID in googleMerchantId for your integration.
  2. Make sure that you have received your Publishable and Secret REST API keys for our QuickStream REST API.
  3. Sign in to QuickStream portal and activate Google Pay.
  4. Create a payment form that you want to add a Google Pay button to. Your payment form is a webpage that you will display to your customers when they choose their payment method.
  5. Set up your back-end implementation to take a payment using the REST API by providing a singleUseTokenId returned by the Payment Request Button module.
  6. Serve your application over HTTPS. This is required for test and production environments. You can use a service like ngrok to do this.

All merchants must adhere to the Google Pay APIs Acceptable Use Policy and accept the terms defined in the Google Pay API Terms of Service.

How to implement Google Pay in your payment form

  1. Add the QuickStream-API.js library to your payment form. For New Zealand based businesses: replace the src url https://api.quickstream.westpac.com.au/rest/v1/quickstream-api-1.0.min.js with https://quickapi.paymentsonline.co.nz/rest/v1/quickstream-api-1.0.min.js.

    <script type="text/javascript" src="https://api.quickstream.westpac.com.au/rest/v1/quickstream-api-1.0.min.js"></script>

  2. Add the Payment Request Button Container to your payment form that will drop-in the Google Pay button on Google Chrome and supported Android devices.

    <div data-quickstream-api="paymentRequestButtonContainer"></div>

  3. Initialise QuickStream-API.js with your Publishable API key for your QuickStream facility.

    QuickstreamAPI.init( {
  publishableApiKey: "PUBLISHABLE_API_KEY"
} );

  4. Create the PaymentRequestConfigObject for your customer.

    var config = {
 supplierBusinessCode: "SUPPLIER_CODE",
 googleMerchantId: "YOUR_GOOGLE_MERCHANT_ID",
 details: {
   total: {
     label: "Your company name",
     amount: {
       value: "50.00",
       currency: "AUD"
     }
   }
 }
};

  5. Create the Payment Request Button with the PaymentRequestConfigObject.

    Handle errors or retrieve the singleUseTokenId property from the PaymentRequestResponseObject.

    QuickstreamAPI.paymentRequestButton.createButton(config, function(errors, paymentResponse) {
    if (errors) {
        // Handle errors here
    } else {
        console.log("singleUseTokenId is " + paymentResponse.singleUseTokenId);

        // perform the payment on your server here before calling below.
        paymentResponse.complete("success");
    }
});

Take a payment

  1. After obtaining the singleUseTokenId pass this to your server.

  2. From your server, request POST /v1/transactions using your Secret REST API key, specifying:

    • singleUseTokenId: The paymentResponse.singleUseTokenId from the createButton function.
    POST / HTTP/1.1
Host: https://api.quickstream.westpac.com.au/rest/v1/transactions
Authorization: Basic A8d8sdk938damcheyt7=
Idempotency-Key: a8f4bd70-5435-11ea-8d77-2e728ce88125
Content-Type: application/json

{
    "transactionType" : "PAYMENT",
    "singleUseTokenId": "dec2075f-da92-49df-8a92-f7e494f89c22",
    "supplierBusinessCode": "SUPPLIER_CODE",
    "principalAmount": 5.00,
    "currency" : "AUD",
    "eci": "INTERNET",
    "ipAddress" : "192.168.1.1"
}

    See Process a transaction using a single-use-token for more.

    The response contains the result of the payment.

    For New Zealand based businesses: replace the Host url above (https://api.quickstream.westpac.com.au/rest/v1/transactions) with the New Zealand url https://quickapi.paymentsonline.co.nz/rest/v1/transactions. You may also need to change the currency depending on your specific business needs.

Present the result

Use the status that you received in your transaction response to present the result to your payer by updating the Payment Sheet using the PaymentRequestResponseObject complete function.

QuickstreamAPI.paymentRequestButton.createButton(config, function(errors, paymentResponse) {
    if (errors) {
        // Handle errors here
    } else {
        // provide success or fail to present the result to the client
        paymentResponse.complete("success");
    }
});

Google Pay in an App with QuickStream REST API

Our QuickStream REST API allows you implement the direct integration method for Google Pay for use within an app.

Getting started

This page explains how to use Google Pay in an app with your existing QuickStream REST API integration. If you haven't done this integration yet, refer to our API reference.

To get started with your Google Pay in an App integration:

  1. Sign in to QuickStream portal and activate Google Pay.
  2. Take note of your QuickStream Community Code. This is the gatewayMerchantId in your integration.
  3. Make sure that you have received your Publishable and Secret REST API keys for our QuickStream REST API.
  4. Set up your front-end implementation to create a Single Use Token using the Single-use-tokens API. You may wish to fetch your Publishable API Key from your server.
  5. Implement Google Pay as a payment method in your app.
  6. Set up your back-end implementation to take a payment using the Transactions API.

All merchants must adhere to the Google Pay APIs Acceptable Use Policy and accept the terms defined in the Google Pay API Terms of Service.

How to implement Google Pay in your app

First refer to the Google Pay for Payments - Overview and the Google Pay for Payments - Android Tutorial.

Part 1 - Payment configuration

In Step 1 of Google Pay for Payments - Android Tutorial:

  1. Under "Request a payment token for your payment provider" set these values:
    • gateway=qvalent
    • gatewayMerchantId = your QuickStream Community Code.
  2. (Optional) Under "Define supported card networks" you may use your Publishable API Key to retrieve your Accepted Cards using the Businesses API.
  3. Under "Define supported card networks" set allowedCardAuthMethods
    • PAN_ONLY
    • CRYPTOGRAM_3DS

(Optional) Part 2 - Display card surcharges

In Step 5 of Google Pay for Payments - Android Tutorial you may use your Publishable API Key to retrieve your Card Surcharges using the Businesses API to display this to your clients. Refer to Surcharging below for more.

Part 3 - Create a Single Use Token

In Step 6 of Google Pay for Payments - Android Tutorial retrieve a singleUseTokenId using your Publishable API Key and the Single-use-tokens API with the following values:

Part 4 - Take a payment

After obtaining the singleUseTokenId pass this to your server:

From your server, request POST /v1/transactions using your Secret REST API key, specifying the singleUseTokenId.

Part 5 - Present the result

In Step 6 of Google Pay for Payments - Android Tutorial process the result of the payment.

Surcharging

Surcharging works the same as normal card payments. The Google Pay credential (i.e. DPAN or FPAN) is sent to QuickStream and QuickStream calculates the surcharge based on your Card Scheme Surcharging configuration.

However, for Google Pay, QuickStream does not know the card before the user approves the payment sheet meaning it cannot calculate and show the total amount to the user before it is approved.

By default, the payment sheet for Google Pay will show <Supplier Business Name> (surcharge may be added) when surcharging is configured for a supplier business. Note that <Supplier Business Name> is truncated to 18 characters if it is longer due to the limitations on the display of the label on the payment sheet for Google Pay.

You can change this label during:

  • the initialisation of the payment sheet
  • the onShippingAddressChange event
  • the onShippingOptionChange event

See the details.total.label property.

You may be able to use multiple line items to display a surcharge amount. For example, if you have configured all card schemes to have the same surcharge amount, you can calculate and provide the surcharge value earlier in the flow than usual.

Multiple line items

You can provide the details.displayItems property which is an array of amount line items.

details: {
  displayItems: [
    {
      label: "Service 1",
      amount: { currency: "AUD", value: "6.00" }
    },
    {
      label: "Service 2",
      amount: { currency: "AUD", value: "4.00" }
    },
    {
      label: "Surcharge",
      amount: { currency: "AUD", value: "1.00" }
    }
  ],
  total: {
    label: "Total amount",
    amount: { currency: "AUD", value: "11.00" }
  }
}

Google Pay only displays the line items when shipping is requested. If shipping is not requested, then Google Pay will instead display the step in the Payment Sheet to select a card to pay with.

Testing Google Pay with QuickStream

The QuickStream test environment is linked to the Google Pay TEST environment. You can test the payment process using the Google Pay Test card suite.

  • You require a Google account to access the test suite and use a Google Wallet. You may be required to add a chargeable card to your Google Wallet for the test cards to show up. Transactions in the test environment will never charge a card.
  • You can use any value for googleMerchantId in the test environment. However, it is good practice to register a merchant ID using the Google Pay & Wallet Console in preparation for your Production integration.
  • Follow the Google Pay Web integration checklist

Refer to:

Go Live

Once you are ready to go live you must:

  1. Request production access for Google Pay. Ensure you receive a Google Pay merchant ID and that you have received approval for your integration submission to get production access.
  2. Sign in to QuickStream portal and activate Google Pay.
  3. Complete your integration with the QuickStream REST API in the production environment.

See also

Westpac Privacy Statement

Privacy Statement (for individuals whose personal information may be collected - in this clause referred to as "you"). All personal information we collect about you is collected, used and disclosed by us in accordance with our Privacy Statement which is available at Privacy Statement or by calling us through your relationship manager or Westpac representative. Our Privacy Statement also provides information about how you can access and correct your personal information and make a complaint. You do not have to provide us with any personal information but, if you don't, we may not be able to process an application or a request for a product or service.