Android पेमेंट ऐप्लिकेशन से शिपिंग और संपर्क जानकारी देना

Web Payments API के ज़रिए शिपिंग पता और पैसे चुकाने वाले की संपर्क जानकारी देने के लिए, Android पेमेंट ऐप्लिकेशन को अपडेट करने का तरीका.

Sahel Sharify
Sahel Sharify
GitHub

वेब फ़ॉर्म की मदद से शिपिंग का पता और संपर्क जानकारी डालना, ग्राहकों के लिए मुश्किल हो सकता है. इससे गड़बड़ियां हो सकती हैं और कन्वर्ज़न रेट कम हो सकता है.

इसलिए, पेमेंट रिक्वेस्ट एपीआई में शिपिंग पते और संपर्क जानकारी का अनुरोध करने की सुविधा है. इससे कई फ़ायदे मिलते हैं:

  • उपयोगकर्ता, सिर्फ़ कुछ टैप करके सही पता चुन सकते हैं.
  • पता हमेशा स्टैंडर्ड फ़ॉर्मैट में दिखाया जाता है.
  • गलत पता सबमिट करने की संभावना कम होती है.

ब्राउज़र, पेमेंट ऐप्लिकेशन के लिए शिपिंग पते और संपर्क जानकारी इकट्ठा करने की प्रोसेस को टाल सकते हैं, ताकि सभी को एक ही तरह से पेमेंट किया जा सके. इस सुविधा को अधिकार सौंपना कहा जाता है.

जब भी संभव हो, Chrome, ग्राहक के शिपिंग पते और संपर्क जानकारी को इकट्ठा करने का काम, Android पर इस्तेमाल किए जा रहे पेमेंट ऐप्लिकेशन को सौंप देता है. ऐसा करने से, चेकआउट के दौरान होने वाली परेशानी कम हो जाती है.

खरीदार के चुने गए शिपिंग पते और शिपिंग के विकल्प के आधार पर, कारोबारी या कंपनी की वेबसाइट पर, शिपिंग के विकल्पों और कुल कीमत को डाइनैमिक तौर पर अपडेट किया जा सकता है.

शिपिंग का विकल्प और शिपिंग पता बदलने की कार्रवाई. देखें कि इससे शिपिंग के विकल्पों और कुल कीमत पर डाइनैमिक तौर पर क्या असर पड़ता है.

किसी मौजूदा Android पेमेंट ऐप्लिकेशन में, किसी दूसरे व्यक्ति को अनुमति देने की सुविधा जोड़ने के लिए, यह तरीका अपनाएं:

  1. एलान करें कि ऐक्सेस किस तरह के उपयोगकर्ताओं को दिया जा सकता है.
  2. पेमेंट के ज़रूरी विकल्पों के लिए, PAY इंटेंट के अतिरिक्त को पार्स करें.
  3. पेमेंट के जवाब में ज़रूरी जानकारी दें.
  4. [ज़रूरी नहीं] डाइनैमिक फ़्लो की सुविधा:
    1. उपयोगकर्ता के चुने गए पेमेंट के तरीके, शिपिंग पते या शिपिंग के विकल्प में हुए बदलावों के बारे में व्यापारी/कंपनी/कारोबारी को सूचना दें.
    2. व्यापारी से, पेमेंट के तरीके की अपडेट की गई जानकारी पाना (उदाहरण के लिए, शिपिंग के चुने गए विकल्प की कीमत के आधार पर, अडजस्ट की गई कुल रकम).

उन लोगों के बारे में बताएं जिनका इस्तेमाल किया जा सकता है

ब्राउज़र को उस अतिरिक्त जानकारी की सूची की जानकारी होनी चाहिए जो आपका पेमेंट ऐप्लिकेशन उपलब्ध करा सकता है, ताकि वह उस जानकारी को इकट्ठा करने का काम आपके ऐप्लिकेशन को सौंप सके. अपने ऐप्लिकेशन के AndroidManifest.xml में, काम करने वाले डेलिगेशन को <meta-data> के तौर पर बताएं.

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

<resource>, स्ट्रिंग की ऐसी सूची होनी चाहिए जिसे इन मान्य वैल्यू में से चुना गया हो:

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

