<p>Elavon downloads and stores cookies on your device when you visit our website. We use these cookies to better understand and improve your browsing experience by identifying most visited pages, personalising content, and measuring site performance.</p>


Essential cookies enable core functionality such as page navigation and access to secure areas. The website cannot function properly without these cookies; they can only be disabled by changing your browser preferences.

These are cookies that support site functionality that is visible or advantageous to you or your experience of the site, they enable websites to remember choices and provide a more personalized experience.   Functional cookies help to provide services that you request, such as language preference or layout.

Performance cookies help us to improve our website by collecting and reporting information on its usage (for example, which of our pages are most frequently visited).

These cookies and similar technologies gather information about your browsing habits. They remember that you've visited a website and share this information with other organisations, such as advertisers and platforms on which we advertise. They do this in order to provide you with ads that are more relevant to you and your interests. Although these cookies and similar technologies can track your visits to other websites, they don't usually know who you are. Without these cookies, online advertisements you encounter will be less relevant to you and your interests.

Cookie Settings

<p>U.S. Bank Europe DAC. Registered in Ireland – Number 418442..  Registered Office: Block F1, Cherrywood Business Park, Dublin 18, D18 W2X7, Ireland.</p>
<p>U.S. Bank Europe DAC, trading as Elavon Merchant Services, is regulated by the Central Bank of Ireland.</p>
<p><br>
U.S. Bank Europe DAC. Registered in Ireland with Companies Registration Office. The liability of the member is limited. United Kingdom branch registered in England and Wales under the number BR022122.</p>
<p>U.S. Bank Europe DAC, trading as Elavon Merchant Services, is a credit institution authorised and regulated by the Central Bank of Ireland.  Authorised by the Prudential Regulation Authority.  Subject to regulation by the Financial Conduct Authority and limited regulation by the Prudential Regulation Authority.  Details about the extent of our regulation by the Prudential Regulation Authority are available from us on request.</p>


Most popular solutions

Additional solutions

Fusebox integration & options

Optional platform features

Documentation

North America

Europe

Regions

Merchant can use Converge to integrate with Google Pay<sup>™</sup> to process payments. Google Pay is available through the following Converge integration options:

- Converge Hosted Payments Page (HPP)
- Buy Button (Require merchant ID from Google)
- Checkout.js (Require merchant ID from Google)
- XML API

