Tutorial de PaymentRequest da API Google Pay

A API Google Pay pode ser usada com outras formas de pagamento aceitas em PaymentRequest (em inglês).

Etapa 1: criar um objeto PaymentDataRequest

Configure um objeto PaymentDataRequest especificando seu gateway de pagamento e as formas aceitas. Recomendamos que você consiga o endereço de entrega, o endereço de e-mail e o número de telefone por meio do argumento PaymentRequest options do navegador, e não da API Google Pay, para consistência entre as formas de pagamento. Use a API Google Pay para receber apenas as credenciais de pagamento e o endereço de cobrança opcional.

    const googlePaymentDataRequest = {
      environment: 'TEST',
      apiVersion: 2,
      apiVersionMinor: 0,
      merchantInfo: {
        // A merchant ID is available after approval by Google.
        // @see {@link https://developers.google.com/pay/api/web/guides/test-and-deploy/integration-checklist}
        // merchantId: '01234567890123456789',
        merchantName: 'Example Merchant'
      },
      allowedPaymentMethods: [{
        type: 'CARD',
        parameters: {
          allowedAuthMethods: ["PAN_ONLY", "CRYPTOGRAM_3DS"],
          allowedCardNetworks: ["AMEX", "DISCOVER", "INTERAC", "JCB", "MASTERCARD", "VISA"]
        },
        tokenizationSpecification: {
          type: 'PAYMENT_GATEWAY',
          // Check with your payment gateway on the parameters to pass.
          // @see {@link https://developers.google.com/pay/api/web/reference/request-objects#gateway}
          parameters: {
            'gateway': 'example',
            'gatewayMerchantId': 'exampleGatewayMerchantId'
          }
        }
      }]
    };
    

Etapa 2: declarar o suporte da API Google Pay

Adicione o identificador da forma de pagamento da API Google Pay e a respectiva configuração ao parâmetro methodData passado para PaymentRequest.

    const methodData = [
      {supportedMethods: 'https://google.com/pay', data: googlePaymentDataRequest},
      {supportedMethods: 'basic-card'}
    ];
    

Para resumir

No exemplo a seguir, mostramos uma implementação da API Google Pay com outras formas de pagamento aceitas em PaymentRequest:

    <div id="checkout">
      <button id="buyButton">Checkout</button>
    </div>

    <script>
    const allowedCardNetworks = ["AMEX", "DISCOVER", "INTERAC", "JCB", "MASTERCARD", "VISA"];
    const allowedCardAuthMethods = ["PAN_ONLY", "CRYPTOGRAM_3DS"];
    if (window.PaymentRequest) {
      const request = createPaymentRequest();

      request.canMakePayment()
          .then(function(result) {
            if (result) {
              // Display PaymentRequest dialog on interaction with the existing checkout button
              document.getElementById('buyButton')
                  .addEventListener('click', onBuyClicked);
            }
          })
          .catch(function(err) {
            showErrorForDebugging(
                'canMakePayment() error! ' + err.name + ' error: ' + err.message);
          });
    } else {
      showErrorForDebugging('PaymentRequest API not available.');
    }

    /**
     * Show a PaymentRequest dialog after a user clicks the checkout button
     */
    function onBuyClicked() {
      createPaymentRequest()
          .show()
          .then(function(response) {
            // Dismiss payment dialog.
            response.complete('success');
            handlePaymentResponse(response);
          })
          .catch(function(err) {
            showErrorForDebugging(
                'show() error! ' + err.name + ' error: ' + err.message);
          });
    }

    /**
     * Define your unique Google Pay API configuration
     *
     * @returns {object} data attribute suitable for PaymentMethodData
     */
    function getGooglePaymentsConfiguration() {
      return {
        environment: 'TEST',
        apiVersion: 2,
        apiVersionMinor: 0,
        merchantInfo: {
          // A merchant ID is available after approval by Google.
          // 'merchantId':'01234567890123456789',
          merchantName: 'Example Merchant'
        },
        allowedPaymentMethods: [{
          type: 'CARD',
          parameters: {
            allowedAuthMethods: allowedCardAuthMethods,
            allowedCardNetworks: allowedCardNetworks
          },
          tokenizationSpecification: {
            type: 'PAYMENT_GATEWAY',
            // Check with your payment gateway on the parameters to pass.
            // @see {@link https://developers.google.com/pay/api/web/reference/request-objects#gateway}
            parameters: {
              'gateway': 'example',
              'gatewayMerchantId': 'exampleGatewayMerchantId'
            }
          }
        }]
      };
    }

    /**
     * Create a PaymentRequest
     *
     * @returns {PaymentRequest}
     */
    function createPaymentRequest() {
      // Add support for the Google Pay API.
      const methodData = [{
        supportedMethods: 'https://google.com/pay',
        data: getGooglePaymentsConfiguration()
      }];
      // Add other supported payment methods.
      methodData.push({
        supportedMethods: 'basic-card',
        data: {
          supportedNetworks:
              Array.from(allowedCardNetworks, (network) => network.toLowerCase())
        }
      });

      const details = {
        total: {label: 'Test Purchase', amount: {currency: 'USD', value: '1.00'}}
      };

      const options = {
        requestPayerEmail: true,
        requestPayerName: true
      };

      return new PaymentRequest(methodData, details, options);
    }

    /**
     * Process a PaymentResponse
     *
     * @param {PaymentResponse} response returned when a user approves the payment request
     */
    function handlePaymentResponse(response) {
      const formattedResponse = document.createElement('pre');
      formattedResponse.appendChild(
          document.createTextNode(JSON.stringify(response.toJSON(), null, 2)));
      document.getElementById('checkout')
          .insertAdjacentElement('afterend', formattedResponse);
    }

    /**
     * Display an error message for debugging
     *
     * @param {string} text message to display
     */
    function showErrorForDebugging(text) {
      const errorDisplay = document.createElement('code');
      errorDisplay.style.color = 'red';
      errorDisplay.appendChild(document.createTextNode(text));
      const p = document.createElement('p');
      p.appendChild(errorDisplay);
      document.getElementById('checkout').insertAdjacentElement('afterend', p);
    }
    </script>
    

Lista de parâmetros da forma de pagamento

A configuração da API Google Pay transmitida em PaymentRequest é semelhante ao objeto PaymentDataRequest usado pela biblioteca de cliente JavaScript da API Google Pay, com algumas exceções:

  • Uma propriedade environment deve ser configurada no objeto que corresponde a um valor de string descrito em PaymentOptions
  • A propriedade transactionInfo deve ser omitida. No lugar dela, o preço total e a moeda devem ser especificados no argumento details passado para PaymentRequest

Propriedades adicionais do objeto especificadas para a forma de pagamento da API Google Pay em uma propriedade de dados da forma de pagamento PaymentRequest:

Propriedade Tipo Necessidade Descrição
environment string opcional
  • PRODUCTION: retorna formas de pagamento cobráveis quando um ID do comerciante do Google é especificado e configurado para o domínio.
  • TEST: retorna formas de pagamento fictícias adequadas para testes (padrão).