Fournir des coordonnées et des informations de livraison depuis une application de paiement Android

Mettre à jour votre application de paiement Android afin d'indiquer l'adresse de livraison et les coordonnées du payeur avec les API de paiement Web

Saisir une adresse de livraison et des coordonnées via un formulaire Web peut s'avérer fastidieux pour les clients. Cela peut entraîner des erreurs et réduire le taux de conversion.

C'est pourquoi l'API Payment Request accepte une fonctionnalité permettant de demander des adresses de livraison et des coordonnées. Cela offre plusieurs avantages:

• Les utilisateurs peuvent sélectionner la bonne adresse en quelques gestes.
• L'adresse est toujours renvoyée au format standardisé.
• Il est moins probable que l'adresse indiquée soit incorrecte.

Les navigateurs peuvent différer la collecte de l'adresse de livraison et des coordonnées vers une application de paiement afin de fournir une expérience de paiement unifiée. Cette fonctionnalité est appelée délégation.

Dans la mesure du possible, Chrome délègue la collecte de l'adresse de livraison et des coordonnées du client à l'application de paiement Android invoquée. Cette délégation simplifie le processus de paiement.

Le site Web du marchand peut mettre à jour de manière dynamique les options de livraison et le prix total en fonction de l'adresse de livraison et de l'option de livraison choisies par le client.

Pour ajouter la délégation à une application de paiement Android existante, procédez comme suit:

1. Déclarez les délégations compatibles.
2. Analysez les extras d'intent PAY pour les options de paiement requises.
3. Fournissez les informations requises dans la réponse au paiement.
4. [Facultatif] Prise en charge du flux dynamique :
   1. Informez le marchand des modifications apportées au mode de paiement, à l'adresse de livraison ou à l'option de livraison sélectionnés par l'utilisateur.
   2. Recevoir des informations de paiement mises à jour de la part du marchand (par exemple, le montant total ajusté en fonction du coût de l'option de livraison sélectionnée)

Déclarer les délégations compatibles

Le navigateur doit connaître la liste des informations supplémentaires que votre application de paiement peut fournir pour pouvoir déléguer la collecte de ces informations à votre application. Déclarez les délégations compatibles en tant que <meta-data> dans le fichier AndroidManifest.xml de votre application.

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

<resource> doit être une liste de chaînes choisies parmi les valeurs valides suivantes:

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

L'exemple suivant ne peut fournir qu'une adresse de livraison et l'adresse e-mail du payeur.

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

Analyser les extras d'intent PAY pour les options de paiement requises

Le marchand peut spécifier les informations supplémentaires requises à l'aide du dictionnaire paymentOptions. Chrome fournit la liste des options requises que votre application peut fournir en transmettant les paramètres suivants à l'activité PAY en tant qu'extras d'intent.

paymentOptions

paymentOptions est le sous-ensemble d'options de paiement spécifiées par le marchand pour lesquelles votre application a déclaré une délégation.

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

Il peut inclure les paramètres suivants:

• requestPayerName : valeur booléenne indiquant si le nom du payeur est requis ou non.
• requestPayerPhone : valeur booléenne indiquant si le numéro de téléphone du payeur est requis ou non.
• requestPayerEmail : valeur booléenne indiquant si l'adresse e-mail du payeur est requise ou non.
• requestShipping : booléen indiquant si des informations de livraison sont requises ou non.
• shippingType : chaîne indiquant le type de livraison. Le type de livraison peut être "shipping", "delivery" ou "pickup". Votre application peut utiliser cet indice dans son UI lorsqu'elle demande l'adresse de l'utilisateur ou le choix d'options de livraison.

shippingOptions

shippingOptions est le tableau parcelable des options de livraison spécifiées par le marchand. Ce paramètre n'existe que lorsque paymentOptions.requestShipping == true.

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

Chaque option de livraison est un Bundle avec les clés suivantes.

• id : identifiant de l'option de livraison.
• label : étiquette de l'option de livraison présentée à l'utilisateur.
• amount : groupe de frais de port contenant des clés currency et value avec des valeurs de chaîne.
  • currency indique la devise des frais de port, sous la forme d'un code alphabétique ISO4217 bien formé à trois lettres.
  • value indique la valeur des frais de port sous forme de valeur monétaire décimale valide.
• selected : indique si l'option de livraison doit être sélectionnée lorsque l'application de paiement affiche les options de livraison.

Toutes les clés autres que selected ont des valeurs de chaîne. selected a une valeur booléenne.

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)

Fournir les informations requises dans une réponse au paiement

Votre application doit inclure les informations supplémentaires requises dans sa réponse à l'activité PAY.

Pour ce faire, les paramètres suivants doivent être spécifiés en tant qu'extras d'intent:

• payerName : nom complet du payeur. Cette chaîne ne doit pas être vide lorsque paymentOptions.requestPayerName est défini sur "true".
• payerPhone : numéro de téléphone du payeur. Cette chaîne ne doit pas être vide lorsque paymentOptions.requestPayerPhone est défini sur "true".
• payerEmail : adresse e-mail du payeur. Cette chaîne ne doit pas être vide lorsque paymentOptions.requestPayerEmail est défini sur "true".
• shippingAddress : adresse de livraison fournie par l'utilisateur. Il doit s'agir d'un bundle non vide lorsque paymentOptions.requestShipping est défini sur "true". Le bundle doit comporter les clés suivantes, qui représentent différentes parties dans une adresse physique.
  • city
  • countryCode
  • dependentLocality
  • organization
  • phone
  • postalCode
  • recipient
  • region
  • sortingCode
  • addressLineToutes les clés autres que addressLine ont des valeurs de chaîne. addressLine est un tableau de chaînes.
• shippingOptionId : identifiant de l'option de livraison sélectionnée par l'utilisateur. Cette chaîne ne doit pas être vide lorsque paymentOptions.requestShipping est défini sur "true".

Valider la réponse au paiement

Si le résultat d'activité d'une réponse de paiement reçue de l'application de paiement appelée est défini sur RESULT_OK, Chrome recherche les informations supplémentaires requises dans ses extras. Si la validation échoue, Chrome renvoie une promesse refusée de request.show() avec l'un des messages d'erreur suivants destinés aux développeurs:

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

L'exemple de code suivant est un exemple de réponse valide:

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

Facultatif: prendre en charge le flux dynamique

Parfois, le coût total d'une transaction augmente, par exemple lorsque l'utilisateur choisit l'option de livraison express, ou lorsque la liste des options de livraison disponibles ou ses prix changent lorsque l'utilisateur choisit une adresse de livraison internationale. Lorsque votre application fournit l'adresse ou l'option de livraison sélectionnées par l'utilisateur, elle doit avertir le marchand de toute modification d'adresse de livraison ou d'option, et présenter à l'utilisateur les détails de paiement mis à jour (fournis par le marchand).

AIDL

Pour informer le marchand des nouvelles modifications, utilisez le service PaymentDetailsUpdateService déclaré dans le fichier AndroidManifest.xml de Chrome. Pour utiliser ce service, créez deux fichiers AIDL avec le contenu suivant:

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

Informer le marchand des modifications apportées au mode de paiement, à l'adresse de livraison ou à l'option de livraison sélectionnés par l'utilisateur

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

Le callingPackageName utilisé pour l'intent de démarrage du service peut avoir l'une des valeurs suivantes en fonction du navigateur qui a initié la demande de paiement.

changePaymentMethod

Informe le marchand des modifications apportées au mode de paiement sélectionné par l'utilisateur. Le bundle paymentHandlerMethodData contient methodName et des clés details facultatives avec des valeurs de chaîne. Chrome recherchera un bundle non vide avec un methodName non vide et enverra un updatePaymentDetails avec l'un des messages d'erreur suivants via callback.updateWith si la validation échoue.

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

changeShippingOption

Informe le marchand des modifications apportées à l'option de livraison sélectionnée par l'utilisateur. shippingOptionId doit être l'identifiant de l'une des options de livraison spécifiées par le marchand. Chrome recherchera un shippingOptionId non vide et enverra un updatePaymentDetails avec le message d'erreur suivant via callback.updateWith si la validation échoue.

'Shipping option identifier required.'

changeShippingAddress

Informe le marchand des modifications apportées à l'adresse de livraison fournie par l'utilisateur. Chrome recherche un bundle shippingAddress non vide avec un countryCode valide et envoie un updatePaymentDetails avec le message d'erreur suivant via callback.updateWith si la validation échoue.

'Payment app returned invalid shipping address in response.'

Message d'erreur indiquant un état non valide

Si Chrome rencontre un état non valide lors de la réception de l'une des demandes de modification, il appelle callback.updateWith avec un bundle updatePaymentDetails masqué. Le bundle ne contiendra que la clé error avec "Invalid state". Exemples d'états non valides:

• Lorsque Chrome attend la réponse du marchand à une modification précédente (par exemple, un événement de modification en cours).
• L'identifiant de l'option de livraison fourni par l'application de paiement n'appartient à aucune des options de livraison spécifiées par le marchand.

Recevoir des informations de paiement mises à jour de la part du marchand

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 est le bundle équivalent au dictionnaire WebIDL PaymentRequestDetailsUpdate (après avoir masqué le champ modifiers) et contient les clés facultatives suivantes:

• total : bundle contenant des clés currency et value. Les deux clés ont des valeurs de chaîne.
• shippingOptions : tableau parcelable des options de livraison
• error : chaîne contenant un message d'erreur générique (par exemple, lorsque changeShippingOption ne fournit pas d'identifiant d'option de livraison valide).
• stringifiedPaymentMethodErrors : chaîne JSON représentant les erreurs de validation pour le mode de paiement
• addressErrors : bundle avec des clés facultatives identiques à l'adresse de livraison et aux valeurs de chaîne. Chaque clé représente une erreur de validation liée à la partie correspondante de l'adresse de livraison.

Une clé absente signifie que sa valeur n'a pas changé.