Google Pay needs to be enabled on Payment Extensions settings of Converge. Refer to [Set Up Google Pay for Your Payment Page](https://support.convergepay.com/s/article/Howtosetupgooglepay) for more details. This applies for all the integration methods.

:::::notice{note}

- For more details on demo environment test card / wallet setup, refer to [Google Pay test card suite](https://developers.google.com/pay/api/android/guides/resources/test-card-suite).
- Google Pay does not support Internet Explorer (IE) browser
- If 3DS is supported for your terminal, Converge will automatically enable 3DS for PAN_ONLY method.
:::::


## Google Pay Website Requirements

To integrate Google Pay, make sure your website meet the following requirements:

- Serve an HTTPS webpage with a TLS domain-validated certificate.
- Add a payment method to your Google Account.
- Adhere to our [Google Pay API Acceptable Use Policy](https://payments.developers.google.com/terms/aup)

## Hosted Payments Pages

Google Pay needs to be enabled on the HPP setup. Refer to [Set Up Google Pay for Your Payment Page](https://support.convergepay.com/s/article/Howtosetupgooglepay) for more details on how to enable Google Pay on the HPP setup. 

## Buy Button

Google Pay needs to be enabled to display on the Buy Button setup. Refer to [Set Up Google Pay for Your Payment Page](https://support.convergepay.com/s/article/Howtosetupgooglepay) for more details on how to enable Google Pay on the Buy Button. 

## Checkout.js

Before your website becomes active, perform the following:

- Apply access request for production environment by registering your website with Google. Once your website is approved, you will receive a Google merchant ID. You must include your Google merchant ID with each Google Pay request.  Read more about the [integration checklist](https://developers.google.com/pay/api/web/guides/test-and-deploy/integration-checklist).
- Complete all the steps mentioned in the [Deploy Production Environment of Google Pay API](https://developers.google.com/pay/api/web/guides/test-and-deploy/deploy-production-environment).

### Checkout.js Sample Code

:::::notice{note}

- During the session token request, make sure to include the value for the parameter `ssl_googlepay_merchant_id` with your merchant ID provided by Google.
:::::

```HTML
<!DOCTYPE HTML>
<html>

<head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Embedded Payment Demo</title>
  <script src="https://demo.convergepay.com/hosted-payments/Checkout.js"></script>
  <script>
    var callback = {
      onError: function (error) {
        showResult("error", error);
      },
      onDeclined: function (response) {
        showResult("declined", JSON.stringify(response));
      },
      onApproval: function (response) {
        showResult("approval", JSON.stringify(response));
      },
      onCancelled: function () {
        showResult("cancelled", "");
      }
    };

    function initiateEwallets() {
      var paymentData = {
        ssl_txn_auth_token: document.getElementById('token').value
      };
      ConvergeEmbeddedPayment.initGooglePay('googlepay-button', paymentData, callback);
      return false;
    }

    function showResult(status, msg, hash) {
      document.getElementById('txn_status').innerHTML = "<b>" + status + "</b>";
      document.getElementById('txn_response').innerHTML = msg + "</b>";
      document.getElementById('txn_hash').innerHTML = hash;
    }
  </script>

</head>

<body>
  <form>
    Transaction Token: <input type="text" id="token" name="token"> <br>
    <button onclick="return initiateEwallets();">Initiate Checkout.js</button> <br>
  </form>
  <br>
  <br /><br />
  <div id="googlepay-button"></div>
  <br>

  Transaction Status:<div id="txn_status"></div>
  <br>
  Transaction Response:<div id="txn_response"></div>
  <br>
  Transaction Hash Value:<div id="txn_hash"></div>
</body>

</html>
```

## XML API

Before your website becomes active, complete all the steps mentioned in the [Deploy Production Environment of Google Pay API](https://developers.google.com/pay/api/web/guides/test-and-deploy/deploy-production-environment) and obtain the Merchant ID from the business console.

Follow the procedure on [Google Pay documentation](https://developers.google.com/pay/api/web/guides/tutorial) to integrate your web and obtain the Google Pay Payload.

### XML API Integration Sample Code

```HTML
<html>
<head></head>
<body>
    <div id="container"></div>
    <br>
    Payload:
    <br>
    <div id="payload"></div>
    <script>
    /**
     * Define the version of the Google Pay API referenced when creating your
     * configuration
     *
     * @see {@link https://developers.google.com/pay/api/web/reference/request-objects#PaymentDataRequest|apiVersion in PaymentDataRequest}
     */
    const baseRequest = {
      apiVersion: 2,
      apiVersionMinor: 0
    };   
    /**
     * Card networks supported by your site and your gateway
     *
     * @see {@link https://developers.google.com/pay/api/web/reference/request-objects#CardParameters|CardParameters}
     * @todo confirm card networks supported by your site and gateway
     */
    const allowedCardNetworks = ["AMEX", "DISCOVER", "INTERAC", "JCB", "MASTERCARD", "VISA"];  
    /**
     * Card authentication methods supported by your site and your gateway
     *
     * @see {@link https://developers.google.com/pay/api/web/reference/request-objects#CardParameters|CardParameters}
     * @todo confirm your processor supports Android device tokens for your
     * supported card networks
     */
    const allowedCardAuthMethods = ["PAN_ONLY", "CRYPTOGRAM_3DS"];   
    /**
     * Identify your gateway and your site's gateway merchant identifier
     *
     * The Google Pay API response will return an encrypted payment method capable
     * of being charged by a supported gateway after payer authorization
     *
     * @todo check with your gateway on the parameters to pass
     * @see {@link https://developers.google.com/pay/api/web/reference/request-objects#gateway|PaymentMethodTokenizationSpecification}
     */
    const tokenizationSpecification = {
      type: 'PAYMENT_GATEWAY',
      parameters: {
        'gateway': 'convergepay',     // This MUST be set to convergepay
        'gatewayMerchantId': 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxx'   // The Terminal ID you obtained from Elavon Support must be used here
      }
    };
       /**
     * Describe your site's support for the CARD payment method and its required
     * fields
     *
     * @see {@link https://developers.google.com/pay/api/web/reference/request-objects#CardParameters|CardParameters}
     */
    const baseCardPaymentMethod = {
      type: 'CARD',
      parameters: {
        allowedAuthMethods: allowedCardAuthMethods,
        allowedCardNetworks: allowedCardNetworks,
        billingAddressRequired: true,
        billingAddressParameters: {format: 'FULL'}
      }
    };
     /**
     * Describe your site's support for the CARD payment method including optional
     * fields
     *
     * @see {@link https://developers.google.com/pay/api/web/reference/request-objects#CardParameters|CardParameters}
     */
    const cardPaymentMethod = Object.assign(
      {},
      baseCardPaymentMethod,
      {
        tokenizationSpecification: tokenizationSpecification
      }
    );
        /**
     * An initialized google.payments.api.PaymentsClient object or null if not yet set
     *
     * @see {@link getGooglePaymentsClient}
     */
    let paymentsClient = null;
   
    /**
     * Configure your site's support for payment methods supported by the Google Pay
     * API.
     *
     * Each member of allowedPaymentMethods should contain only the required fields,
     * allowing reuse of this base request when determining a viewer's ability
     * to pay and later requesting a supported payment method
     *
     * @returns {object} Google Pay API version, payment methods supported by the site
     */
    function getGoogleIsReadyToPayRequest() {
      return Object.assign(
          {},
          baseRequest,
          {
            allowedPaymentMethods: [baseCardPaymentMethod]
          }
      );
    }
   
    /**
     * Configure support for the Google Pay API
     *
     * @see {@link https://developers.google.com/pay/api/web/reference/request-objects#PaymentDataRequest|PaymentDataRequest}
     * @returns {object} PaymentDataRequest fields
     */
    function getGooglePaymentDataRequest() {
      const paymentDataRequest = Object.assign({}, baseRequest);
      paymentDataRequest.allowedPaymentMethods = [cardPaymentMethod];
      paymentDataRequest.transactionInfo = getGoogleTransactionInfo();
      paymentDataRequest.merchantInfo = {
        // @todo a merchant ID is available for a production environment after approval by Google
        // See {@link https://developers.google.com/pay/api/web/guides/test-and-deploy/integration-checklist|Integration checklist}
        // merchantId: '12345678901234567890',
        merchantName: 'Example Merchant', // The merchant Name that you registered with Google Business Console must go here
        merchantOrigin:'www.yourwebsite.com', // The merchant website that you registered with Google Business Console must go here
        merchantId:'XXXXXXXXXXXXXX' //The Merchant ID that is available on the Google Business Console must be used here
      };
      return paymentDataRequest;
    }
   
    /**
     * Return an active PaymentsClient or initialize
     *
     * @see {@link https://developers.google.com/pay/api/web/reference/client#PaymentsClient|PaymentsClient constructor}
     * @returns {google.payments.api.PaymentsClient} Google Pay API client
     */
    function getGooglePaymentsClient() {
      if ( paymentsClient === null ) {
        paymentsClient = new google.payments.api.PaymentsClient({environment: 'PRODUCTION'});
      }
      return paymentsClient;
    }
   
    /**
     * Initialize Google PaymentsClient after Google-hosted JavaScript has loaded
     *
     * Display a Google Pay payment button after confirmation of the viewer's
     * ability to pay.
     */
    function onGooglePayLoaded() {
      const paymentsClient = getGooglePaymentsClient();
      paymentsClient.isReadyToPay(getGoogleIsReadyToPayRequest())
          .then(function(response) {
            if (response.result) {
              addGooglePayButton();
              // @todo prefetch payment data to improve performance after confirming site functionality
              // prefetchGooglePaymentData();
            }
          })
          .catch(function(err) {
            // show error in developer console for debugging
            console.error(err);
          });
    }
   
    /**
     * Add a Google Pay purchase button alongside an existing checkout button
     *
     * @see {@link https://developers.google.com/pay/api/web/reference/request-objects#ButtonOptions|Button options}
     * @see {@link https://developers.google.com/pay/api/web/guides/brand-guidelines|Google Pay brand guidelines}
     */
    function addGooglePayButton() {
      const paymentsClient = getGooglePaymentsClient();
      const button =
          paymentsClient.createButton({
            onClick: onGooglePaymentButtonClicked,
            allowedPaymentMethods: [baseCardPaymentMethod]
          });
      document.getElementById('container').appendChild(button);
    }
   
    /**
     * Provide Google Pay API with a payment amount, currency, and amount status
     *
     * @see {@link https://developers.google.com/pay/api/web/reference/request-objects#TransactionInfo|TransactionInfo}
     * @returns {object} transaction info, suitable for use as transactionInfo property of PaymentDataRequest
     */
    function getGoogleTransactionInfo() {
      return {
        countryCode: 'US',
        currencyCode: 'USD',
        totalPriceStatus: 'FINAL',
        // set to cart total price same as the amount in XML API
        totalPrice: '6.00'
      };
    }
   
    /**
     * Prefetch payment data to improve performance
     *
     * @see {@link https://developers.google.com/pay/api/web/reference/client#prefetchPaymentData|prefetchPaymentData()}
     */
    function prefetchGooglePaymentData() {
      const paymentDataRequest = getGooglePaymentDataRequest();
      // transactionInfo must be set but does not affect cache
      paymentDataRequest.transactionInfo = {
        totalPriceStatus: 'NOT_CURRENTLY_KNOWN',
        currencyCode: 'USD'
      };
      const paymentsClient = getGooglePaymentsClient();
      paymentsClient.prefetchPaymentData(paymentDataRequest);
    }
   
    /**
     * Show Google Pay payment sheet when Google Pay payment button is clicked
     */
    function onGooglePaymentButtonClicked() {
      const paymentDataRequest = getGooglePaymentDataRequest();
      paymentDataRequest.transactionInfo = getGoogleTransactionInfo();
   
      const paymentsClient = getGooglePaymentsClient();
      paymentsClient.loadPaymentData(paymentDataRequest)
          .then(function(paymentData) {
            // handle the response
            processPayment(paymentData);
          })
          .catch(function(err) {
            // show error in developer console for debugging
            console.error(err);
          });
    }
    /**
     * Process payment data returned by the Google Pay API
     *
     * @param {object} paymentData response from Google Pay API after user approves payment
     * @see {@link https://developers.google.com/pay/api/web/reference/response-objects#PaymentData|PaymentData object reference}
     */
    function processPayment(paymentData) {
      // show returned data in developer console for debugging
        console.log(paymentData);
        showResult(paymentData);
      // @todo pass payment token to your gateway to process payment
      paymentToken = paymentData.paymentMethodData.tokenizationData.token;
    }
    function showResult (paymentData) {
                             document.getElementById('payload').innerHTML = JSON.stringify(paymentData);
    }
    </script>
    <script async
      src="https://pay.google.com/gp/p/js/pay.js"
      onload="onGooglePayLoaded()"></script>
</body>
</html>

```

### Google Pay Payload Request

The following information is supported for Google Pay transactions:

| Field Name | Description | Required | 
|---------|---------------------------|------|
| `ssl_account_id`<br>**Formerly known as ssl_merchant_id** | Elavon-assigned Converge Account ID (AID). <br>**Note:**  `ssl_merchant_id` will be eventually removed from the documentation. Both fields `ssl_account_id` and `ssl_merchant_id` will remain functional in the code. | Required | 
| `ssl_user_id` | Converge user ID<br>The user ID with Hosted Payment API user status that can send transaction requests through the terminal. | Required | 
| `ssl_pin` | Terminal ID<br>Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.<br>The `ssl_user_id` sending the transaction request must be associated with the terminal that will process the request. | Required | 
| `ssl_transaction_type` | Transaction Type<br>**Valid value:**  `CCSALE / CCAUTHONLY` | Required | 
| `ssl_amount` | Transaction Amount<br>The sale amount that includes the net and sales tax amounts.<br>**Format:** Number with 2 decimal places. | Required | 
| `ssl_google_pay` | The wallet identifier <br> **Note:** Required for XML API to indicate that the Cardholder has opted to pay using Google Pay. | Required |

Send Google Pay Payload via XML request as below.

```XML
xmldata=
<txn>
    <ssl_merchant_ID>my_merchant_id</ssl_merchant_ID>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>CCSALE</ssl_transaction_type>
    <ssl_transaction_source>X_HPP</ssl_transaction_source>
    <ssl_amount>6</ssl_amount>
    <ssl_google_pay>{"apiVersionMinor":0,"apiVersion":2,"paymentMethodData":{"description":"Mastercard •••• 1234","tokenizationData":{"type":"PAYMENT_GATEWAY","token":"{\"signature\":\"MEQCIDjr+WRi6hfeu6Gm7DqgNGtFvaFuTwKYWHkCir75Wc9+AiBAhgI0JIl24UKtCbP5JNXg0yfyec7V0XrwJB8u5oOhvw\\u003d\\u003d\",\"intermediateSigningKey\":{\"signedKey\":\"{\\\"keyValue\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEim7XiHFP7qYM6rzUxgN7vftdcJS796dOSTbjszxGv9FLPciMrI+JiW7os0Z/5Gc0UCCU8EsmVh8xHVD5FzozIg\\\\u003d\\\\u003d\\\",\\\"keyExpiration\\\":\\\"1645120118000\\\"}\",\"signatures\":[\"MEYCIQC97zOpzAfgqg/tWudyFxX+9YXCR5/+mKmxQuGTqOaHXwIhAMstaaH+eSgfudyaaGkFTgQZiTV167eSSVEJprUIFOcx\"]},\"protocolVersion\":\"ECv2\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"NQCA9L14WClLFq2Xbs//V6xz+UHQdsjnbMYQTbxQZVppZP1ukT3HACR5RQQx425W4eK3TpjIElv5C4dk/EpNv7Rou3nRTHDQ4iIKHEdhUlpr52OF5D3XdZ/V1cnDb6nY9kAstEonzbPYb7qBcW7EOP9Ofc/gkzi5td+Ww2JIlM54f93uZwlPyB/b7OQs/bd0qCGa6otIQwkGbD8LEBOiX4EoHGxyG6cR378/jW2lGZw+JZjwcfmVcRCfHxLeDolOvhsViTwbp7Th/nmmlc1nmVhatvrq1jDihDhgy8cXwwx7srClFBVx2/hvTMEUBEMKWYRvIbmgzM5gMGkKBOsNCq3ePd2corz7sQd2izEz8EEAOqeCJuqrEH9tPaeyp/WXy1AbH3fU80ac9BJOgjrS0ZrJvoqUUHcZWIOFN4/2EZNLlKV6sHoOnXq+4m4g7+sEfDY1SP9a0NxX/IPcdQJo5LqMr6yNqbNuUVrf0YTe2YPh6pir5e3UQEs1QV7qAbTeMRS3VYIfxlJbs3Mx2cRFYGcZNeGkP/RVFd77fN+UyRbHSMaV7lXs/FgSspPD9tvOUXj5VG66H9o3\\\",\\\"ephemeralPublicKey\\\":\\\"BLQRt9gDcei/S+rbGAldS41ZTzZzI77zL6fd2eS44D3yqDWMXRQm10QZK+9YCsqIdxuvZkEtoHUkmAcgJ9k7qFc\\\\u003d\\\",\\\"tag\\\":\\\"qDdXMG2cmcwoHU7f9Ysxl4GJR9kq8e6jTxr/eI2FVLk\\\\u003d\\\"}\"}"},"type":"CARD","info":{"cardNetwork":"MASTERCARD","cardDetails":"3954","billingAddress":{"address3":"","sortingCode":"","address2":"","countryCode":"","address1":"","postalCode":"","name":"","locality":"","administrativeArea":"ON"}}}}</ssl_google_pay>
</txn>
```


Google Pay

Alliance Offers

Data as a Service

Invitation to Apply

Accounts

Alicia Regan AZ Testing

alicia testing

Bank Holidays

Credit Card Activation

Credit Card Application Status

Credit Card Qualified Offers

Credit Card Transactions

Rewards Accelerator

Rewards Automatic Redemption

Rewards Redemption Accounts

Account Transfers

Checkout JS

CheckoutJs

commerce-sdk

Converge

Converge 2

disputes-management

eboarding

eBoarding EU

Elavon Cloud Payments Interface

Elavon Payment Gateway

Fraud Services

fusebox

Hosted Payment Page

Leads

Leads-not-in-use

Leads Referral

Lightbox payment modal

New Product

Opayo

Opayo Pi

Opayo Retail Cloud

Opayo Server

Simplify

XML API

Automation testing - Tharun

Card as a Service API

Core Banking API

Money Movement API

Reference API

Account Validation

ACH Originations prad

Avvance Connect

Avvance Express

Avvance Flex

Card as a Service

Card Controls

Check Payables

Corporate Account Information

Corporate Credit Cards

Custody

Data Toolbox

Disbursements via Zelle

Flexible Capital Platform

Foreign Exchange

Incoming Webhooks

PaySmart

Payee Choice

Positive Pay

Receivables

RTP® - Real-Time Payments

U.S. Bank Flexible Capital Platform

Virtual Account Reporting

Virtual Card Payments

Wire Drawdowns

Wire Transfers

Converge Overview

Getting Started

Transaction Types

Credit Card Transactions Overview

Sale - ccsale

Auth only - ccauthonly

Auth Only Increment - ccauthonly

Verification - ccverify

Balance inquiry - ccbalinquiry

Return - ccreturn

Void - ccvoid

Completion - cccomplete

Delete - ccdelete

Update tip - ccupdatetip

Signature - ccsignature

Add recurring - ccaddrecurring

Update recurring - ccupdaterecurring

Delete recurring - ccdeleterecurring

Submit recurring payment - ccrecurringsale

Add installment - ccaddinstall

Update installment - ccupdateinstall

Delete installment - ccdeleteinstall

Submit installment payment - ccinstallsale

Credit card force - ccforce

Credit Card Credit - cccredit

Merchant Hosted Card On File

Debit Card Transactions

Debit Card Transactions Overview

Purchase - dbpurchase

Return - dbreturn

Auth Only - dbauthonly

Auth only Increment - dbauthonly

Complete - dbcomplete

Reverse - dbreverse

Debit - dbvoid

Delete - dbdelete

Inquiry - dbbainquiry

PINless bill pay - pldbillpay

Pinless debit purchase - pldpurchase

BIN Lookup - binlookup

Straight Send

Cash Tender Transactions

Cash Tender Transactions Overview

Sale - cashsale

Credit - cashcredit

EMV Credit/Debit Card Transactions

EMV card transactions overview

Sale - emvchipsale

Auth Only - emvchipauthonly

Swipe sale - emvswipesale

Swipe auth only - emvswipeauthonly

Card update - emvchipupdatetxn

Reversal - emvreverse

Key exchange - emvkeyexchange

Legacy key exchange - caddbkeyexchange

Interac Refunds

Return - emvchipreturn

EMV DCC check - emvdcccheck

EBT Transactions

EBT transactions overview

Food stamp benefits

Purchase - fspurchase

Return - fsreturn

Inquiry - fsbainquiry

Force purchase - fsforcepurchase

Force return - fsforcereturn

Cash benefits

Purchase - cbpurchase

Inquiry - cbbainquiry

Gift Card Transactions

Gift Card Transactions Overview

Activation - egcactivation

Sale or Redemption - egcsale

Refund - egccardrefund

Replenishment or Reload - egcreload

Balance inquiry - egcbalinquiry

Credit - egccredit

Generate token - egcgettoken

Card Manager Transactions

Card Manager Transactions Overview

Token query - ccquerytoken

Token update - ccupdatetoken

Generate token - ccgettoken

Token delete - ccdeletetoken

Merchant Managed Card Tokens

End of Day Transactions

End of Day Transactions Overview

Transaction email - txnemail

Transaction query - txnquery

Total or Summary - total

Settle - settle

Settlement query - stlquery

Recurring Query - recurringquery

Batch Import Transactions

Batch Import Transactions Overview

Batch Import Transaction Query - bitxnquery

Batch import - ccimport

Batch Import File Format

Information batch import - cctokenimport