Saiba como a API Payment Request funciona em alto nível.
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. Para fazer isso de maneira fácil e rápida, use a API Payment Request (PR API).
Estrutura básica
A criação de um objeto PaymentRequest
requer dois parâmetros: formas
de pagamento e detalhes de pagamento. Além disso, um terceiro parâmetro payment options é opcional. Uma solicitação básica poderia ser criada assim:
const request = new PaymentRequest(paymentMethods, paymentDetails);
Vamos conferir 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 da matriz. Cada elemento na matriz é composto por 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 do 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.
No exemplo abaixo, a lista de itens comprados opcionais (neste caso, apenas um item) é mostrada, assim como o valor total devido 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
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. Chamar
canMakePayment()
retornará true
se o navegador oferecer suporte a 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
, conforme 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 do app de pagamento. Depois que o cliente concorda em fazer um pagamento, um objeto JSON é transmitido ao comerciante com todas as informações necessárias para transferir o dinheiro. O comerciante pode então enviá-lo ao PSP para processar o pagamento.
Por fim, você pode fechar a interface de solicitação de pagamento concluindo o processo com
response.complete('success')
ou response.complete('fail')
, dependendo do
resultado que o PSP retorna.
A seguir
Saiba mais sobre pagamentos na Web.