Cung cấp thông tin vận chuyển và thông tin liên hệ qua ứng dụng thanh toán của Android

Cách cập nhật ứng dụng thanh toán Android để cung cấp địa chỉ giao hàng và thông tin liên hệ của người thanh toán bằng Web Payments API.

Sahel Sharify
Sahel Sharify
GitHub

Việc nhập địa chỉ giao hàng và thông tin liên hệ thông qua biểu mẫu trên web có thể gây phiền hà cho khách hàng. Điều này có thể gây ra lỗi và làm giảm tỷ lệ chuyển đổi.

Đó là lý do API yêu cầu thanh toán hỗ trợ tính năng yêu cầu địa chỉ giao hàng và thông tin liên hệ. Điều này mang lại nhiều lợi ích:

  • Người dùng có thể chọn địa chỉ phù hợp chỉ bằng vài lần nhấn.
  • Địa chỉ luôn được trả về ở định dạng chuẩn hoá.
  • Bạn ít có khả năng gửi nhầm địa chỉ.

Trình duyệt có thể trì hoãn việc thu thập địa chỉ giao hàng và thông tin liên hệ cho một ứng dụng thanh toán để mang đến trải nghiệm thanh toán hợp nhất. Chức năng này được gọi là uỷ quyền.

Bất cứ khi nào có thể, Chrome sẽ uỷ quyền việc thu thập địa chỉ giao hàng và thông tin liên hệ của khách hàng cho ứng dụng thanh toán Android được gọi. Việc uỷ quyền giúp giảm sự phiền hà trong quá trình thanh toán.

Trang web của người bán có thể tự động cập nhật các lựa chọn vận chuyển và tổng giá tuỳ thuộc vào địa chỉ giao hàng và lựa chọn giao hàng mà khách hàng chọn.

Cách thay đổi lựa chọn vận chuyển và địa chỉ giao hàng. Xem mức độ ảnh hưởng linh động đến các lựa chọn vận chuyển và tổng giá.

Để thêm tính năng hỗ trợ uỷ quyền vào một ứng dụng thanh toán hiện có trên Android, hãy triển khai các bước sau:

  1. Khai báo các hoạt động uỷ quyền được hỗ trợ.
  2. Phân tích cú pháp các tuỳ chọn bổ sung về ý định PAY cho các tuỳ chọn thanh toán bắt buộc.
  3. Cung cấp thông tin bắt buộc trong phản hồi thanh toán.
  4. [Không bắt buộc] Hỗ trợ luồng động:
    1. Thông báo cho người bán về những thay đổi đối với phương thức thanh toán, địa chỉ giao hàng hoặc phương thức giao hàng mà người dùng đã chọn.
    2. Nhận thông tin thanh toán mới nhất từ người bán (ví dụ: tổng số tiền đã điều chỉnh dựa trên chi phí của phương thức giao hàng đã chọn).

Khai báo các hoạt động uỷ quyền được hỗ trợ

Trình duyệt cần biết danh sách thông tin bổ sung mà ứng dụng thanh toán của bạn có thể cung cấp để có thể uỷ quyền thu thập thông tin đó cho ứng dụng. Khai báo các uỷ quyền được hỗ trợ dưới dạng <meta-data> trong AndroidManifest.xml của ứng dụng.

<activity
  android:name=".PaymentActivity"
  …
  <meta-data
    android:name="org.chromium.payment_supported_delegations"
    android:resource="@array/supported_delegations" />
</activity>

<resource> phải là danh sách các chuỗi được chọn trong số các giá trị hợp lệ sau:

[ "payerName", "payerEmail", "payerPhone", "shippingAddress" ]

Ví dụ sau đây chỉ có thể cung cấp địa chỉ giao hàng và địa chỉ email của người thanh toán.

<?xml version="1.0" encoding="utf-8"?>
<resources>
  <string-array name="supported_delegations">
    <item>payerEmail</item>
    <item>shippingAddress</item>
  </string-array>
</resources>

Phân tích cú pháp các thông tin bổ sung về ý định PAY cho các phương thức thanh toán bắt buộc

Người bán có thể chỉ định thêm thông tin bắt buộc bằng cách sử dụng từ điển paymentOptions. Chrome sẽ cung cấp danh sách các tuỳ chọn bắt buộc mà ứng dụng của bạn có thể cung cấp bằng cách truyền các tham số sau vào hoạt động PAY dưới dạng Thông tin bổ sung về ý định.

paymentOptions

paymentOptions là tập hợp con các tuỳ chọn thanh toán do người bán chỉ định mà ứng dụng của bạn đã khai báo hỗ trợ uỷ quyền.