यहां दिए गए उदाहरण में, सिर्फ़ शिपिंग का पता और पैसे चुकाने वाले का ईमेल पता दिया जा सकता है.

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

पेमेंट के ज़रूरी विकल्पों के लिए, PAY इंटेंट एक्सट्रा को पार्स करना

कारोबारी या कंपनी, paymentOptions डिक्शनरी का इस्तेमाल करके ज़रूरी जानकारी दे सकता है. Chrome, ज़रूरी विकल्पों की सूची उपलब्ध कराएगा. आपका ऐप्लिकेशन, इंटेंट एक्सट्रा के तौर पर PAY गतिविधि में ये पैरामीटर पास करके, ये विकल्प उपलब्ध करा सकता है.

paymentOptions

paymentOptions, कारोबारी या कंपनी के बताए गए पेमेंट के उन विकल्पों का सबसेट है जिनके लिए आपके ऐप्लिकेशन ने, डेलिगेशन की सुविधा का एलान किया है.

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")

इसमें ये पैरामीटर शामिल हो सकते हैं:

  • requestPayerName - बूलियन से पता चलता है कि पैसे चुकाने वाले का नाम डालना ज़रूरी है या नहीं.
  • requestPayerPhone - बूलियन से पता चलता है कि पैसे चुकाने वाले के फ़ोन की ज़रूरत है या नहीं.
  • requestPayerEmail - यह बूलियन बताता है कि पैसे चुकाने वाले का ईमेल पता देना ज़रूरी है या नहीं.
  • requestShipping - बूलियन से पता चलता है कि शिपिंग की जानकारी देना ज़रूरी है या नहीं.
  • shippingType - शिपिंग का टाइप दिखाने वाली स्ट्रिंग. शिपिंग का टाइप "shipping", "delivery" या "pickup" हो सकता है. आपका ऐप्लिकेशन, उपयोगकर्ता का पता या शिपिंग के विकल्पों को चुनने के लिए पूछते समय, अपने यूज़र इंटरफ़ेस (यूआई) में इस हिंट का इस्तेमाल कर सकता है.

shippingOptions

shippingOptions, व्यापारी/कंपनी के तय किए गए शिपिंग विकल्पों का पैकेज है. यह पैरामीटर सिर्फ़ तब दिखेगा, जब paymentOptions.requestShipping == true.

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

शिपिंग का हर विकल्प एक Bundle होता है, जिसमें ये कुंजियां होती हैं.

  • id - शिपिंग के विकल्प का आइडेंटिफ़ायर.
  • label - उपयोगकर्ता को दिखाया गया शिपिंग के विकल्प का लेबल.
  • amount - शिपिंग के लिए खरीदार से लिए जाने वाले शुल्क का बंडल, जिसमें currency और value बटन के साथ स्ट्रिंग वैल्यू शामिल होती हैं.
    • currency, शिपिंग के लिए खरीदार से लिए जाने वाले शुल्क की मुद्रा दिखाता है. यह वैल्यू ISO4217 फ़ॉर्मैट में, तीन अक्षरों वाले ऐल्फ़ा कोड के तौर पर मौजूद है
    • value, शिपिंग के लिए खरीदार से लिए जाने वाले शुल्क की वैल्यू को दशमलव वाली मान्य मुद्रा वैल्यू के तौर पर दिखाता है
  • selected - पेमेंट ऐप्लिकेशन में शिपिंग के विकल्प दिखने पर, शिपिंग का विकल्प चुना जाना चाहिए या नहीं.

selected के अलावा, सभी कुंजियों की वैल्यू स्ट्रिंग होती हैं. selected की बूलियन वैल्यू है.

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)

पेमेंट के जवाब में ज़रूरी जानकारी देना

आपके ऐप्लिकेशन को PAY गतिविधि के जवाब में, ज़रूरी अतिरिक्त जानकारी शामिल करनी चाहिए.

