Bem-vindo à documentação Pagar.me

Aqui você vai encontrar guias e exemplos para te ajudar
a integrar com a melhor API de Pagamentos do Brasil!

Começar

Você também pode buscar ou navegar pelas categorias

O que são?

Os Webhooks são as notificações que enviamos para você sempre que um evento ocorre.

A cada atualização, o sistema envia um HTTP POST para a URL configurada no webhook, com todas as informações relevantes sobre cobranças, pedidos, assinaturas, entre outros. Desta maneira, o seu sistema, ao receber essa notificação, pode executar os próximos passos.

Você tem total liberdade para escolher sobre quais eventos quer ser notificado e para qual URL cada webhook será enviado.

📘

Contornando falhas no recebimento dos webhooks

Pensando na possibilidade do seu serviço, por qualquer motivo, não conseguir receber o webhook, criamos uma configuração pela qual você pode definir quantas vezes iremos reenviá-lo em caso de falha no recebimento.

De qualquer forma, nossa API também tem um endpoint pelo qual você pode consultar quais webhooks falharam, e forçar os seus envios manualmente.

Eventos disponíveis

Temos uma lista de eventos importantes que podem ocorrer na nossa API. Veja abaixo!

Evento

Descrição

customer.created

Ocorre sempre que um comprador é criado

customer.updated

Ocorre sempre que um comprador é atualizado

card.created

Ocorre sempre que um cartão é criado

card.updated

Ocorre sempre que um cartão é atualizado

card.deleted

Ocorre sempre que um cartão é deletado

address.created

Ocorre sempre que um endereço é criado

address.updated

Ocorre sempre que um endereço é atualizado

address.deleted

Ocorre sempre que um endereço é deletado

plan.created

Ocorre sempre que um plano é criado

plan.updated

Ocorre sempre que um plano é atualizado

plan.deleted

Ocorre sempre que um plano é deletado

planitem.created

Ocorre sempre que um item de plano é criado

planitem.updated

Ocorre sempre que um item de plano é atualizado

planitem.deleted

Ocorre sempre que um item de plano é deletado

subscription.created

Ocorre sempre que uma assinatura é criada

subscription.updated

Ocorre sempre que uma assinatura é atualizada

subscription.canceled

Ocorre sempre que uma assinatura é cancelada

subscriptionitem.created

Ocorre sempre que um item de assinatura é criado

subscriptionitem.updated

Ocorre sempre que um item de assinatura é atualizado

subscriptionitem.deleted

Ocorre sempre que um item de assinatura é deletado

discount.created

Ocorre sempre que um desconto é criado

discount.deleted

Ocorre sempre que um desconto é deletado

order.paid

Ocorre sempre que um pedido é pago

order.payment_failed

Ocorre sempre que o pagamento de um pedido falha

order.create

Ocorre sempre que um pedido é criado

order.canceled

Ocorre sempre que um pedido é cancelado

invoice.created

Ocorre sempre que uma fatura é criada

invoice.paid

Ocorre sempre que uma fatura é paga

invoice.payment_failed

Ocorre sempre que o pagamento de uma fatura falha

invoice.canceled

Ocorre sempre que uma fatura é cancelada

charge.paid

Ocorre sempre que uma cobrança é paga

charge.payment_failed

Ocorre sempre que o pagamento de uma cobrança falha

charge.pending

Ocorre sempre que o pagamento de uma cobrança estiver pendente

charge.refunded

Ocorre sempre que uma cobrança é estornada

Saiba mais sobre os Webhooks através de nossa API Reference!

Updated 22 days ago


O que são?


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.