val paymentOptions: Bundle? = extras.getBundle("paymentOptions")
val requestPayerName: Boolean? = paymentOptions?.getBoolean("requestPayerName")
val requestPayerPhone: Boolean? = paymentOptions?.getBoolean("requestPayerPhone")
val requestPayerEmail: Boolean? = paymentOptions?.getBoolean("requestPayerEmail")
val requestShipping: Boolean? = paymentOptions?.getBoolean("requestShipping")
val shippingType: String? = paymentOptions?.getString("shippingType")

Hàm này có thể bao gồm các tham số sau:

  • requestPayerName – Giá trị boolean cho biết liệu có bắt buộc phải cung cấp tên của người thanh toán hay không.
  • requestPayerPhone – Giá trị boolean cho biết liệu có bắt buộc phải có điện thoại của người thanh toán hay không.
  • requestPayerEmail – Giá trị boolean cho biết email của người thanh toán có bắt buộc hay không.
  • requestShipping – Giá trị boolean cho biết liệu có bắt buộc phải cung cấp thông tin vận chuyển hay không.
  • shippingType – Chuỗi cho biết loại hình vận chuyển. Loại hình vận chuyển có thể là "shipping", "delivery" hoặc "pickup". Ứng dụng của bạn có thể sử dụng gợi ý này trong giao diện người dùng khi yêu cầu địa chỉ của người dùng hoặc lựa chọn phương thức vận chuyển.

shippingOptions

shippingOptions là mảng các lựa chọn vận chuyển theo gói do người bán chỉ định. Tham số này sẽ chỉ tồn tại khi paymentOptions.requestShipping == true.

val shippingOptions: List<ShippingOption>? =
    extras.getParcelableArray("shippingOptions")?.mapNotNull {
        p -> from(p as Bundle)
    }

Mỗi phương thức vận chuyển là một Bundle có các khoá sau.

  • id – Giá trị nhận dạng phương thức vận chuyển.
  • label – Nhãn lựa chọn vận chuyển hiển thị cho người dùng.
  • amount – Gói chi phí vận chuyển chứa các khoá currency và value có giá trị chuỗi.
    • currency cho biết đơn vị tiền tệ của phí vận chuyển, dưới dạng một mã bảng chữ cái gồm 3 chữ cái có định dạng hợp lệ theo tiêu chuẩn ISO4217
    • value cho biết giá trị của phí vận chuyển, dưới dạng giá trị tiền tệ thập phân hợp lệ
  • selected – Liệu có nên chọn phương thức vận chuyển khi ứng dụng thanh toán hiển thị các phương thức vận chuyển hay không.

Tất cả khoá khác ngoài selected đều có giá trị chuỗi. selected có giá trị boolean.

val id: String = bundle.getString("id")
val label: String = bundle.getString("label")
val amount: Bundle = bundle.getBundle("amount")
val selected: Boolean = bundle.getBoolean("selected", false)

Cung cấp thông tin bắt buộc trong phản hồi thanh toán

Ứng dụng phải bao gồm thông tin bổ sung bắt buộc khi phản hồi hoạt động PAY.

Để làm vậy, bạn phải chỉ định các tham số sau làm phần bổ sung Ý định:

  • payerName – Họ và tên của người thanh toán. Đây phải là một chuỗi không trống khi paymentOptions.requestPayerName là true.
  • payerPhone – Số điện thoại của người thanh toán. Đây phải là một chuỗi không trống khi paymentOptions.requestPayerPhone là true.
  • payerEmail – Địa chỉ email của người thanh toán. Đây phải là một chuỗi không trống khi paymentOptions.requestPayerEmail là true.
  • shippingAddress – Địa chỉ giao hàng do người dùng cung cấp. Đây phải là một gói không trống khi paymentOptions.requestShipping là true. Gói này phải có các khoá sau đây đại diện cho các phần khác nhau trong một địa chỉ thực.
    • city
    • countryCode
    • dependentLocality
    • organization
    • phone
    • postalCode
    • recipient
    • region
    • sortingCode
    • addressLine Tất cả các khoá khác ngoài addressLine đều có giá trị chuỗi. addressLine là một mảng chuỗi.
  • shippingOptionId – Giá trị nhận dạng của phương thức vận chuyển do người dùng chọn. Giá trị này phải là một chuỗi không trống khi paymentOptions.requestShipping là true.

Xác thực phản hồi thanh toán

Nếu kết quả hoạt động của một phản hồi thanh toán nhận được từ ứng dụng thanh toán được gọi được đặt thành RESULT_OK, thì Chrome sẽ kiểm tra thông tin bổ sung bắt buộc trong các phần bổ sung của ứng dụng đó. Nếu không xác thực được, Chrome sẽ trả về một lời hứa bị từ chối từ request.show() kèm theo một trong các thông báo lỗi sau đây dành cho nhà phát triển:

'Payment app returned invalid response. Missing field "payerEmail".'
'Payment app returned invalid response. Missing field "payerName".'
'Payment app returned invalid response. Missing field "payerPhone".'
'Payment app returned invalid shipping address in response.'
'... is not a valid CLDR country code, should be 2 upper case letters [A-Z]'
'Payment app returned invalid response. Missing field "shipping option".'

Mã mẫu sau đây là ví dụ về một phản hồi hợp lệ:

fun Intent.populateRequestedPaymentOptions() {
    if (requestPayerName) {
        putExtra("payerName", "John Smith")
    }
    if (requestPayerPhone) {
        putExtra("payerPhone", "4169158200")
    }
    if (requestPayerEmail) {
        putExtra("payerEmail", "john.smith@gmail.com")
    }
    if(requestShipping) {
        val address: Bundle = Bundle()
        address.putString("countryCode", "CA")
        val addressLines: Array<String> =
                arrayOf<String>("111 Richmond st. West")
        address.putStringArray("addressLines", addressLines)
        address.putString("region", "Ontario")
        address.putString("city", "Toronto")
        address.putString("postalCode", "M5H2G4")
        address.putString("recipient", "John Smith")
        address.putString("phone", "4169158200")
        putExtra("shippingAddress", address)
        putExtra("shippingOptionId", "standard")
    }
}

Không bắt buộc: Hỗ trợ luồng động

Đôi khi, tổng chi phí của một giao dịch sẽ tăng lên, chẳng hạn như khi người dùng chọn phương thức giao hàng nhanh hoặc khi danh sách các phương thức giao hàng hiện có hoặc giá của các phương thức đó thay đổi khi người dùng chọn địa chỉ giao hàng quốc tế. Khi cung cấp địa chỉ hoặc phương thức giao hàng do người dùng chọn, ứng dụng của bạn phải có thể thông báo cho người bán về mọi thay đổi đối với địa chỉ hoặc phương thức giao hàng và hiển thị cho người dùng thông tin thanh toán mới nhất (do người bán cung cấp).

AIDL

Để thông báo cho người bán về các thay đổi mới, hãy sử dụng dịch vụ PaymentDetailsUpdateService được khai báo trong AndroidManifest.xml của Chrome. Để sử dụng dịch vụ này, hãy tạo hai tệp AIDL có nội dung sau:

app/src/main/aidl/org/chromium/components/payments/IPaymentDetailsUpdateService

package org.chromium.components.payments;
import android.os.Bundle;

interface IPaymentDetailsUpdateServiceCallback {
    oneway void updateWith(in Bundle updatedPaymentDetails);

    oneway void paymentDetailsNotUpdated();
}

app/src/main/aidl/org/chromium/components/payments/IPaymentDetailsUpdateServiceCallback

package org.chromium.components.payments;
import android.os.Bundle;
import org.chromium.components.payments.IPaymentDetailsUpdateServiceCallback;

interface IPaymentDetailsUpdateService {
    oneway void changePaymentMethod(in Bundle paymentHandlerMethodData,
            IPaymentDetailsUpdateServiceCallback callback);

    oneway void changeShippingOption(in String shippingOptionId,
            IPaymentDetailsUpdateServiceCallback callback);

    oneway void changeShippingAddress(in Bundle shippingAddress,
            IPaymentDetailsUpdateServiceCallback callback);
}

Thông báo cho người bán về những thay đổi trong phương thức thanh toán, địa chỉ giao hàng hoặc cách thức giao hàng mà người dùng đã chọn

private fun bind() {
    // The action is introduced in Chrome version 92, which supports the service in Chrome
    // and other browsers (e.g., WebLayer).
    val newIntent = Intent("org.chromium.intent.action.UPDATE_PAYMENT_DETAILS")
        .setPackage(callingBrowserPackage)
    if (packageManager.resolveService(newIntent, PackageManager.GET_RESOLVED_FILTER) == null) {
        // Fallback to Chrome-only approach.
        newIntent.setClassName(
            callingBrowserPackage,
            "org.chromium.components.payments.PaymentDetailsUpdateService")
        newIntent.action = IPaymentDetailsUpdateService::class.java.name
    }
    isBound = bindService(newIntent, connection, Context.BIND_AUTO_CREATE)
}