ऐसा करने के लिए, इन पैरामीटर को इंटेंट एक्स्ट्रा के तौर पर तय करना होगा:

  • payerName - पेमेंट करने वाले का पूरा नाम. paymentOptions.requestPayerName के 'सही' होने पर, यह एक स्ट्रिंग होनी चाहिए.
  • payerPhone - पैसे चुकाने वाले का फ़ोन नंबर. paymentOptions.requestPayerPhone के 'सही' होने पर, यह एक स्ट्रिंग होनी चाहिए.
  • payerEmail - पैसे चुकाने वाले का ईमेल पता. paymentOptions.requestPayerEmail के सही होने पर, यह एक खाली स्ट्रिंग नहीं होनी चाहिए.
  • shippingAddress - उपयोगकर्ता का दिया गया शिपिंग पता. paymentOptions.requestShipping के 'सही' होने पर, यह एक ऐसा बंडल होना चाहिए जिसमें कोई आइटम मौजूद हो. बंडल में ये कुंजियां होनी चाहिए, जो घर या ऑफ़िस के पते में अलग-अलग हिस्सों को दिखाती हैं.
    • city
    • countryCode
    • dependentLocality
    • organization
    • phone
    • postalCode
    • recipient
    • region
    • sortingCode
    • addressLine addressLine के अलावा, सभी कुंजियों की वैल्यू स्ट्रिंग होती है. addressLine, स्ट्रिंग का कलेक्शन होता है.
  • shippingOptionId - उपयोगकर्ता के चुने गए शिपिंग के विकल्प का आइडेंटिफ़ायर. paymentOptions.requestShipping के सही होने पर, यह स्ट्रिंग खाली नहीं होनी चाहिए.

पेमेंट के जवाब की पुष्टि करें

अगर ट्रिगर किए गए पेमेंट ऐप्लिकेशन से मिले पेमेंट रिस्पॉन्स की गतिविधि का नतीजा RESULT_OK पर सेट है, तो Chrome अपने एक्सट्रा में ज़रूरी अतिरिक्त जानकारी की जांच करेगा. अगर पुष्टि नहीं हो पाती है, तो Chrome request.show() से अस्वीकार किए गए प्रॉमिस के साथ, डेवलपर को गड़बड़ी का यह मैसेज दिखाएगा:

'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".'

यहां दिया गया कोड सैंपल, मान्य रिस्पॉन्स का उदाहरण है:

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")
    }
}

ज़रूरी नहीं: डाइनैमिक फ़्लो की सुविधा

कभी-कभी लेन-देन की कुल कीमत बढ़ जाती है. जैसे, जब कोई उपयोगकर्ता एक्सप्रेस शिपिंग का विकल्प चुनता है या जब कोई उपयोगकर्ता अंतरराष्ट्रीय शिपिंग पता चुनता है, तो शिपिंग के उपलब्ध विकल्पों की सूची या उनकी कीमतें बदल जाती हैं. जब आपका ऐप्लिकेशन, उपयोगकर्ता के चुने गए शिपिंग पते या विकल्प की जानकारी देता है, तो उसे शिपिंग पते या विकल्प में हुए किसी भी बदलाव के बारे में व्यापारी/कंपनी को सूचना देनी चाहिए. साथ ही, उपयोगकर्ता को पेमेंट के तरीके की अपडेट की गई जानकारी (व्यापारी/कंपनी की ओर से दी गई) दिखानी चाहिए.

एआईडीएल

व्यापारी/कंपनी/कारोबारी को नए बदलावों के बारे में सूचना देने के लिए, Chrome के AndroidManifest.xml में बताई गई PaymentDetailsUpdateService सेवा का इस्तेमाल करें. इस सेवा का इस्तेमाल करने के लिए, यहां दिए गए कॉन्टेंट के साथ दो AIDL फ़ाइलें बनाएं:

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);
}

उपयोगकर्ता के चुने गए पेमेंट के तरीके, शिपिंग पते या शिपिंग के विकल्प में हुए बदलावों के बारे में व्यापारी/कंपनी/कारोबारी को सूचना देना

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 में, इनमें से कोई एक वैल्यू हो सकती है. यह इस बात पर निर्भर करता है कि पेमेंट का अनुरोध किस ब्राउज़र से शुरू किया गया है.

Chrome चैनल पैकेज का नाम
स्थिर रुझान "com.android.chrome"
बीटा "com.chrome.beta"
डेवलपर "com.chrome.dev"
कैनेरी "com.chrome.canary"
Chromium "org.chromium.chrome"
Google क्विक सर्च बॉक्स (Weblayer एम्बेडर) "com.google.android.googlequicksearchbox"

