Visão geral da API Payment Request

Eiji Kitamura

Quando um cliente tenta comprar algo no seu site, ele precisa pedir que o cliente forneça informações de pagamento e, opcionalmente, outras informações como preferência de frete. Você pode fazer isso rapidamente usando a API Payment Request (PR API).

Estrutura básica de pagamento

Para construir um objeto PaymentRequest, são necessários dois parâmetros: métodos de pagamento e detalhes do pagamento. Além disso, um terceiro parâmetro payment options (opções de pagamento) é opcional. Uma solicitação básica pode ser criada assim:

const request = new PaymentRequest(paymentMethods, paymentDetails);

Confira como cada parâmetro é criado e usado.

Formas de pagamento

O primeiro parâmetro, paymentMethods, é uma lista de formas de pagamento aceitas em uma variável de matriz. Cada elemento na matriz compreende dois componentes: supportedMethods e, opcionalmente, data.

Para supportedMethods, o comerciante precisa especificar um identificador de forma de pagamento, como https://bobbucks.dev/pay. A existência e o conteúdo de data dependem do conteúdo de supportedMethods e do design do provedor do app de pagamento.

As duas informações precisam ser fornecidas pelo provedor do app de pagamento.

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

Detalhes de pagamento

O segundo parâmetro, paymentDetails, é transmitido como um objeto e especifica os detalhes do pagamento para a transação. Ele contém o valor obrigatório total, que especifica o valor total devido pelo cliente. Esse parâmetro também pode listar os itens comprados, se quiser.

No exemplo a seguir, a lista opcional de itens comprados (apenas um item, neste caso) é mostrada, assim como o valor total devido obrigatório. Em ambos os casos, a unidade monetária é especificada com cada valor individual.

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

Verificar se a forma de pagamento está disponível

O Chrome verifica se o usuário e o ambiente estão prontos para fazer pagamentos durante a construção de um objeto PaymentRequest.

Para verificar se o usuário e o ambiente estão prontos para fazer um pagamento, chame canMakePayment() antes de invocar o procedimento de pagamento. A chamada de canMakePayment() retorna true se o navegador for compatível com pelo menos um método de pagamento especificado no objeto.

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

Saiba mais sobre PaymentRequest.canMakePayment() no MDN

O método show()

Depois de definir os dois parâmetros e criar o objeto request, você pode chamar o método show(), que mostra a interface do usuário do app de pagamentos.

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

A aparência da interface do usuário do app de pagamento depende totalmente do provedor do app. Depois que o cliente concorda em fazer um pagamento, um objeto JSON é transmitido ao comerciante, que contém todas as informações necessárias para transferir dinheiro. Em seguida, o comerciante pode enviar o token ao PSP para processar o pagamento.

Por fim, feche a interface do usuário da Solicitação de pagamento concluindo o processo com response.complete('success') ou response.complete('fail'), dependendo do resultado retornado pelo PSP.

A seguir

Saiba mais sobre os pagamentos na Web.