onCompleteListener) {
Log.i("Invocation", "onPaymentAuthorized invoked");
Bundle savedState = new Bundle();
JSONObject paymentAuthorizationResultJson = new JSONObject();
try {
assert request != null;
JSONObject paymentDataJson = new JSONObject(request.toJson());
JSONObject info = paymentDataJson.getJSONObject("paymentMethodData").getJSONObject("info");
// example of how to check for a card network
String cardNetwork = info.getString("cardNetwork");
if (cardNetwork.equals("VISA")) {
paymentAuthorizationResultJson.put("transactionState", "SUCCESS");
} else {
paymentAuthorizationResultJson.put("transactionState", "ERROR");
JSONObject error =
new JSONObject()
.put("reason", "PAYMENT_DATA_INVALID")
.put("message", "Only Visa is accepted!")
.put("intent", "PAYMENT_AUTHORIZATION");
paymentAuthorizationResultJson.put("error", error);
}
onCompleteListener.complete(
PaymentAuthorizationResult.fromJson(paymentAuthorizationResultJson.toString())
.withUpdatedSavedState(savedState));
} catch (JSONException e) {
Log.e("SampleMerchantPaymentDataCallbacksService", Objects.requireNonNull(e.getMessage()));
throw new RuntimeException(e);
}
}
}
```
### MerchantPaymentDataCallbacksService
### Kotlin
```kotlin
package com.google.android.gms.samples.pay.service
import com.google.android.gms.wallet.callback.BasePaymentDataCallbacks
import com.google.android.gms.samples.pay.activity.MerchantPaymentDataCallbacks
import com.google.android.gms.wallet.callback.BasePaymentDataCallbacksService
/**
* Service class which hosts the payment data callbacks initiated by Google Play services
* within a {@link PaymentsClient#loadPaymentData(PaymentDataRequest)}.
*
* The callbacks are implemented through MerchantPaymentDataCallbacks returned from {@link #createPaymentDataCallbacks()}.
*/
class MerchantPaymentDataCallbacksService : BasePaymentDataCallbacksService() {
override fun createPaymentDataCallbacks(): BasePaymentDataCallbacks {
return MerchantPaymentDataCallbacks()
}
}
```
### Java
```java
/*
* Copyright 2024 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.android.gms.samples.pay.service;
import androidx.annotation.NonNull;
import com.google.android.gms.samples.pay.activity.MerchantPaymentDataCallbacks;
import com.google.android.gms.wallet.callback.BasePaymentDataCallbacks;
import com.google.android.gms.wallet.callback.BasePaymentDataCallbacksService;
/**
* Service class which hosts the payment data callbacks initiated by Google Play services within a
* {@link
* com.google.android.gms.wallet.PaymentsClient#loadPaymentData(com.google.android.gms.wallet.PaymentDataRequest)}.
*
*
The callbacks are implemented through MerchantPaymentDataCallbacks returned from {@link
* #createPaymentDataCallbacks()}.
*/
public class MerchantPaymentDataCallbacksService extends BasePaymentDataCallbacksService {
@NonNull
@Override
protected BasePaymentDataCallbacks createPaymentDataCallbacks() {
return new MerchantPaymentDataCallbacks();
}
}
```
Finally, update your AndroidManifest.xml file to specify `com.google.android.gms.permission.BIND_PAYMENTS_CALLBACK_SERVICE` as its permission and include an intent filter with the action name `com.google.android.gms.wallet.callback.PAYMENT_DATA_CALLBACKS`.
### Kotlin
```kotlin
```
### Java
```java
```
## Put it all together
The following snippet shows a complete example for a properly configured project. For the
project-level setup steps, see
[Configure your project](https://developers.google.com/pay/api/android/guides/setup.md.txt#configure).
### Kotlin
### Activity
```kotlin
/*
* Copyright 2024 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.android.gms.samples.pay.activity
import android.os.Bundle
import android.util.Log
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.activity.viewModels
import androidx.compose.runtime.getValue
import androidx.lifecycle.compose.collectAsStateWithLifecycle
import com.google.android.gms.common.api.CommonStatusCodes
import com.google.android.gms.samples.pay.Constants
import com.google.android.gms.samples.pay.R
import com.google.android.gms.samples.pay.ui.ProductScreen
import com.google.android.gms.samples.pay.viewmodel.CheckoutViewModel
import com.google.android.gms.samples.pay.viewmodel.PaymentUiState
import com.google.android.gms.tasks.Task
import com.google.android.gms.wallet.PaymentData
import com.google.android.gms.wallet.contract.TaskResultContracts.GetPaymentDataResult
class CheckoutActivity : ComponentActivity() {
private val model: CheckoutViewModel by viewModels()
private val paymentDataLauncher = registerForActivityResult(GetPaymentDataResult()) { taskResult ->
when (taskResult.status.statusCode) {
CommonStatusCodes.SUCCESS -> {
taskResult.result?.let {
Log.i("Google Pay result:", it.toJson())
model.setPaymentData(it)
}
}
CommonStatusCodes.CANCELED -> {
// The user canceled the payment attempt
Log.i("Google Pay result:", "Payment canceled by user")
}
else -> {
// Handle internal and other unexpected errors
Log.w("Google Pay result:", "Payment failed. Status: ${taskResult.status}")
}
}
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContent {
val payState: PaymentUiState by model.paymentUiState.collectAsStateWithLifecycle()
ProductScreen(
title = "Men's Tech Shell Full-Zip",
description = "A versatile full-zip that you can wear all day long and even...",
price = "$${Constants.BASE_PRICE}",
image = R.drawable.ts_10_11019a,
payUiState = payState,
onGooglePayButtonClick = this::requestPayment,
)
}
}
private fun requestPayment() {
val task = model.getLoadPaymentDataTask(Constants.BASE_PRICE)
task.addOnCompleteListener(paymentDataLauncher::launch)
}
}
```
### Util
```kotlin
/*
* Copyright 2024 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.android.gms.samples.pay.util
import android.content.Context
import com.google.android.gms.samples.pay.Constants
import com.google.android.gms.wallet.PaymentsClient
import com.google.android.gms.wallet.Wallet
import java.math.BigDecimal
import java.util.Locale
import org.json.JSONArray
import org.json.JSONException
import org.json.JSONObject
/**
* Contains helper static methods for dealing with the Payments API.
*
* Many of the parameters used in the code are optional and are set here merely to call out their
* existence. Please consult the documentation to learn more and feel free to remove ones not
* relevant to your implementation.
*/
object PaymentsUtil {
/**
* Encapsulated shipping option parameters (set of options) definition.
*
* @return A [JSONObject] containing shipping options and the default selected option.
* @throws JSONException If the JSON object is malformed.
*/
@Throws(JSONException::class)
fun getShippingOptionParameters(): JSONObject {
val shippingOptionParameters = JSONObject()
val shippingOptions = JSONArray()
shippingOptions.put(
createShippingOption(
"shipping-001", "$0.00: Free shipping label", "Free Shipping example text"
)
)
shippingOptions.put(
createShippingOption(
"shipping-002", "$1.99: Standard shipping label", "Standard shipping example text."
)
)
shippingOptions.put(
createShippingOption(
"shipping-003", "$1000: Express shipping label", "Express shipping example text."
)
)
shippingOptions.put(
createShippingOption(
"shipping-004", "$2000: Same-day shipping label", "Same-day shipping example text."
)
)
shippingOptionParameters.put("shippingOptions", shippingOptions)
shippingOptionParameters.put("defaultSelectedOptionId", "shipping-001")
return shippingOptionParameters
}
/**
* Defines an encapsulated shipping option.
*
* @param id The unique identifier for the shipping option.
* @param label The label to display for the shipping option.
* @param description A brief description of the shipping option.
* @return A [JSONObject] representing the shipping option.
* @throws JSONException If the JSON object is malformed.
*/
@Throws(JSONException::class)
private fun createShippingOption(id: String, label: String, description: String): JSONObject {
return JSONObject().put("id", id).put("label", label).put("description", description)
}
/**
* Encapsulated definition for a display item.
*
* @param label The label to display for the item.
* @param type The type of the display item (e.g., LINE_ITEM, SUBTOTAL).
* @param price The price of the item.
* @return A [JSONObject] representing the display item.
* @throws JSONException If the JSON object is malformed.
*/
@Throws(JSONException::class)
fun createDisplayItem(label: String, type: String, price: String): JSONObject {
return JSONObject().put("label", label).put("type", type).put("price", price)
}
/**
* Create a Google Pay API base request object with properties used in all requests.
*
* @return Google Pay API base request object.
* @throws JSONException if the object is malformed.
*/
@Throws(JSONException::class)
private fun getBaseRequest(): JSONObject {
return JSONObject().put("apiVersion", 2).put("apiVersionMinor", 0)
}
/**
* Creates an instance of [PaymentsClient] for use in an [Context] using the
* environment and theme set in [Constants].
*
* @param context is the caller's context.
* @return An instance of [PaymentsClient].
*/
fun createPaymentsClient(context: Context): PaymentsClient {
val walletOptions = Wallet.WalletOptions.Builder()
.setEnvironment(Constants.PAYMENTS_ENVIRONMENT)
.build()
return Wallet.getPaymentsClient(context, walletOptions)
}
/**
* Gateway Integration: Identify your gateway and your app'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 and modify them in Constants.java.
*
* @return Payment data tokenization for the CARD payment method.
* @throws JSONException if the object is malformed.
* @see [PaymentMethodTokenizationSpecification](https://developers.google.com/pay/api/android/reference/object#PaymentMethodTokenizationSpecification)
*/
@Throws(JSONException::class)
private fun getGatewayTokenizationSpecification(): JSONObject {
return JSONObject()
.put("type", "PAYMENT_GATEWAY")
.put(
"parameters",
JSONObject()
.put("gateway", "example")
.put("gatewayMerchantId", "exampleGatewayMerchantId")
)
}
/**
* `DIRECT` Integration: Decrypt a response directly on your servers. This configuration has
* additional data security requirements from Google and additional PCI DSS compliance complexity.
*
* Please refer to the documentation for more information about `DIRECT` integration. The
* type of integration you use depends on your payment processor.
*
* @return Payment data tokenization for the CARD payment method.
* @throws JSONException if the object is malformed.
* @see [PaymentMethodTokenizationSpecification](https://developers.google.com/pay/api/android/reference/object#PaymentMethodTokenizationSpecification)
*/
@Throws(JSONException::class)
private fun getDirectTokenizationSpecification(): JSONObject {
return JSONObject()
.put("type", "DIRECT")
.put("parameters", JSONObject(Constants.DIRECT_TOKENIZATION_PARAMETERS))
}
/**
* Card networks supported by your app and your gateway.
*
* TODO: Confirm card networks supported by your app and gateway & update in Constants.java.
*
* @return Allowed card networks.
* @see [CardParameters](https://developers.google.com/pay/api/android/reference/object#CardParameters)
*/
private fun getAllowedCardNetworks(): JSONArray {
return JSONArray(Constants.SUPPORTED_NETWORKS)
}
/**
* Card authentication methods supported by your app and your gateway.
*
* TODO: Confirm your processor supports Android device tokens on your supported card networks
* and make updates in Constants.java.
*
* @return Allowed card authentication methods.
* @see [CardParameters](https://developers.google.com/pay/api/android/reference/object#CardParameters)
*/
private fun getAllowedCardAuthMethods(): JSONArray {
return JSONArray(Constants.SUPPORTED_METHODS)
}
/**
* Describe your app's support for the CARD payment method.
*
* The provided properties are applicable to both an IsReadyToPayRequest and a
* PaymentDataRequest.
*
* @return A CARD PaymentMethod object describing accepted cards.
* @throws JSONException if the object is malformed.
* @see [PaymentMethod](https://developers.google.com/pay/api/android/reference/object#PaymentMethod)
*/
@Throws(JSONException::class)
private fun getBaseCardPaymentMethod(): JSONObject {
return JSONObject()
.put("type", "CARD")
.put(
"parameters",
JSONObject()
.put("allowedAuthMethods", getAllowedCardAuthMethods())
.put("allowedCardNetworks", getAllowedCardNetworks())
.put("billingAddressRequired", true)
.put("billingAddressParameters", JSONObject().put("format", "FULL"))
)
}
/**
* Describe the expected returned payment data for the CARD payment method.
*
* @return A CARD PaymentMethod describing accepted cards and optional fields.
* @throws JSONException if the object is malformed.
* @see [PaymentMethod](https://developers.google.com/pay/api/android/reference/object#PaymentMethod)
*/
@Throws(JSONException::class)
private fun getCardPaymentMethod(): JSONObject {
return getBaseCardPaymentMethod()
.put("tokenizationSpecification", getGatewayTokenizationSpecification())
}
/**
* Return a collection of payment methods allowed to complete the operation with Google Pay.
*
* @return A JSONArray object with the list of payment methods.
* @throws JSONException if the JSON object is malformed.
*/
@Throws(JSONException::class)
fun getAllowedPaymentMethods(): JSONArray {
return JSONArray().put(getCardPaymentMethod())
}
/**
* An object describing accepted forms of payment by your app, used to determine a viewer's
* readiness to pay.
*
* @return API version and payment methods supported by the app.
* @throws JSONException if the object is malformed.
* @see [IsReadyToPayRequest](https://developers.google.com/pay/api/android/reference/object#IsReadyToPayRequest)
*/
@Throws(JSONException::class)
fun getIsReadyToPayRequest(): JSONObject {
return getBaseRequest()
.put("allowedPaymentMethods", JSONArray().put(getBaseCardPaymentMethod()))
}
/**
* Provide Google Pay API with a payment amount, currency, and amount status.
*
* @param price The price of the product.
* @return information about the requested payment.
* @throws JSONException if the object is malformed.
* @see [TransactionInfo](https://developers.google.com/pay/api/android/reference/object#TransactionInfo)
*/
@Throws(JSONException::class)
fun getTransactionInfo(price: String): JSONObject {
return JSONObject()
.put("totalPrice", price)
.put("totalPriceLabel", "Total")
.put("totalPriceStatus", "FINAL")
.put("countryCode", Constants.COUNTRY_CODE)
.put("currencyCode", Constants.CURRENCY_CODE)
.put("checkoutOption", "COMPLETE_IMMEDIATE_PURCHASE")
.put("displayItems", getDisplayItems(price))
}
/**
* Provide Google Pay API with a payment amount, currency, and amount status.
*
* @param price The price of the product.
* @return information about the requested payment.
* @throws JSONException if the object is malformed.
* @see [TransactionInfo](https://developers.google.com/pay/api/android/reference/object#TransactionInfo)
*/
@Throws(JSONException::class)
fun getDisplayItems(price: String): JSONArray {
val displayItems = JSONArray()
val tax = String.format(
Locale.getDefault(), "%.2f", BigDecimal(price).multiply(BigDecimal(Constants.TAX_RATE.toString()))
)
displayItems.put(createDisplayItem("Total", "SUBTOTAL", price))
displayItems.put(createDisplayItem("Tax", "TAX", tax))
return displayItems
}
/**
* An object describing information to be requested via the Google Pay payment sheet.
*
* @param price the price of the product
* @return Payment data expected by your app.
* @throws JSONException If the object is malformed.
* @see [PaymentDataRequest](https://developers.google.com/pay/api/android/reference/object#PaymentDataRequest)
*/
@Throws(JSONException::class)
fun getPaymentDataRequest(price: String): JSONObject {
return getBaseRequest()
.put("allowedPaymentMethods", getAllowedPaymentMethods())
.put("transactionInfo", getTransactionInfo(price))
.put("merchantInfo", JSONObject().put("merchantName", Constants.MERCHANT_NAME))
.put("shippingAddressRequired", true)
.put("shippingOptionRequired", true)
.put("shippingOptionParameters", getShippingOptionParameters())
.put(
"shippingAddressParameters",
JSONObject()
.put("phoneNumberRequired", false)
.put("allowedCountryCodes", JSONArray(Constants.SHIPPING_SUPPORTED_COUNTRIES))
)
.put(
"callbackIntents",
JSONArray()
.put("PAYMENT_AUTHORIZATION")
.put("SHIPPING_ADDRESS")
.put("SHIPPING_OPTION")
)
}
/**
* An object describing information to be updated via the Google Pay payment sheet.
*
* @param intermediatePaymentData the intermediate payment data containing user selections.
* @param price the price of the product.
* @return Payment data expected by your app.
* @throws JSONException If the object is malformed.
* @see [PaymentDataRequest](https://developers.google.com/pay/api/android/reference/object#PaymentDataRequest)
*/
@Throws(JSONException::class)
fun getPaymentDataRequestUpdate(
intermediatePaymentData: JSONObject, price: String
): JSONObject {
// Populate the payment request with default data
val paymentDataRequestUpdate = JSONObject()
paymentDataRequestUpdate.put("newTransactionInfo", getTransactionInfo(price))
val shippingOptionParameters = getShippingOptionParameters()
paymentDataRequestUpdate.put("newShippingOptionParameters", shippingOptionParameters)
// Update the selected shippingOption based on the user selection
var shippingOptionId = "shipping-001"
if (intermediatePaymentData.has("shippingOptionData")
&& intermediatePaymentData.getJSONObject("shippingOptionData").has("id")
) {
shippingOptionId =
intermediatePaymentData.getJSONObject("shippingOptionData").getString("id")
paymentDataRequestUpdate
.getJSONObject("newShippingOptionParameters")
.put("defaultSelectedOptionId", shippingOptionId)
}
// Get display item for the selected shipping method and add it to paymentDataRequestUpdate
val shippingDisplayItem = getShippingDisplayItem(shippingOptionId)
paymentDataRequestUpdate
.getJSONObject("newTransactionInfo")
.getJSONArray("displayItems")
.put(shippingDisplayItem)
// define shipping price
if (shippingDisplayItem.has("price")) {
// Update displayItems with the new price.
val totalPrice =
paymentDataRequestUpdate.getJSONObject("newTransactionInfo").getString("totalPrice")
val shippingPrice = shippingDisplayItem.getString("price")
val newTotalPriceValue = BigDecimal(totalPrice).add(BigDecimal(shippingPrice))
paymentDataRequestUpdate
.getJSONObject("newTransactionInfo")
.put("totalPrice", String.format(Locale.getDefault(), "%.2f", newTotalPriceValue))
}
return paymentDataRequestUpdate
}
/**
* Get a display item object for the selected shipping option.
*
* @param shippingOptionId the ID of the selected shipping option.
* @return a JSONObject containing the display item for the shipping option.
* @throws JSONException if the shipping option is invalid.
*/
@Throws(JSONException::class)
private fun getShippingDisplayItem(shippingOptionId: String?): JSONObject {
if (shippingOptionId == null) {
return JSONObject()
}
return when (shippingOptionId) {
"shipping-001" -> createDisplayItem("Shipping", "LINE_ITEM", "0")
"shipping-002" -> createDisplayItem("Shipping", "LINE_ITEM", "1.99")
"shipping-003" -> createDisplayItem("Shipping", "LINE_ITEM", "1000")
"shipping-004" -> createDisplayItem("Shipping", "LINE_ITEM", "2000")
"shipping_option_unselected" -> JSONObject()
else -> throw JSONException("This shipping option is invalid for the given address")
}
}
}
```
### View model
```kotlin
/*
* Copyright 2024 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.android.gms.samples.pay.viewmodel
import android.app.Application
import android.util.Log
import androidx.lifecycle.AndroidViewModel
import androidx.lifecycle.viewModelScope
import com.google.android.gms.common.api.ApiException
import com.google.android.gms.common.api.CommonStatusCodes
import com.google.android.gms.samples.pay.util.PaymentsUtil
import com.google.android.gms.tasks.CancellationTokenSource
import com.google.android.gms.tasks.Task
import com.google.android.gms.wallet.IsReadyToPayRequest
import com.google.android.gms.wallet.PaymentData
import com.google.android.gms.wallet.PaymentDataRequest
import com.google.android.gms.wallet.PaymentsClient
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.flow.update
import kotlinx.coroutines.launch
import kotlinx.coroutines.suspendCancellableCoroutine
import kotlinx.coroutines.tasks.await
import org.json.JSONException
import org.json.JSONObject
import java.util.concurrent.Executor
import kotlin.coroutines.resume
class CheckoutViewModel(application: Application) : AndroidViewModel(application) {
private val _paymentUiState: MutableStateFlow =
MutableStateFlow(PaymentUiState.NotStarted)
val paymentUiState: StateFlow = _paymentUiState.asStateFlow()
// A client for interacting with the Google Pay API.
private val paymentsClient: PaymentsClient = PaymentsUtil.createPaymentsClient(application)
init {
viewModelScope.launch {
verifyGooglePayReadiness()
}
}
/**
* Determine the user's ability to pay with a payment method supported by your app and display
* a Google Pay payment button.
*/
private suspend fun verifyGooglePayReadiness() {
val newUiState: PaymentUiState = try {
if (fetchCanUseGooglePay()) {
PaymentUiState.Available
} else {
PaymentUiState.Error(CommonStatusCodes.ERROR)
}
} catch (exception: ApiException) {
PaymentUiState.Error(exception.statusCode, exception.message)
}
_paymentUiState.update { newUiState }
}
/**
* Determine the user's ability to pay with a payment method supported by your app.
*/
private suspend fun fetchCanUseGooglePay(): Boolean {
val request = IsReadyToPayRequest.fromJson(PaymentsUtil.getIsReadyToPayRequest().toString())
return paymentsClient.isReadyToPay(request).await()
}
/**
* Creates a [Task] that starts the payment process with the transaction details included.
*
* @param price the price of the product
* @return a [Task] with the payment information.
* @see [PaymentDataRequest](https://developers.google.com/android/reference/com/google/android/gms/wallet/PaymentsClient#loadPaymentData(com.google.android.gms.wallet.PaymentDataRequest))
*/
fun getLoadPaymentDataTask(price: String): Task {
val paymentDataRequestJson = PaymentsUtil.getPaymentDataRequest(price)
val request = PaymentDataRequest.fromJson(paymentDataRequestJson.toString())
return paymentsClient.loadPaymentData(request)
}
/**
* At this stage, the user has already seen a popup informing them an error occurred. Normally,
* only logging is required.
*
* @param statusCode will hold the value of any constant from CommonStatusCode or one of the
* WalletConstants.ERROR_CODE_* constants.
* @see [Wallet Constants Library](https://developers.google.com/android/reference/com/google/android/gms/wallet/WalletConstants.constant-summary)
*/
private fun handleError(statusCode: Int, message: String?) {
Log.e("Google Pay API error", "Error code: $statusCode, Message: $message")
}
fun setPaymentData(paymentData: PaymentData) {
val payState = extractPaymentBillingName(paymentData)?.let {
PaymentUiState.PaymentCompleted(payerName = it)
} ?: PaymentUiState.Error(CommonStatusCodes.INTERNAL_ERROR)
_paymentUiState.update { payState }
}
private fun extractPaymentBillingName(paymentData: PaymentData): String? {
val paymentInformation = paymentData.toJson()
try {
// Token will be null if PaymentDataRequest was not constructed using fromJson(String).
val paymentMethodData =
JSONObject(paymentInformation).getJSONObject("paymentMethodData")
val billingName = paymentMethodData.getJSONObject("info")
.getJSONObject("billingAddress").getString("name")
Log.d("BillingName", billingName)
// Logging token string.
Log.d(
"Google Pay token", paymentMethodData
.getJSONObject("tokenizationData")
.getString("token")
)
return billingName
} catch (error: JSONException) {
Log.e("handlePaymentSuccess", "Error: $error")
}
return null
}
}
abstract class PaymentUiState internal constructor() {
object NotStarted : PaymentUiState()
object Available : PaymentUiState()
class PaymentCompleted(val payerName: String) : PaymentUiState()
class Error(val code: Int, val message: String? = null) : PaymentUiState()
}
suspend fun Task.awaitTask(cancellationTokenSource: CancellationTokenSource? = null): Task {
return if (isComplete) this else suspendCancellableCoroutine { cont ->
// Run the callback directly to avoid unnecessarily scheduling on the main thread.
addOnCompleteListener(DirectExecutor, cont::resume)
cancellationTokenSource?.let { cancellationSource ->
cont.invokeOnCancellation { cancellationSource.cancel() }
}
}
}
/**
* An [Executor] that just directly executes the [Runnable].
*/
private object DirectExecutor : Executor {
override fun execute(r: Runnable) {
r.run()
}
}
```
### Constants
```kotlin
/*
* Copyright 2024 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.android.gms.samples.pay
import com.google.android.gms.wallet.WalletConstants
/**
* This file contains several constants you must edit before proceeding.
* Please take a look at PaymentsUtil.java to see where the constants are used and to potentially
* remove ones not relevant to your integration.
*
*
* Required changes:
*
* 1. Update SUPPORTED_NETWORKS and SUPPORTED_METHODS if required (consult your processor if
* unsure)
* 1. Update CURRENCY_CODE to the currency you use.
* 1. Update SHIPPING_SUPPORTED_COUNTRIES to list the countries where you currently ship. If this
* is not applicable to your app, remove the relevant bits from PaymentsUtil.java.
* 1. If you're integrating with your `PAYMENT_GATEWAY`, update
* PAYMENT_GATEWAY_TOKENIZATION_NAME and PAYMENT_GATEWAY_TOKENIZATION_PARAMETERS per the
* instructions they provided. You don't need to update DIRECT_TOKENIZATION_PUBLIC_KEY.
* 1. If you're using `DIRECT` integration, please edit protocol version and public key as
* per the instructions.
*/
object Constants {
/**
* Changing this to ENVIRONMENT_PRODUCTION will make the API return chargeable card information.
* Please refer to the documentation to read about the required steps needed to enable
* ENVIRONMENT_PRODUCTION.
*
* @value #PAYMENTS_ENVIRONMENT
*/
const val PAYMENTS_ENVIRONMENT = WalletConstants.ENVIRONMENT_TEST
/**
* The allowed networks to be requested from the API. If the user has cards from networks not
* specified here in their account, these will not be offered for them to choose in the popup.
*
* @value #SUPPORTED_NETWORKS
*/
val SUPPORTED_NETWORKS = listOf(
"AMEX",
"DISCOVER",
"JCB",
"MASTERCARD",
"VISA"
)
/**
* The Google Pay API may return cards on file on Google.com (PAN_ONLY) and/or a device token on
* an Android device authenticated with a 3-D Secure cryptogram (CRYPTOGRAM_3DS).
*
* @value #SUPPORTED_METHODS
*/
val SUPPORTED_METHODS = listOf(
"PAN_ONLY",
"CRYPTOGRAM_3DS"
)
/**
* Required by the API, but not visible to the user.
*
* @value #COUNTRY_CODE Your local country
*/
const val COUNTRY_CODE = "US"
/**
* Required by the API, but not visible to the user.
*
* @value #CURRENCY_CODE Your local currency
*/
const val CURRENCY_CODE = "USD"
/**
* Supported countries for shipping (use ISO 3166-1 alpha-2 country codes). Relevant only when
* requesting a shipping address.
*
* @value #SHIPPING_SUPPORTED_COUNTRIES
*/
val SHIPPING_SUPPORTED_COUNTRIES = listOf("US", "GB")
/**
* The name of your payment processor/gateway. Please refer to their documentation for more
* information.
*
* @value #PAYMENT_GATEWAY_TOKENIZATION_NAME
*/
const val PAYMENT_GATEWAY_TOKENIZATION_NAME = "example"
/**
* Custom parameters required by the processor/gateway.
* In many cases, your processor / gateway will only require a gatewayMerchantId.
* Please refer to your processor's documentation for more information. The number of parameters
* required and their names vary depending on the processor.
*
* @value #PAYMENT_GATEWAY_TOKENIZATION_PARAMETERS
*/
val PAYMENT_GATEWAY_TOKENIZATION_PARAMETERS = mapOf(
"gateway" to PAYMENT_GATEWAY_TOKENIZATION_NAME,
"gatewayMerchantId" to "exampleGatewayMerchantId"
)
/**
* Only used for `DIRECT` tokenization. Can be removed when using `PAYMENT_GATEWAY`
* tokenization.
*
* @value #DIRECT_TOKENIZATION_PUBLIC_KEY
*/
const val DIRECT_TOKENIZATION_PUBLIC_KEY = "REPLACE_ME"
/**
* Parameters required for `DIRECT` tokenization.
* Only used for `DIRECT` tokenization. Can be removed when using `PAYMENT_GATEWAY`
* tokenization.
*
* @value #DIRECT_TOKENIZATION_PARAMETERS
*/
val DIRECT_TOKENIZATION_PARAMETERS = mapOf(
"protocolVersion" to "ECv2",
"publicKey" to DIRECT_TOKENIZATION_PUBLIC_KEY
)
/**
* A coefficient to calculate tax rates.
*
* @value #TAX_RATE The rate at which you want to calculate tax.
*/
const val TAX_RATE = 0.35
/**
* The default price for the product.
*
* @value #BASE_PRICE
*/
const val BASE_PRICE = "50.20"
/**
* The name of the merchant.
*
* @value #MERCHANT_NAME
*/
const val MERCHANT_NAME = "Example Merchant"
}
```
### Java
### Activity
```java
/*
* Copyright 2024 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.android.gms.samples.pay.activity;
import android.app.Activity;
import android.content.Intent;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.Toast;
import androidx.activity.result.ActivityResultLauncher;
import androidx.annotation.Nullable;
import androidx.appcompat.app.AppCompatActivity;
import androidx.lifecycle.ViewModelProvider;
import com.google.android.gms.common.api.CommonStatusCodes;
import com.google.android.gms.samples.pay.Constants;
import com.google.android.gms.samples.pay.R;
import com.google.android.gms.samples.pay.databinding.ActivityCheckoutBinding;
import com.google.android.gms.samples.pay.util.PaymentsUtil;
import com.google.android.gms.samples.pay.viewmodel.CheckoutViewModel;
import com.google.android.gms.tasks.Task;
import com.google.android.gms.wallet.PaymentData;
import com.google.android.gms.wallet.button.ButtonOptions;
import com.google.android.gms.wallet.button.PayButton;
import com.google.android.gms.wallet.contract.TaskResultContracts.GetPaymentDataResult;
import java.util.Locale;
import org.json.JSONException;
import org.json.JSONObject;
/** Checkout implementation for the app. */
public class CheckoutActivity extends AppCompatActivity {
private CheckoutViewModel model;
private PayButton googlePayButton;
private final ActivityResultLauncher> paymentDataLauncher =
registerForActivityResult(
new GetPaymentDataResult(),
result -> {
int statusCode = result.getStatus().getStatusCode();
switch (statusCode) {
case CommonStatusCodes.SUCCESS:
handlePaymentSuccess(result.getResult());
break;
// case CommonStatusCodes.CANCELED: The user canceled
case CommonStatusCodes.DEVELOPER_ERROR:
handleError(statusCode, result.getStatus().getStatusMessage());
break;
default:
handleError(
statusCode,
"Unexpected non API"
+ " exception when trying to deliver the task result to an activity!");
break;
}
});
/**
* Initialize the Google Pay API on creation of the activity.
*
* @see Activity#onCreate(android.os.Bundle)
*/
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
initializeUi();
// Check Google Pay availability
model = new ViewModelProvider(this).get(CheckoutViewModel.class);
model.canUseGooglePay.observe(this, this::setGooglePayAvailable);
}
private void initializeUi() {
// Use view binding to access the UI elements
ActivityCheckoutBinding layoutBinding = ActivityCheckoutBinding.inflate(getLayoutInflater());
setContentView(layoutBinding.getRoot());
// Set the price label from the constant
layoutBinding.detailPrice.setText(getString(R.string.price_format, Constants.BASE_PRICE));
// The Google Pay button is a layout file -- take the root view
googlePayButton = layoutBinding.googlePayButton;
try {
googlePayButton.initialize(
ButtonOptions.newBuilder()
.setAllowedPaymentMethods(PaymentsUtil.getAllowedPaymentMethods().toString())
.build());
googlePayButton.setOnClickListener(this::requestPayment);
} catch (JSONException e) {
Log.e("initializeUi", "Error initializing Google Pay button", e);
}
}
/**
* If isReadyToPay returned {@code true}, show the button and hide the "checking" text. Otherwise,
* notify the user that Google Pay is not available. Please adjust to fit in with your current
* user flow. You are not required to explicitly let the user know if isReadyToPay returns {@code
* false}.
*
* @param available isReadyToPay API response.
*/
private void setGooglePayAvailable(boolean available) {
if (available) {
googlePayButton.setVisibility(View.VISIBLE);
} else {
Toast.makeText(this, R.string.google_pay_status_unavailable, Toast.LENGTH_LONG).show();
}
}
/**
* Handles the request to start a payment.
*
* @param view The view that triggered the request.
*/
public void requestPayment(View view) {
// The price provided to the API should include taxes and shipping.
try {
// provide the default starting price here.
final Task task = model.getLoadPaymentDataTask(Constants.BASE_PRICE);
task.addOnCompleteListener(paymentDataLauncher::launch);
} catch (JSONException e) {
handleError(CommonStatusCodes.INTERNAL_ERROR, "The payment data task couldn't be created.");
}
}
/**
* PaymentData response object contains the payment information, as well as any additional
* requested information, such as billing and shipping address.
*
* @param paymentData A response object returned by Google after a payer approves payment.
* @see PaymentData
*/
private void handlePaymentSuccess(@Nullable PaymentData paymentData) {
if (paymentData == null) {
return;
}
final String paymentInfo = paymentData.toJson();
try {
JSONObject paymentMethodData = new JSONObject(paymentInfo).getJSONObject("paymentMethodData");
// If the gateway is set to "example", no payment information is returned - instead, the
// token will only consist of "examplePaymentMethodToken".
final JSONObject info = paymentMethodData.getJSONObject("info");
final String billingName = info.getJSONObject("billingAddress").getString("name");
Toast.makeText(this, getString(R.string.payments_show_name, billingName), Toast.LENGTH_LONG)
.show();
// Logging token string.
Log.d(
"Google Pay token",
paymentMethodData.getJSONObject("tokenizationData").getString("token"));
startActivity(new Intent(this, CheckoutSuccessActivity.class));
} catch (JSONException e) {
Log.e("handlePaymentSuccess", "Error: " + e);
}
}
/**
* At this stage, the user has already seen a popup informing them an error occurred. Normally,
* only logging is required.
*
* @param statusCode holds the value of any constant from CommonStatusCode or one of the
* WalletConstants.ERROR_CODE_* constants.
* @param message An optional error message.
* @see Wallet
* Constants Library
*/
private void handleError(int statusCode, @Nullable String message) {
Log.e(
"loadPaymentData failed",
String.format(Locale.getDefault(), "Error code: %d, Message: %s", statusCode, message));
}
}
```
### Success activity
```java
/*
* Copyright 2024 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.android.gms.samples.pay.activity;
import android.os.Bundle;
import androidx.appcompat.app.AppCompatActivity;
import com.google.android.gms.samples.pay.databinding.ActivityCheckoutSuccessBinding;
/** An activity that is displayed when a payment completes successfully. */
public class CheckoutSuccessActivity extends AppCompatActivity {
/**
* Initializes the activity.
*
* @param savedInstanceState If the activity is being re-initialized after previously being shut
* down then this Bundle contains the data it most recently supplied in {@link
* #onSaveInstanceState}. Note: Otherwise it is null.
*/
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
ActivityCheckoutSuccessBinding layoutBinding =
ActivityCheckoutSuccessBinding.inflate(getLayoutInflater());
setContentView(layoutBinding.getRoot());
}
}
```
### Util
```java
/*
* Copyright 2024 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.android.gms.samples.pay.util;
import static com.google.android.gms.samples.pay.Constants.TAX_RATE;
import android.content.Context;
import com.google.android.gms.samples.pay.Constants;
import com.google.android.gms.wallet.PaymentsClient;
import com.google.android.gms.wallet.Wallet;
import java.math.BigDecimal;
import java.util.Locale;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
/**
* Contains helper static methods for dealing with the Payments API.
*
* Many of the parameters used in the code are optional and are set here merely to call out their
* existence. Please consult the documentation to learn more and feel free to remove ones not
* relevant to your implementation.
*/
public class PaymentsUtil {
private PaymentsUtil() {}
/**
* Encapsulated shipping option parameters (set of options) definition.
*
* @return A {@link JSONObject} containing shipping options and the default selected option.
* @throws JSONException If the JSON object is malformed.
*/
public static JSONObject getShippingOptionParameters() throws JSONException {
JSONObject shippingOptionParameters = new JSONObject();
JSONArray shippingOptions = new JSONArray();
shippingOptions.put(
createShippingOption(
"shipping-001", "$0.00: Free shipping label", "Free Shipping example text"));
shippingOptions.put(
createShippingOption(
"shipping-002", "$1.99: Standard shipping label", "Standard shipping example text."));
shippingOptions.put(
createShippingOption(
"shipping-003", "$1000: Express shipping label", "Express shipping example text."));
shippingOptions.put(
createShippingOption(
"shipping-004", "$2000: Same-day shipping label", "Same-day shipping example text."));
shippingOptionParameters.put("shippingOptions", shippingOptions);
shippingOptionParameters.put("defaultSelectedOptionId", "shipping-001");
return shippingOptionParameters;
}
/**
* Defines an encapsulated shipping option.
*
* @param id The unique identifier for the shipping option.
* @param label The label to display for the shipping option.
* @param description A brief description of the shipping option.
* @return A {@link JSONObject} representing the shipping option.
* @throws JSONException If the JSON object is malformed.
*/
private static JSONObject createShippingOption(String id, String label, String description)
throws JSONException {
return new JSONObject().put("id", id).put("label", label).put("description", description);
}
/**
* Encapsulated definition for a display item.
*
* @param label The label to display for the item.
* @param type The type of the display item (e.g., LINE_ITEM, SUBTOTAL).
* @param price The price of the item.
* @return A {@link JSONObject} representing the display item.
* @throws JSONException If the JSON object is malformed.
*/
public static JSONObject createDisplayItem(String label, String type, String price)
throws JSONException {
return new JSONObject().put("label", label).put("type", type).put("price", price);
}
/**
* Create a Google Pay API base request object with properties used in all requests.
*
* @return Google Pay API base request object.
* @throws JSONException if the object is malformed.
*/
private static JSONObject getBaseRequest() throws JSONException {
return new JSONObject().put("apiVersion", 2).put("apiVersionMinor", 0);
}
/**
* Creates an instance of {@link PaymentsClient} for use in an {@link Context} using the
* environment and theme set in {@link Constants}.
*
* @param context is the caller's context.
* @return An instance of {@link PaymentsClient}.
*/
public static PaymentsClient createPaymentsClient(Context context) {
Wallet.WalletOptions walletOptions =
new Wallet.WalletOptions.Builder().setEnvironment(Constants.PAYMENTS_ENVIRONMENT).build();
return Wallet.getPaymentsClient(context, walletOptions);
}
/**
* Gateway Integration: Identify your gateway and your app'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 and modify them in Constants.java.
*
* @return Payment data tokenization for the CARD payment method.
* @throws JSONException if the object is malformed.
* @see PaymentMethodTokenizationSpecification
*/
private static JSONObject getGatewayTokenizationSpecification() throws JSONException {
return new JSONObject()
.put("type", "PAYMENT_GATEWAY")
.put(
"parameters",
new JSONObject()
.put("gateway", "example")
.put("gatewayMerchantId", "exampleGatewayMerchantId"));
}
/**
* {@code DIRECT} Integration: Decrypt a response directly on your servers. This configuration has
* additional data security requirements from Google and additional PCI DSS compliance complexity.
*
*
Please refer to the documentation for more information about {@code DIRECT} integration. The
* type of integration you use depends on your payment processor.
*
* @return Payment data tokenization for the CARD payment method.
* @throws JSONException if the object is malformed.
* @see PaymentMethodTokenizationSpecification
*/
private static JSONObject getDirectTokenizationSpecification()
throws JSONException, RuntimeException {
return new JSONObject()
.put("type", "DIRECT")
.put("parameters", new JSONObject(Constants.DIRECT_TOKENIZATION_PARAMETERS));
}
/**
* Card networks supported by your app and your gateway.
*
*
TODO: Confirm card networks supported by your app and gateway & update in Constants.java.
*
* @return Allowed card networks.
* @see CardParameters
*/
private static JSONArray getAllowedCardNetworks() {
return new JSONArray(Constants.SUPPORTED_NETWORKS);
}
/**
* Card authentication methods supported by your app and your gateway.
*
*
TODO: Confirm your processor supports Android device tokens on your supported card networks
* and make updates in Constants.java.
*
* @return Allowed card authentication methods.
* @see CardParameters
*/
private static JSONArray getAllowedCardAuthMethods() {
return new JSONArray(Constants.SUPPORTED_METHODS);
}
/**
* Describe your app's support for the CARD payment method.
*
*
The provided properties are applicable to both an IsReadyToPayRequest and a
* PaymentDataRequest.
*
* @return A CARD PaymentMethod object describing accepted cards.
* @throws JSONException if the object is malformed.
* @see PaymentMethod
*/
private static JSONObject getBaseCardPaymentMethod() throws JSONException {
return new JSONObject()
.put("type", "CARD")
.put(
"parameters",
new JSONObject()
.put("allowedAuthMethods", getAllowedCardAuthMethods())
.put("allowedCardNetworks", getAllowedCardNetworks())
.put("billingAddressRequired", true)
.put("billingAddressParameters", new JSONObject().put("format", "FULL")));
}
/**
* Describe the expected returned payment data for the CARD payment method.
*
* @return A CARD PaymentMethod describing accepted cards and optional fields.
* @throws JSONException if the object is malformed.
* @see PaymentMethod
*/
private static JSONObject getCardPaymentMethod() throws JSONException {
return getBaseCardPaymentMethod()
.put("tokenizationSpecification", getGatewayTokenizationSpecification());
}
/**
* Return a collection of payment methods allowed to complete the operation with Google Pay.
*
* @return A JSONArray object with the list of payment methods.
* @throws JSONException if the JSON object is malformed.
*/
public static JSONArray getAllowedPaymentMethods() throws JSONException {
return new JSONArray().put(getCardPaymentMethod());
}
/**
* An object describing accepted forms of payment by your app, used to determine a viewer's
* readiness to pay.
*
* @return API version and payment methods supported by the app.
* @throws JSONException if the object is malformed.
* @see IsReadyToPayRequest
*/
public static JSONObject getIsReadyToPayRequest() throws JSONException {
return getBaseRequest()
.put("allowedPaymentMethods", new JSONArray().put(getBaseCardPaymentMethod()));
}
/**
* Provide Google Pay API with a payment amount, currency, and amount status.
*
* @param price The price of the product.
* @return information about the requested payment.
* @throws JSONException if the object is malformed.
* @see TransactionInfo
*/
public static JSONObject getTransactionInfo(String price) throws JSONException {
return new JSONObject()
.put("totalPrice", price)
.put("totalPriceLabel", "Total")
.put("totalPriceStatus", "FINAL")
.put("countryCode", Constants.COUNTRY_CODE)
.put("currencyCode", Constants.CURRENCY_CODE)
.put("checkoutOption", "COMPLETE_IMMEDIATE_PURCHASE")
.put("displayItems", getDisplayItems(price));
}
/**
* Provide Google Pay API with a payment amount, currency, and amount status.
*
* @param price The price of the product.
* @return information about the requested payment.
* @throws JSONException if the object is malformed.
* @see TransactionInfo
*/
public static JSONArray getDisplayItems(String price) throws JSONException {
JSONArray displayItems = new JSONArray();
String tax =
String.format(
Locale.getDefault(), "%.2f", new BigDecimal(price).multiply(new BigDecimal(TAX_RATE)));
displayItems.put(createDisplayItem("Total", "SUBTOTAL", price));
displayItems.put(createDisplayItem("Tax", "TAX", tax));
return displayItems;
}
/**
* An object describing information to be requested via the Google Pay payment sheet.
*
* @param priceLabel the price of the product
* @return Payment data expected by your app.
* @throws JSONException If the object is malformed.
* @see PaymentDataRequest
*/
public static JSONObject getPaymentDataRequest(String priceLabel) throws JSONException {
return getBaseRequest()
.put("allowedPaymentMethods", getAllowedPaymentMethods())
.put("transactionInfo", getTransactionInfo(priceLabel))
.put("merchantInfo", new JSONObject().put("merchantName", Constants.MERCHANT_NAME))
.put("shippingAddressRequired", true)
.put("shippingOptionRequired", true)
.put("shippingOptionParameters", getShippingOptionParameters())
.put(
"shippingAddressParameters",
new JSONObject()
.put("phoneNumberRequired", false)
.put("allowedCountryCodes", new JSONArray(Constants.SHIPPING_SUPPORTED_COUNTRIES)))
.put(
"callbackIntents",
new JSONArray()
.put("PAYMENT_AUTHORIZATION")
.put("SHIPPING_ADDRESS")
.put("SHIPPING_OPTION"));
}
/**
* An object describing information to be updated via the Google Pay payment sheet.
*
* @param intermediatePaymentData the intermediate payment data containing user selections.
* @param priceLabel the price of the product.
* @return Payment data expected by your app.
* @throws JSONException If the object is malformed.
* @see PaymentDataRequest
*/
public static JSONObject getPaymentDataRequestUpdate(
JSONObject intermediatePaymentData, String priceLabel) throws JSONException {
// Populate the payment request with default data
JSONObject paymentDataRequestUpdate = new JSONObject();
paymentDataRequestUpdate.put("newTransactionInfo", getTransactionInfo(priceLabel));
JSONObject shippingOptionParameters = getShippingOptionParameters();
paymentDataRequestUpdate.put("newShippingOptionParameters", shippingOptionParameters);
// Update the selected shippingOption based on the user selection
String shippingOptionId = "shipping-001";
if (intermediatePaymentData.has("shippingOptionData")
&& intermediatePaymentData.getJSONObject("shippingOptionData").has("id")) {
shippingOptionId =
intermediatePaymentData.getJSONObject("shippingOptionData").getString("id");
paymentDataRequestUpdate
.getJSONObject("newShippingOptionParameters")
.put("defaultSelectedOptionId", shippingOptionId);
}
// Get display item for the selected shipping method and add it to paymentDataRequestUpdate
JSONObject shippingDisplayItem = getShippingDisplayItem(shippingOptionId);
paymentDataRequestUpdate
.getJSONObject("newTransactionInfo")
.getJSONArray("displayItems")
.put(shippingDisplayItem);
// define shipping price
if (shippingDisplayItem.has("price")) {
// Update displayItems with the new price.
String totalPrice =
paymentDataRequestUpdate.getJSONObject("newTransactionInfo").getString("totalPrice");
String shippingPrice = shippingDisplayItem.getString("price");
BigDecimal newTotalPriceValue = new BigDecimal(totalPrice).add(new BigDecimal(shippingPrice));
paymentDataRequestUpdate
.getJSONObject("newTransactionInfo")
.put("totalPrice", String.format(Locale.getDefault(), "%.2f", newTotalPriceValue));
}
return paymentDataRequestUpdate;
}
/**
* Get a display item object for the selected shipping option.
*
* @param shippingOptionId the ID of the selected shipping option.
* @return a JSONObject containing the display item for the shipping option.
* @throws JSONException if the shipping option is invalid.
*/
private static JSONObject getShippingDisplayItem(String shippingOptionId) throws JSONException {
if (shippingOptionId == null) {
return new JSONObject();
}
switch (shippingOptionId) {
case "shipping-001":
return createDisplayItem("Shipping", "LINE_ITEM", "0");
case "shipping-002":
return createDisplayItem("Shipping", "LINE_ITEM", "1.99");
case "shipping-003":
return createDisplayItem("Shipping", "LINE_ITEM", "1000");
case "shipping-004":
return createDisplayItem("Shipping", "LINE_ITEM", "2000");
case "shipping_option_unselected":
return new JSONObject();
default:
throw new JSONException("This shipping option is invalid for the given address");
}
}
}
```
### View model
```java
/*
* Copyright 2024 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.android.gms.samples.pay.viewmodel;
import android.app.Application;
import android.util.Log;
import androidx.annotation.NonNull;
import androidx.lifecycle.AndroidViewModel;
import androidx.lifecycle.LiveData;
import androidx.lifecycle.MutableLiveData;
import com.google.android.gms.samples.pay.util.PaymentsUtil;
import com.google.android.gms.tasks.Task;
import com.google.android.gms.wallet.IsReadyToPayRequest;
import com.google.android.gms.wallet.PaymentData;
import com.google.android.gms.wallet.PaymentDataRequest;
import com.google.android.gms.wallet.PaymentsClient;
import org.json.JSONException;
import org.json.JSONObject;
/** ViewModel for the {@link com.google.android.gms.samples.pay.activity.CheckoutActivity}. */
public class CheckoutViewModel extends AndroidViewModel {
// A client for interacting with the Google Pay API.
private final PaymentsClient paymentsClient;
// LiveData with the result of whether the user can pay using Google Pay
private final MutableLiveData canUseGooglePayInternal = new MutableLiveData<>();
public final LiveData canUseGooglePay = canUseGooglePayInternal;
/**
* Initializes the ViewModel.
*
* @param application The application context.
*/
public CheckoutViewModel(@NonNull Application application) {
super(application);
paymentsClient = PaymentsUtil.createPaymentsClient(application);
fetchCanUseGooglePay();
}
/**
* Determine the user's ability to pay with a payment method supported by your app and display a
* Google Pay payment button.
*/
private void fetchCanUseGooglePay() {
try {
final JSONObject isReadyToPayJson = PaymentsUtil.getIsReadyToPayRequest();
if (isReadyToPayJson == null) {
canUseGooglePayInternal.setValue(false);
return;
}
// The call to isReadyToPay is asynchronous and returns a Task. We need to provide an
// OnCompleteListener to be triggered when the result of the call is known.
IsReadyToPayRequest request = IsReadyToPayRequest.fromJson(isReadyToPayJson.toString());
Task task = paymentsClient.isReadyToPay(request);
task.addOnCompleteListener(
completedTask -> {
if (completedTask.isSuccessful()) {
canUseGooglePayInternal.setValue(completedTask.getResult());
} else {
Log.w("isReadyToPay failed", completedTask.getException());
canUseGooglePayInternal.setValue(false);
}
});
} catch (JSONException e) {
Log.w("isReadyToPay failed", e);
canUseGooglePayInternal.setValue(false);
}
}
/**
* Creates a Task that starts the payment process with the transaction details included.
*
* @param price the price to show on the payment sheet.
* @return a Task with the payment information.
* @throws JSONException If the JSON request is malformed.
*/
public Task getLoadPaymentDataTask(String price) throws JSONException {
JSONObject paymentDataRequestJson = PaymentsUtil.getPaymentDataRequest(price);
PaymentDataRequest request = PaymentDataRequest.fromJson(paymentDataRequestJson.toString());
return paymentsClient.loadPaymentData(request);
}
}
```
### Constants
```java
/*
* Copyright 2024 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.android.gms.samples.pay;
import com.google.android.gms.wallet.WalletConstants;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
/**
* This file contains several constants you must edit before proceeding.
* Please take a look at PaymentsUtil.java to see where the constants are used and to potentially
* remove ones not relevant to your integration.
*
* Required changes:
*
* - Update SUPPORTED_NETWORKS and SUPPORTED_METHODS if required (consult your processor if
* unsure)
*
- Update CURRENCY_CODE to the currency you use.
*
- Update SHIPPING_SUPPORTED_COUNTRIES to list the countries where you currently ship. If this
* is not applicable to your app, remove the relevant bits from PaymentsUtil.java.
*
- If you're integrating with your {@code PAYMENT_GATEWAY}, update
* PAYMENT_GATEWAY_TOKENIZATION_NAME and PAYMENT_GATEWAY_TOKENIZATION_PARAMETERS per the
* instructions they provided. You don't need to update DIRECT_TOKENIZATION_PUBLIC_KEY.
*
- If you're using {@code DIRECT} integration, please edit protocol version and public key as
* per the instructions.
*/
public class Constants {
/**
* Changing this to ENVIRONMENT_PRODUCTION will make the API return chargeable card information.
* Please refer to the documentation to read about the required steps needed to enable
* ENVIRONMENT_PRODUCTION.
*
* @value #PAYMENTS_ENVIRONMENT
*/
public static final int PAYMENTS_ENVIRONMENT = WalletConstants.ENVIRONMENT_TEST;
/**
* The allowed networks to be requested from the API. If the user has cards from networks not
* specified here in their account, these will not be offered for them to choose in the popup.
*
* @value #SUPPORTED_NETWORKS
*/
public static final List SUPPORTED_NETWORKS = Arrays.asList(
"AMEX",
"DISCOVER",
"JCB",
"MASTERCARD",
"VISA");
/**
* The Google Pay API may return cards on file on Google.com (PAN_ONLY) and/or a device token on
* an Android device authenticated with a 3-D Secure cryptogram (CRYPTOGRAM_3DS).
*
* @value #SUPPORTED_METHODS
*/
public static final List SUPPORTED_METHODS = Arrays.asList(
"PAN_ONLY",
"CRYPTOGRAM_3DS");
/**
* Required by the API, but not visible to the user.
*
* @value #COUNTRY_CODE Your local country
*/
public static final String COUNTRY_CODE = "US";
/**
* Required by the API, but not visible to the user.
*
* @value #CURRENCY_CODE Your local currency
*/
public static final String CURRENCY_CODE = "USD";
/**
* Supported countries for shipping (use ISO 3166-1 alpha-2 country codes). Relevant only when
* requesting a shipping address.
*
* @value #SHIPPING_SUPPORTED_COUNTRIES
*/
public static final List SHIPPING_SUPPORTED_COUNTRIES = Arrays.asList("US", "GB");
/**
* The name of your payment processor/gateway. Please refer to their documentation for more
* information.
*
* @value #PAYMENT_GATEWAY_TOKENIZATION_NAME
*/
public static final String PAYMENT_GATEWAY_TOKENIZATION_NAME = "example";
/**
* Custom parameters required by the processor/gateway.
* In many cases, your processor / gateway will only require a gatewayMerchantId.
* Please refer to your processor's documentation for more information. The number of parameters
* required and their names vary depending on the processor.
*
* @value #PAYMENT_GATEWAY_TOKENIZATION_PARAMETERS
*/
public static final HashMap PAYMENT_GATEWAY_TOKENIZATION_PARAMETERS =
new HashMap() {{
put("gateway", PAYMENT_GATEWAY_TOKENIZATION_NAME);
put("gatewayMerchantId", "exampleGatewayMerchantId");
// Your processor may require additional parameters.
}};
/**
* Only used for {@code DIRECT} tokenization. Can be removed when using {@code PAYMENT_GATEWAY}
* tokenization.
*
* @value #DIRECT_TOKENIZATION_PUBLIC_KEY
*/
public static final String DIRECT_TOKENIZATION_PUBLIC_KEY = "REPLACE_ME";
/**
* Parameters required for {@code DIRECT} tokenization.
* Only used for {@code DIRECT} tokenization. Can be removed when using {@code PAYMENT_GATEWAY}
* tokenization.
*
* @value #DIRECT_TOKENIZATION_PARAMETERS
*/
public static final HashMap DIRECT_TOKENIZATION_PARAMETERS =
new HashMap() {{
put("protocolVersion", "ECv2");
put("publicKey", DIRECT_TOKENIZATION_PUBLIC_KEY);
}};
/**
* A coefficient to calculate tax rates.
*
* @value #TAX_RATE The rate at which you want to calculate tax.
*/
public static final Double TAX_RATE = 0.35;
/**
* The default price for the product.
*
* @value #BASE_PRICE
*/
public static final String BASE_PRICE = "50.20";
/**
* The name of the merchant.
*
* @value #MERCHANT_NAME
*/
public static final String MERCHANT_NAME = "Example Merchant";
}
```
> [!NOTE]
> **Objective:** Checkout the [Integration checklist](https://developers.google.com/pay/api/android/guides/test-and-deploy/integration-checklist.md.txt) to validate your integration and request production access.