changePaymentMethod

उपयोगकर्ता के चुने गए पेमेंट के तरीके में हुए बदलावों के बारे में व्यापारी/कंपनी/कारोबारी को सूचना देता है. paymentHandlerMethodData बंडल में methodName और वैकल्पिक details बटन शामिल हैं. दोनों की वैल्यू स्ट्रिंग होती है. Chrome, methodName के साथ किसी ऐसे बंडल की जांच करेगा जिसमें कोई डेटा हो. अगर पुष्टि नहीं हो पाती है, तो callback.updateWith के ज़रिए गड़बड़ी के इनमें से किसी एक मैसेज के साथ updatePaymentDetails भेजा जाएगा.

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

changeShippingOption

व्यापारी/कंपनी को, उपयोगकर्ता के चुने गए शिपिंग विकल्प में हुए बदलावों के बारे में सूचना देता है. shippingOptionId, व्यापारी/कंपनी/कारोबारी के बताए गए शिपिंग के विकल्पों में से किसी एक का आइडेंटिफ़ायर होना चाहिए. अगर पुष्टि नहीं हो पाती है, तो Chrome ऐसे shippingOptionId की जांच करेगा जो खाली नहीं है और callback.updateWith के ज़रिए इस गड़बड़ी के मैसेज के साथ updatePaymentDetails भेजेगा.

'Shipping option identifier required.'

changeShippingAddress

उपयोगकर्ता के दिए गए शिपिंग पते में हुए बदलावों के बारे में व्यापारी/कंपनी/कारोबारी को सूचना देता है. Chrome, मान्य countryCode के साथ ऐसे shippingAddress बंडल की जांच करेगा जो खाली नहीं है और अगर पुष्टि नहीं हो पाती है, तो गड़बड़ी के इस मैसेज के साथ updatePaymentDetails भेजेगा.callback.updateWith

'Payment app returned invalid shipping address in response.'

अमान्य स्थिति की गड़बड़ी का मैसेज

अगर Chrome को बदलाव का कोई अनुरोध मिलने पर, अमान्य स्थिति मिलती है, तो वह updatePaymentDetails बंडल के साथ callback.updateWith को कॉल करेगा. बंडल में सिर्फ़ "Invalid state" वाली error कुंजी होगी. अमान्य स्थिति के उदाहरण:

  • जब Chrome, कारोबारी/कंपनी/कारोबारी इकाई के किसी पिछले बदलाव (जैसे, बदलाव की प्रोसेस जारी है) के जवाब का इंतज़ार कर रहा हो.
  • पेमेंट ऐप्लिकेशन से मिला शिपिंग के विकल्प का आइडेंटिफ़ायर, व्यापारी/कंपनी/कारोबारी के बताए गए शिपिंग के विकल्पों में से किसी एक से भी मेल नहीं खाता.

व्यापारी/कंपनी से पेमेंट की अपडेट की गई जानकारी पाना

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, modifiers फ़ील्ड को हटाने के बाद, PaymentRequestDetailsUpdate WebIDL डिक्शनरी के बराबर का बंडल होता है. इसमें ये वैकल्पिक कुंजियां शामिल होती हैं:

  • total - currency और value बटन वाला बंडल, दोनों बटन की वैल्यू स्ट्रिंग है
  • shippingOptions - शिपिंग के विकल्पों का पैकेज किया जा सकने वाला ऐरे
  • error - गड़बड़ी का सामान्य मैसेज वाली स्ट्रिंग. उदाहरण के लिए, जब changeShippingOption शिपिंग के मान्य विकल्प का आइडेंटिफ़ायर नहीं देता है
  • stringifiedPaymentMethodErrors - पेमेंट के तरीके की पुष्टि से जुड़ी गड़बड़ियां दिखाने वाली JSON स्ट्रिंग
  • addressErrors - शिपिंग पते और स्ट्रिंग वैल्यू जैसी वैकल्पिक कुंजियों वाला बंडल. हर कुंजी, शिपिंग पते के उस हिस्से से जुड़ी पुष्टि से जुड़ी गड़बड़ी दिखाती है जिससे वह जुड़ी है.

अगर कोई कुंजी मौजूद नहीं है, तो इसका मतलब है कि उसकी वैल्यू नहीं बदली है.