Webhook
Visão geral
A integração via Webhook da Wiapy permite que você receba notificações em tempo real sempre que uma compra é realizada. Ao configurar a URL de destino, nossa plataforma fará uma requisição HTTP POST enviando um payload em formato JSON contendo informações da transação.
Autenticação
O token que você cadastrar será enviado como um header Authorization
em cada requisição.
Exemplo de Payload Enviado
Observação: Todos os valores financeiros estão representados em centavos.
Detalhamento dos Campos
payment.status
payment.status
paid
Pagamento aprovado
unpaid
Não pago / Aguardando Pagamento (o pix / boleto ao ser criado ele é gerado com esse status
credit_card_declined
Cartão de crédito recusado
refunded
Pagamento estornado
chargedback
Pagamento sofreu chargeback
payment.payment_method
payment.payment_method
pix
Método de pagamento escolhido foi o pix
credit_card
Método de pagamento escolhido foi o cartão de crédito
boleto
Método de pagamento escolhido foi o boleto
payment.type
payment.type
payment
Pagamento avulso (objeto subscription
vazio {}
)
subscription
Assinatura recorrente (objeto subscription
preenchido)
Estrutura de subscription
(se aplicável)
subscription
(se aplicável)Quando o pagamento for uma assinatura, o campo subscription
será preenchido com:
Estrutura de products
products
O array products
lista todos os produtos liberados no checkout, inclusive orderbumps adquiridos.
products.type
products.type
E-book
É quando o produto cadastrado é do tipo ebook, em itens enviamos os arquivos com nome e url.
Curso Online
É quando o acesso é um curso com vídeos para assistir pela área de membros.
Mentoria
É quando a entrega é uma mentoria e pode haver arquivos na área de membros.
Externo
É quando o acesso é liberado externo e não exige nenhuma intereção da Wiapy.
Considerações Técnicas
Requisições são enviadas via POST.
Formato dos dados:
application/json
.Header de Autenticação:
Authorization: seu_token
.Valores monetários sempre em centavos (ex: R$ 17,70 →
1770
).
Last updated