Somente quando necessário
A gorjeta no recibo é mais difícil de implementar e está sujeita a condições. Apenas implemente isso se for absolutamente necessário em sua situação.
Consulte Gorjeta para mais alternativas.
Aqui descrevemos como implementar a gorjeta no seu fluxo de pagamento, onde o cliente apresenta seu cartão pela primeira vez e fornece um PIN ou assinatura e, em seguida, escreve um valor de gorjeta no recibo e os assina. Isso significa que inicialmente o valor da transação é autorizado, mas o valor da gorjeta não é
Para aceitar a gorjeta dessa maneira e obter o valor total da sua conta, você precisa implementar a pré-autorização :
- Faça uma solicitação de pré-autorização.
- Se a gorjeta adicionar mais de 20% à quantidade original, ajuste a autorização aumentando a quantidade autorizada com a quantidade da gorjeta.
- Capture o pagamento do valor final.
Observe que esta opção de gorjeta está sujeita a condições.
O ajuste de um valor pré-autorizado é suportado apenas para cartões de crédito American Express, Discover, Mastercard e Visa.
Antes de começar
Antes de implementar a gorjeta, certifique-se de:
- Ler e entender nossos fundamentos da API de terminais.
- Criar uma integração capaz de efetuar um pagamento.
- Implementar o processo de pré-autorização.
- Configurar as notificações do webhook.
Mantenha sua equipe informada utilizando webhooks
Enquanto seu cliente estiver interagindo com o terminal, você poderá apresentar mensagens de progresso em sua caixa registradora. Isso pode manter sua equipe informada sobre o valor da gorjeta.
Essas mensagens são entregues usando notificações de exibição, que são webhooks enviadas para um terminal especificado por você. Para obter informações sobre como configurar e usar as notificações de exibição, consulte nossa documentação de notificações de exibição.
Etapa 1: Pré-autorizar o pagamento
Iniciar pagamento:
-
Faça uma solicitação POST para um endpoint da API do terminais, especificando um corpo
PaymentRequest
que contenha:SaleData.SaleToAcquirerData
: authorisationType=PreAuth indica que esta é uma solicitação de pré-autorização.
Para mais detalhes sobre solicitação e resposta, consulte Pré-autorização.
-
Quando você receber a resposta de pré-autorização:
- Armazene o arquivo
pspReference
daAdditionalResponse
para uso posterior ao ajustar a autorização ou ao capturar o pagamento. -
o Se você estiver usando o ajuste de autorização síncrona, também use o URL para decodificar o blob
adjustAuthorisationData
e o armazene.
- Armazene o arquivo
-
Verifique se o cliente adicionou uma gorjeta.
-
Se o cliente não adicionou uma gorjeta, continue na Etapa 3: Capturar o pagamento.
-
-
Se o cliente adicionou uma gorjeta, calcule a porcentagem da gorjeta usando os seguintes valores da
AdditionalResponse
:posadditionalamounts.originalAmountValue
eposAmountGratuityValue
. TEstes são o valor original e o valor da gorjeta minor units.-
Se a gorjeta adicionar menos de 20% ao valor original, continue na Etapa 3: Capturar o pagamento.
-
Se a gorjeta adicionar mais de 20% à quantidade original, continue na Etapa 2: Ajuste a autorização.
-
Etapa 2 (opcional): Ajuste a pré-autorização
If the tip adds more than 20% to the original amount, increase the authorized amount:
Etapa 3: Capturar o pagamento
Para garantir que o valor original mais o valor da gorjeta sejam liquidados em sua conta, você precisa capturar o pagamento manualmente:
-
Faça uma solicitação POST para o endpoint do /payments/{paymentPspReference}/captures , especificando:
paymentPspReference
: ApspReference
da pré-autorização original.amount
: Acurrency
e ovalue
valor final em in minor units. Esta é a soma do valor pré-autorizado e da gorjeta.merchantAccount
: O nome da sua merchant account usada para processar o pagamento.
Para mais detalhes sobre solicitação e resposta, consulte Pre-autorização.
-
Certifique-se de receber a notificação assíncrona. Isso informa se o valor final foi capturado.
Condições para gorjeta com pré-autorização
Em alguns países (EUA, Cingapura e Hong Kong), uma prática comum é que o cliente assine o valor da gorjeta no recibo depois de apresentar seu cartão e concluir o pagamento original. Se você deseja seguir esta prática, leve em consideração que:
-
A gorjeta com pré-autorização é permitida nos seguintes setores:
MCC Descrição 4121 Táxis e limusines 5812 Restaurantes 5813 Bares, Tabernas, Casas Noturnas, Salões de Coquetéis e Discotecas 5814 Restaurantes fast food 7230 Salões de beleza e Barbearias 7298 Spas de saúde e beleza -
As bandeiras exigem um ajuste de autorização se a gorjeta for superior a 20% da quantidade autorizada original. Se o emissor recusar esta autorização adicional, você poderá receber um estorno pela parte do valor final que estiver acima do valor original mais 20%.
-
Você precisará capturar manualmente o pagamento.
-
O fluxo é suportado apenas nos cartões de crédito American Express, Discover, Mastercard e Visa. Não é suportado para carteiras digitais e cartões de débito.