Come funziona l'API Payment Request

Scopri come funziona l'API Payment Request a livello generale.

Eiji Kitamura

API Payment Request

Quando un cliente tenta di acquistare qualcosa sul tuo sito web, il sito deve chiedergli di fornire i dati di pagamento e, facoltativamente, altre informazioni come le preferenze di spedizione. Puoi farlo facilmente e rapidamente utilizzando l'API Payment Request (PR API).

Struttura di base

La creazione di un oggetto PaymentRequest richiede due parametri: payment methods e payment details. Inoltre, è facoltativo un terzo parametro payment options. Una richiesta di base può essere creata come segue:

const request = new PaymentRequest(paymentMethods, paymentDetails);

Vediamo come viene creato e utilizzato ciascun parametro.

Metodi di pagamento

Il primo parametro, paymentMethods, è un elenco di metodi di pagamento supportati in una variabile array. Ogni elemento dell'array è composto da due componenti, supportedMethods e, facoltativamente, data.

Per supportedMethods, il commerciante deve specificare un Identifier Method Method come https://bobbucks.dev/pay. L'esistenza e i contenuti di data dipendono dai contenuti di supportedMethods e dal design del fornitore dell'app di pagamento.

Entrambe le informazioni devono essere fornite dal fornitore dell'app di pagamento.

// Supported payment methods
const paymentMethods = [{
  supportedMethods: 'https://bobbucks.dev/pay',
  data: {
    ... // Optional parameters defined by the payment app provider.
  }
}];

Dettagli sul pagamento

Il secondo parametro, paymentDetails, viene passato come oggetto e specifica i dettagli di pagamento per la transazione. Contiene il valore obbligatorio total, che specifica l'importo totale dovuto dal cliente. Questo parametro può anche elencare facoltativamente gli articoli acquistati.

Nell'esempio riportato di seguito, viene mostrato l'elenco facoltativo degli articoli acquistati (in questo caso solo un articolo) e l'importo totale dovuto richiesto. In entrambi i casi, l'unità di moneta viene specificata con ogni singolo importo.

const paymentDetails = {
  displayItems: [{
    label: 'Anvil L/S Crew Neck - Grey M x1',
    amount: { currency: 'USD', value: '22.15' }
  }],
  total: {
    label: 'Total due',
    amount: { currency: 'USD', value : '22.15' }
  }
};

Controllare se il metodo di pagamento è disponibile

Chrome controlla se l'utente e l'ambiente sono pronti per effettuare il pagamento durante la costruzione di un oggetto PaymentRequest.

Per verificare se l'utente e l'ambiente sono pronti per effettuare un pagamento, chiama canMakePayment() prima di invocare la procedura di pagamento. La chiamata canMakePayment() restituisce true se il browser supporta almeno un metodo di pagamento specificato nell'oggetto.

request.canMakePayment().then(result => {
  if (result) {
    // This browser supports the specified payment method.
  } else {
    // This browser does NOT support the specified payment method.
  }
}).catch(e => {
  // An exception
});

Scopri di più su PaymentRequest.canMakePayment() su MDN

Il metodo show()

Dopo aver impostato i due parametri e aver creato l'oggetto request come mostrato sopra, puoi chiamare il metodo show(), che mostra l'interfaccia utente dell'app di pagamento.

request.show().then(response => {
  // [process payment]
  // send to a PSP etc.
  response.complete('success');
});

L'aspetto dell'interfaccia utente dell'app di pagamento dipende completamente dal fornitore dell'app di pagamento. Dopo che il cliente accetta di effettuare un pagamento, al commerciante viene passato un oggetto JSON contenente tutte le informazioni richieste per il trasferimento di denaro. Il commerciante può quindi inviarla al PSP per l'elaborazione del pagamento.

Infine, puoi chiudere l'interfaccia utente della richiesta di pagamento completando la procedura con response.complete('success') o response.complete('fail'), a seconda del risultato restituito dalla PSP.

A seguire

Scopri di più su Web Payments.