private val connection = object : ServiceConnection {
    override fun onServiceConnected(className: ComponentName, service: IBinder) {
        val service = IPaymentDetailsUpdateService.Stub.asInterface(service)
        try {
            if (isOptionChange) {
                service?.changeShippingOption(selectedOptionId, callback)
            } else (isAddressChange) {
                service?.changeShippingAddress(selectedAddress, callback)
            } else {
                service?.changePaymentMethod(methodData, callback)
            }
        } catch (e: RemoteException) {
            // Handle the remote exception
        }
    }
}

callingPackageName dùng cho ý định bắt đầu của dịch vụ có thể có một trong các giá trị sau, tuỳ thuộc vào trình duyệt đã bắt đầu yêu cầu thanh toán.

Kênh Chrome Tên gói
Ổn định "com.android.chrome"
Beta "com.chrome.beta"
Nhà phát triển "com.chrome.dev"
Canary "com.chrome.canary"
Chromium "org.chromium.chrome"
Hộp tìm kiếm nhanh của Google (trình nhúng WebLayer) "com.google.android.googlequicksearchbox"

changePaymentMethod

Thông báo cho người bán về những thay đổi đối với phương thức thanh toán do người dùng chọn. Gói paymentHandlerMethodData chứa khoá methodName và khoá details tuỳ chọn, cả hai đều có giá trị chuỗi. Chrome sẽ kiểm tra một gói không trống có methodName không trống và gửi một updatePaymentDetails kèm theo một trong các thông báo lỗi sau đây qua callback.updateWith nếu quá trình xác thực không thành công.

'Method data required.'
'Method name required.'

changeShippingOption

Thông báo cho người bán về những thay đổi đối với phương thức vận chuyển do người dùng chọn. shippingOptionId phải là giá trị nhận dạng của một trong các tuỳ chọn vận chuyển do người bán chỉ định. Chrome sẽ kiểm tra để tìm shippingOptionId không trống và gửi updatePaymentDetails kèm theo thông báo lỗi sau qua callback.updateWith nếu quá trình xác thực không thành công.

'Shipping option identifier required.'

changeShippingAddress

Thông báo cho người bán khi địa chỉ giao hàng do người dùng cung cấp thay đổi. Chrome sẽ kiểm tra một gói shippingAddress không trống có countryCode hợp lệ và gửi updatePaymentDetails kèm theo thông báo lỗi sau đây qua callback.updateWith nếu không xác thực được.

'Payment app returned invalid shipping address in response.'

Thông báo lỗi trạng thái không hợp lệ

Nếu gặp trạng thái không hợp lệ khi nhận được bất kỳ yêu cầu thay đổi nào, Chrome sẽ gọi callback.updateWith bằng gói updatePaymentDetails đã bị loại bỏ. Gói này sẽ chỉ chứa khoá error với "Invalid state". Sau đây là ví dụ về trạng thái không hợp lệ:

  • Khi Chrome vẫn đang chờ phản hồi của người bán về một thay đổi trước đó (chẳng hạn như một sự kiện thay đổi đang diễn ra).
  • Giá trị nhận dạng tuỳ chọn vận chuyển do ứng dụng thanh toán cung cấp không thuộc bất kỳ tuỳ chọn vận chuyển nào do người bán chỉ định.

Nhận thông tin thanh toán mới nhất từ người bán

private fun unbind() {
    if (isBound) {
        unbindService(connection)
        isBound = false
    }
}

private val callback: IPaymentDetailsUpdateServiceCallback =
    object : IPaymentDetailsUpdateServiceCallback.Stub() {
        override fun paymentDetailsNotUpdated() {
            // Payment request details have not changed.
            unbind()
        }

        override fun updateWith(updatedPaymentDetails: Bundle) {
            newPaymentDetails = updatedPaymentDetails
            unbind()
        }
    }

updatePaymentDetails là gói tương đương với từ điển PaymentRequestDetailsUpdate WebIDL (sau khi loại bỏ trường modifiers) và chứa các khoá không bắt buộc sau:

  • total – Gói chứa các khoá currency và value, cả hai khoá đều có giá trị chuỗi
  • shippingOptions – Mảng có thể phân phối của các tuỳ chọn vận chuyển
  • error – Một chuỗi chứa thông báo lỗi chung (ví dụ: khi changeShippingOption không cung cấp mã nhận dạng phương thức giao hàng hợp lệ)
  • stringifiedPaymentMethodErrors – Chuỗi JSON đại diện cho lỗi xác thực đối với phương thức thanh toán
  • addressErrors – Một gói có các khoá không bắt buộc giống với địa chỉ giao hàng và giá trị chuỗi. Mỗi khoá biểu thị một lỗi xác thực liên quan đến phần tương ứng trong địa chỉ giao hàng.

Khoá không xuất hiện có nghĩa là giá trị của khoá không thay đổi.