Orchestrazione delle transazioni di pagamento con un service worker

Come adattare la tua app di pagamento basata sul web ai pagamenti web e offrire una migliore esperienza utente ai clienti.

Eiji Kitamura

Una volta registrata l'app di pagamento, puoi accettare le richieste di pagamento dei commercianti. Questo post spiega come orchestrare una transazione di pagamento da un service worker durante il runtime (ovvero quando viene visualizzata una finestra e l'utente interagisce con essa).

Per "modifiche ai parametri di pagamento di runtime" si intende un insieme di eventi che consente al commerciante e al gestore dei pagamenti di scambiarsi messaggi mentre l'utente interagisce con il gestore dei pagamenti. Per saperne di più, consulta Gestire i dati di pagamento facoltativi con un service worker.

Ricevere un evento di richiesta di pagamento dal commerciante

Quando un cliente sceglie di pagare con la tua app di pagamento basata sul web e il commerciante invoca PaymentRequest.show(), il tuo service worker riceve un evento paymentrequest. Aggiungi un gestore di eventi al servizio worker per acquisire l'evento e prepararti all'azione successiva.

[payment handler] service-worker.js:

…
let payment_request_event;
let resolver;
let client;

// `self` is the global object in service worker
self.addEventListener('paymentrequest', async e => {
  if (payment_request_event) {
    // If there's an ongoing payment transaction, reject it.
    resolver.reject();
  }
  // Preserve the event for future use
  payment_request_event = e;
…

Il PaymentRequestEvent conservato contiene informazioni importanti su questa transazione:

Apri la finestra del gestore dei pagamenti per visualizzare il frontend dell'app di pagamento basata sul web

Quando viene ricevuto un evento paymentrequest, l'app di pagamento può aprire una finestra di gestore pagamenti chiamando PaymentRequestEvent.openWindow(). La finestra del gestore dei pagamenti mostrerà ai clienti l'interfaccia della tua app di pagamento, dove potranno autenticarsi, scegliere l'indirizzo di spedizione e le opzioni e autorizzare il pagamento. Vedremo come scrivere il codice del frontend nella sezione Gestire i pagamenti nel frontend dei pagamenti (disponibile a breve).

Passa una promessa conservata a PaymentRequestEvent.respondWith() in modo da poterla risolvere con un risultato di pagamento in futuro.

[payment handler] service-worker.js:

…
self.addEventListener('paymentrequest', async e => {
…
  // Retain a promise for future resolution
  // Polyfill for PromiseResolver is provided below.
  resolver = new PromiseResolver();

  // Pass a promise that resolves when payment is done.
  e.respondWith(resolver.promise);
  // Open the checkout page.
  try {
    // Open the window and preserve the client
    client = await e.openWindow(checkoutURL);
    if (!client) {
      // Reject if the window fails to open
      throw 'Failed to open window';
    }
  } catch (err) {
    // Reject the promise on failure
    resolver.reject(err);
  };
});
…

Puoi utilizzare un comodo polyfill PromiseResolver per risolvere una promessa a tempi arbitrari.

class PromiseResolver {
  constructor() {
    this.promise_ = new Promise((resolve, reject) => {
      this.resolve_ = resolve;
      this.reject_ = reject;
    })
  }
  get promise() { return this.promise_ }
  get resolve() { return this.resolve_ }
  get reject() { return this.reject_ }
}

Scambia informazioni con il frontend

Il service worker dell'app di pagamento può scambiare messaggi con il frontend dell'app di pagamento tramite ServiceWorkerController.postMessage(). Per ricevere messaggi dal frontend, ascolta gli eventi message.

[payment handler] service-worker.js:

// Define a convenient `postMessage()` method
const postMessage = (type, contents = {}) => {
  if (client) client.postMessage({ type, ...contents });
}

Ricevere l'indicatore di disponibilità dal frontend

Una volta aperta la finestra del gestore dei pagamenti, il service worker deve attendere un indicazione di stato di elaborazione dall'interfaccia frontend dell'app di pagamento. Il service worker può trasmettere informazioni importanti al frontend quando è pronto.

[payment handler] frontend:

navigator.serviceWorker.controller.postMessage({
  type: 'WINDOW_IS_READY'
});

[payment handler] service-worker.js:

…
// Received a message from the frontend
self.addEventListener('message', async e => {
  let details;
  try {
    switch (e.data.type) {
      // `WINDOW_IS_READY` is a frontend's ready state signal
      case 'WINDOW_IS_READY':
        const { total } = payment_request_event;
…

Passare i dettagli della transazione al frontend

Ora invia nuovamente i dettagli di pagamento. In questo caso, invii solo il totale della richiesta di pagamento, ma puoi trasmettere ulteriori dettagli, se vuoi.

[gestore dei pagamenti] service-worker.js:

…
        // Pass the payment details to the frontend
        postMessage('PAYMENT_IS_READY', { total });
        break;
…

[payment handler] frontend:

let total;

navigator.serviceWorker.addEventListener('message', async e => {
  switch (e.data.type) {
      case 'PAYMENT_IS_READY':
        ({ total } = e.data);
        // Update the UI
        renderHTML(total);
        break;
…

Restituire le credenziali di pagamento del cliente

Quando il cliente autorizza il pagamento, il frontend può inviare un messaggio post al service worker per procedere. Puoi risolvere la promessa passata a PaymentRequestEvent.respondWith() per inviare il risultato al commerciante. Passa un oggetto PaymentHandlerResponse.

Frontend [gestore dei pagamenti]:

  const paymentMethod = …

  postMessage('PAYMENT_AUTHORIZED', {
    paymentMethod,              // Payment method identifier
  });

[payment handler] service-worker.js:

…
// Received a message from the frontend
self.addEventListener('message', async e => {
  let details;
  try {
    switch (e.data.type) {
      …
      case 'PAYMENT_AUTHORIZED':
        // Resolve the payment request event promise
        // with a payment response object
        const response = {
          methodName: e.data.paymentMethod,
          details: { id: 'put payment credential here' },
        }
        resolver.resolve(response);
        // Don't forget to initialize.
        payment_request_event = null;
        break;
      …

Annullare la transazione di pagamento

Per consentire al cliente di annullare la transazione, il frontend può inviare un messaggio post al service worker per farlo. Il service worker può quindi risolvere la promessa passata a PaymentRequestEvent.respondWith() con null per indicare al commerciante che la transazione è stata annullata.

[payment handler] frontend:

  postMessage('CANCEL_PAYMENT');

[payment handler] service-worker.js:

…
// Received a message from the frontend
self.addEventListener('message', async e => {
  let details;
  try {
    switch (e.data.type) {
      …
      case 'CANCEL_PAYMENT':
        // Resolve the payment request event promise
        // with null
        resolver.resolve(null);
        // Don't forget to initialize.
        payment_request_event = null;
        break;
      …

Codice di esempio

Tutti i codici di esempio che hai visto in questo documento sono estratti dalla seguente app di esempio funzionante:

https://paymenthandler-demo.glitch.me

[gestore pagamenti] service worker

[Gestore pagamenti] Frontend

Per provarlo:

1. Vai alla pagina https://paymentrequest-demo.glitch.me/.
2. Vai alla parte inferiore della pagina.
3. Premi il pulsante Aggiungi un pagamento.
4. Inserisci https://paymenthandler-demo.glitch.me nel campo Identificatore metodo di pagamento.
5. Premi il pulsante Paga accanto al campo.

Passaggi successivi

In questo articolo abbiamo appreso come orchestrare una transazione di pagamento da un servizio worker. Il passaggio successivo consiste nell'apprendere come aggiungere alcune funzionalità più avanzate al servizio worker.

• Gestire i dati di pagamento facoltativi con un service worker