Ativar ações com webhooks
Como usar webhooks para responder a eventos de pagamento offline.
Um webhook é um endpoint HTTP que recebe eventos da Stripe.
Com os webhooks, você pode ser notificado sobre eventos de pagamentos que ocorrem fora do fluxo de pagamento, como:
- Pagamentos bem-sucedidos (
payment_
)intent. succeeded - Pagamentos contestados (
charge.
)dispute. created - Saldo disponível na sua conta Stripe (
balance.
)available
Você pode usar o Dashboard para ações avulsas, como reembolsar um pagamento ou atualizar os dados de um cliente. Os webhooks ajudam a ampliar a integração dos pagamentos e processar grandes volumes de eventos cruciais para os negócios.
Crie seu próprio webhook
Você pode criar um gerenciador de webhooks em seu próprio servidor para gerenciar todos os fluxos de pagamentos offline. Comece expondo um endpoint que receba solicitações da Stripe e use a CLI para testar localmente sua integração. Cada solicitação da Stripe contém um objeto Event com uma referência ao objeto na Stripe que foi modificado.
Crie um endpoint de webhook
Adicione um novo endpoint no aplicativo. É possível agir em determinados eventos verificando o campo type
do objeto de evento enviado no corpo da solicitação. Em seguida, você pode imprimir na saída padrão para confirmar o funcionamento do webhook.
Inicie o servidor após adicionar o novo endpoint.
Instale e configure a CLI da Stripe
For additional install options, see Get started with the Stripe CLI.
Depois de instalar a CLI da Stripe, execute stripe login
na linha de comando para gerar um código de emparelhamento para vincular à sua conta Stripe. Pressione Enter para iniciar o navegador e faça login na sua conta Stripe para permitir o acesso. A chave de API gerada é válida por 90 dias, podendo ser modificada ou excluída em Chaves de API no Dashboard.
Observação
Você pode criar uma configuração específica para o projeto, incluindo o sinalizador –project-name quando fizer login e executar comandos para esse projeto.
Teste
stripe login Your pairing code is: humour-nifty-finer-magic Press Enter to open up the browser (^C to quit)
Se quiser usar uma chave de API existente, use o sinalizador --api-key
:
stripe login --api-key
Your pairing code is: humour-nifty-finer-magic Press Enter to open up the browser (^C to quit)sk_test_4eC39HqLyjWDarjtT1zdp7dc
Teste o webhook localmente
Use a CLI para encaminhar eventos ao endpoint do webhook local usando o comando listen
.
Supondo que o aplicativo está usando a porta 4242, execute:
stripe listen --forward-to http://localhost:4242/webhook
Em uma guia de terminal diferente, use o comando da CLI trigger
para acionar um evento de webhook simulado.
stripe trigger payment_intent.succeeded
O seguinte evento aparece na sua guia listen
:
[200 POST] OK payment_intent.succeeded
“O PaymentIntent foi bem-sucedido” aparece na guia do terminal em que o servidor está executando.
Implante o endpoint do webhook
Quando estiver pronto para implantar o endpoint do webhook em produção, você precisa fazer o seguinte:
Use suas chaves de API do modo de produção, e não as do modo de teste.
Configure o endpoint do webhook no Stripe Dashboard ou usando a API.
Para configurar o endpoint no Dashboard, acesse as configurações do webhook.
Clique em Adicionar endpoint e informe o URL do endpoint, a versão da API da Stripe e os eventos específicos que você quer receber da Stripe.
Substitua o segredo do endpoint do webhook no aplicativo com o novo segredo mostrado na visualização do endpoint no Dashboard.
Seu aplicativo está pronto para aceitar eventos de produção. Para obter mais informações sobre a configuração do seu endpoint de webhook, consulte a API Webhook Endpoint. Para testar no modo de teste, consulte o Guia de desenvolvimento.