Como a API Payment Request funciona

Saiba como a API Payment Request funciona de forma detalhada.

Eiji Kitamura

API Payment Request

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

Estrutura básica

Criar um objeto PaymentRequest requer dois parâmetros: formas de pagamento e detalhes de pagamento. Além disso, um terceiro parâmetro de opções de pagamento é opcional. Uma solicitação básica poderia ser criada assim:

const request = new PaymentRequest(paymentMethods, paymentDetails);

Vejamos como cada parâmetro é criado e usado.

Formas de pagamento

O primeiro parâmetro, paymentMethods, é uma lista de formas de pagamento compatíveis 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 da 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 de pagamento da transação. Ele contém o valor obrigatório total, que especifica o valor total devido do cliente. Esse parâmetro também pode listar opcionalmente os itens comprados.

No exemplo abaixo, é mostrada a lista de itens comprados opcionais (neste caso, apenas um item), assim como o valor total devido. 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' }
  }
};

Conferir se a forma de pagamento está disponível

Antes de invocar o procedimento de pagamento, o comerciante pode verificar se o usuário e o ambiente estão prontos para fazer um pagamento.

Chamar canMakePayment() verifica se o navegador é compatível com pelo menos uma forma de pagamento especificada 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.

Método show()

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

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. Depois que o cliente concorda em fazer um pagamento, um objeto JSON é enviado ao comerciante com todas as informações necessárias para a transferência de dinheiro. Então, o comerciante pode enviá-lo ao PSP para processar o pagamento.

Por fim, é possível fechar a interface 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.