Configurer un mode de paiement

Une transaction de paiement via Web Payments commence par la découverte de votre application de paiement. Découvrez comment configurer un mode de paiement et préparer votre application de paiement pour que les marchands et les clients puissent effectuer des paiements.

Pour être utilisée avec l'API Payment Request, une application de paiement doit être associée à un identifiant de mode de paiement. Marchands souhaitant intégrer une application de paiement utilisera l'identifiant du mode de paiement pour l'indiquer au navigateur. Cet article explique le fonctionnement de la découverte d'applications de paiement et comment configurer votre application de paiement pour qu'elle soit correctement découverte et appelée par un navigateur.

Si vous ne connaissez pas encore le concept des paiements Web ou le fonctionnement des transactions de paiement via des applications de paiement, commencez par lire les articles suivants:

Prise en charge des navigateurs

Les paiements Web se composent de plusieurs technologies différentes, et l'état de prise en charge dépend du navigateur.

Chrome Safari Firefox
Ordinateur Android Ordinateur Mobile Ordinateur/Mobile
API Payment Request
API Payment Handler
Application de paiement iOS/Android ✔* ✔*

Comment un navigateur découvre-t-il une application de paiement ?

Chaque application de paiement doit fournir les éléments suivants:

  • Identifiant du mode de paiement basé sur l'URL
  • Fichier manifeste du mode de paiement (sauf lorsque l'identifiant du mode de paiement est fournies par un tiers)
  • Fichier manifeste d'application Web
Diagramme: comment un navigateur identifie l'application de paiement à partir d'un identifiant de mode de paiement basé sur une URL

Le processus de découverte commence lorsqu'un marchand lance une transaction :

  1. Le navigateur envoie une requête à l'URL de l'identifiant du mode de paiement et extrait le fichier manifeste du mode de paiement.
  2. Le navigateur détermine l'URL du fichier manifeste de l'application Web à partir du fichier manifeste du mode de paiement et extrait le fichier manifeste de l'application Web.
  3. Le navigateur détermine s'il faut lancer l'application de paiement du système d'exploitation ou à partir du fichier manifeste de l'application Web.

Les sections suivantes expliquent en détail comment configurer votre propre mode de paiement afin que les navigateurs puissent la détecter.

Étape 1 : Indiquez l'identifiant du mode de paiement

Un identifiant de mode de paiement est une chaîne basée sur une URL. Par exemple, l'identifiant Google Pay est https://google.com/pay Les développeurs d'applications de paiement peuvent choisir n'importe quelle URL comme identifiant de mode de paiement, à condition qu'ils en aient le contrôle et qu'ils puissent diffuser du contenu arbitraire. Dans cet article, nous utiliserons https://bobbucks.dev/pay comme mode de paiement identifiant.

Comment les marchands utilisent-ils l'identifiant du mode de paiement ?

Un objet PaymentRequest est construit avec une liste de modes de paiement. identifiants qui identifient les modes de paiement applications qu'un marchand décide d'accepter. Les identifiants de mode de paiement sont définis comme valeur pour la propriété supportedMethods. Exemple :

[marchand] demande le paiement:

const request = new PaymentRequest([{
  supportedMethods: 'https://bobbucks.dev/pay'
}], {
  total: {
    label: 'total',
    amount: { value: '10', currency: 'USD' }
  }
});

Étape 2 : Présentez le fichier manifeste du mode de paiement

Un fichier manifeste de mode de paiement est un fichier JSON qui définit l'application de paiement pouvant utiliser ce mode de paiement.

Fournir le fichier manifeste des modes de paiement

Lorsqu'un marchand initie une transaction de paiement, le navigateur envoie une requête GET à l'URL de l'identifiant du mode de paiement. Le serveur répond en indiquant le mode de paiement corps du fichier manifeste.

Un fichier manifeste de mode de paiement comporte deux champs : default_applications et supported_origins.

Nom de propriété Description
default_applications (obligatoire) Tableau d'URL pointant vers des fichiers manifestes d'application Web sur lesquels les applications de paiement sont hébergées. (L'URL peut être relative). Ce tableau est attendu pour référencer le fichier manifeste de développement, le fichier manifeste de production, etc.
supported_origins Tableau d'URL pointant vers des origines pouvant héberger des applications de paiement tierces implémentant le même mode de paiement. Notez qu'un mode de paiement peut être implémenté par plusieurs applications de paiement.
Champs du fichier manifeste du mode de paiement

Le fichier manifeste d'un mode de paiement doit se présenter comme suit:

[payment handler] /payment-manifest.json

{
  "default_applications": ["https://bobbucks.dev/manifest.json"],
  "supported_origins": [
    "https://alicepay.friendsofalice.example"
  ]
}

Lorsque le navigateur lit le champ default_applications, il trouve une liste de des liens vers les fichiers manifestes d'application Web des applications de paiement.

(facultatif) rediriger le navigateur vers un autre emplacement pour trouver le fichier manifeste du mode de paiement

L'URL de l'identifiant du mode de paiement peut éventuellement répondre avec un en-tête Link qui pointe vers une autre URL à partir de laquelle le navigateur peut récupérer le fichier manifeste du mode de paiement. Cela est utile lorsqu'un fichier manifeste de mode de paiement est hébergé sur un autre serveur ou lorsque l'application de paiement est diffusée par un tiers.

Comment un navigateur découvre l'application de paiement à partir d'un identifiant de mode de paiement basé sur une URL avec des redirections

Configurez le serveur de modes de paiement pour qu'il réponde avec un en-tête HTTP Link avec l'attribut rel="payment-method-manifest" et le mode de paiement fichier manifeste.

Par exemple, si le fichier manifeste se trouve à https://bobbucks.dev/payment-manifest.json, l'en-tête de réponse inclut les éléments suivants :

Link: <https://bobbucks.dev/payment-manifest.json>; rel="payment-method-manifest"

L'URL peut être un nom de domaine complet ou un chemin d'accès relatif. Inspecter https://bobbucks.dev/pay/ pour le trafic réseau afin de voir un exemple. Vous pouvez utiliser un curl:

curl --include https://bobbucks.dev/pay

Étape 3: Diffusez un fichier manifeste d'application Web

Comme son nom l'indique, un fichier manifeste d'application Web permet de définir une application Web. Il s'agit d'un fichier manifeste couramment utilisé pour définir une progressive web app (PWA).

Le fichier manifeste d'application Web type se présente comme suit:

[gestionnaire de paiement] /manifest.json:

{
  "name": "Pay with Bobpay",
  "short_name": "Bobpay",
  "description": "This is an example of the Payment Handler API.",
  "icons": [
    {
      "src": "images/manifest/icon-192x192.png",
      "sizes": "192x192",
      "type": "image/png"
    },
    {
      "src": "images/manifest/icon-512x512.png",
      "sizes": "512x512",
      "type": "image/png"
    }
  ],
  "serviceworker": {
    "src": "service-worker.js",
    "scope": "/",
    "use_cache": false
  },
  "start_url": "/",
  "display": "standalone",
  "theme_color": "#3f51b5",
  "background_color": "#3f51b5",
  "related_applications": [
    {
      "platform": "play",
      "id": "com.example.android.samplepay",
      "min_version": "1",
      "fingerprints": [
        {
          "type": "sha256_cert",
          "value": "4C:FC:14:C6:97:DE:66:4E:66:97:50:C0:24:CE:5F:27:00:92:EE:F3:7F:18:B3:DA:77:66:84:CD:9D:E9:D2:CB"
        }
      ]
    }
  ]
}

Les informations décrites dans un fichier manifeste d'application Web servent également à définir l'apparence d'une application de paiement dans l'UI de la demande de paiement.

Nom de propriété Description
name (obligatoire) Utilisé comme nom de l'application de paiement.
icons (obligatoire) Utilisée comme icône de l'application de paiement. Seul Chrome utilise ces icônes. Les autres navigateurs peuvent les utiliser comme icônes de remplacement si vous ne les spécifiez pas dans le mode de paiement.
serviceworker Permet de détecter le service worker qui s'exécute en tant qu'application de paiement Web.
serviceworker.src URL à partir de laquelle télécharger le script du service worker.
serviceworker.scope Chaîne représentant une URL qui définit le champ d'application de l'enregistrement d'un service worker.
serviceworker.use_cache URL à partir de laquelle télécharger le script du service worker.
related_applications Permet de détecter l'application de paiement fournie par le système d'exploitation. Pour plus d'informations, consultez la page Android guide du développeur pour les applications de paiement.
prefer_related_applications Permet de déterminer quelle application de paiement lancer lorsqu'une application de paiement fournie par l'OS et une application de paiement basée sur le Web sont disponibles.
Champs importants du fichier manifeste d'application Web
Application de paiement avec une icône.
Libellé et icône de l'application de paiement.

La propriété name du fichier manifeste d'application Web est utilisée comme nom de l'application de paiement, icons. est utilisée comme icône de l'application de paiement.

Comment Chrome détermine l'application de paiement à lancer

Lancer l'application de paiement spécifique à la plate-forme

Pour lancer l'application de paiement spécifique à la plate-forme, les conditions suivantes doivent être remplies:

  • Le champ related_applications est spécifié dans le fichier manifeste de l'application Web et :
    • L'ID de package et la signature de l'application installée correspondent, tandis que la version minimale (min_version) du fichier manifeste de l'application Web est inférieure ou égale à la version de l'application installée.
  • Le champ prefer_related_applications correspond à true.
  • L'application de paiement spécifique à la plate-forme est installée et dispose des éléments suivants:
    • Un filtre d'intent de org.chromium.action.PAY.
    • Identifiant du mode de paiement spécifié comme valeur de la propriété org.chromium.default_payment_method_name.

Consultez Applications de paiement Android: guide du développeur pour en savoir plus sur leur configuration.

[gestionnaire de paiement] /manifest.json

"prefer_related_applications": true,
"related_applications": [{
  "platform": "play",
  "id": "xyz.bobpay.app",
  "min_version": "1",
  "fingerprints": [{
    "type": "sha256_cert",
    "value": "92:5A:39:05:C5:B9:EA:BC:71:48:5F:F2:05:0A:1E:57:5F:23:40:E9:E3:87:14:EC:6D:A2:04:21:E0:FD:3B:D1"
  }]
}]

Si le navigateur a déterminé que l'application de paiement spécifique à la plate-forme est disponible, le flux de découverte se termine ici. Sinon, l'utilisateur passe à l'étape suivante, à savoir le lancement de l'application de paiement basée sur le Web.

Lancer l'application de paiement en ligne

L'application de paiement basée sur le Web doit être spécifiée dans le champ serviceworker du fichier manifeste de l'application Web.

[gestionnaire de paiement] /manifest.json:

"serviceworker": {
  "src": "payment-handler.js"
}

Le navigateur lance l'application de paiement Web en envoyant un paymentrequest. sur le service worker. Il n'est pas nécessaire que le service worker soit enregistré avancer. Il peut être enregistré juste-à-temps.

Comprendre les optimisations spéciales

Comment les navigateurs peuvent-ils ignorer l'UI de la demande de paiement et lancer directement une application de paiement ?

Dans Chrome, lorsque la méthode show() de PaymentRequest est appelée, L'API Request affiche une interface utilisateur fournie par le navigateur, appelée "Interface de demande de paiement". Cette UI permet aux utilisateurs de choisir une application de paiement. Après avoir appuyé sur le bouton Continuer dans l'UI de la demande de paiement, l'application de paiement sélectionnée est lancée.

La demande de paiement intervient avant le lancement de l'application de paiement.

Afficher l'interface utilisateur de demande de paiement avant de lancer une application de paiement augmente le nombre d'étapes nécessaires pour qu'un utilisateur effectue un paiement. Pour optimiser le processus, le navigateur peut déléguer le traitement de ces informations à des applications de paiement et lancer directement une application de paiement sans afficher l'UI de la demande de paiement lorsque show() est appelé.

Ignorez l'UI de la demande de paiement et lancez directement l'application de paiement.

Pour lancer directement une application de paiement, les conditions suivantes doivent être remplies :

  • show() est déclenché par un geste utilisateur (par exemple, un clic de souris).
  • Une seule application de paiement:
    • Compatible avec l'identifiant du mode de paiement demandé.

Quand une application de paiement sur le Web est-elle enregistrée juste-à-temps (JIT) ?

Les applications de paiement Web peuvent être lancées sans intervention préalable explicite de l'utilisateur. au site Web de l'application de paiement et à enregistrer le service worker. Le service peut être enregistré juste-à-temps, lorsque l'utilisateur choisit de payer avec une application de paiement Web. Il existe deux façons de s'inscrire:

  • Si l'interface utilisateur de demande de paiement est présentée à l'utilisateur, cela signifie que l'application est enregistrée. juste à temps et lancée lorsque l'utilisateur clique sur Continuer.
  • Si l'UI de la requête de paiement est ignorée, l'application de paiement est enregistrée juste à temps et lancée directement. Ignorer l'affichage de l'interface utilisateur des demandes de paiement une application enregistrée juste à temps nécessite un geste de l'utilisateur, ce qui empêche l'enregistrement inattendu de service workers multi-origines.

Étapes suivantes

Maintenant que votre application de paiement est visible, découvrez comment développer une application de paiement spécifique à une plate-forme. une application de paiement et une application de paiement sur le Web.