Receba notificações no endpoint HTTPS do comerciante. São callbacks enviados à sua aplicação, não pedidos que envia ao gateway.
Receber Webhook de Pagamento PPR
Endpoint de Callback do Comerciante
O endpoint de callback é um URL HTTPS hospedado pelo comerciante e fornecido à equipa de desenvolvimento da IZI Pay durante a configuração. Este é o endpoint para onde a IZI Pay envia atualizações de estado do pagamento e notificações.
Juntamente com o URL de callback, o comerciante também deve fornecer um Access-Key. A IZI Pay inclui esta chave nos cabeçalhos de todos os pedidos de callback para que o comerciante possa autenticar e validar as notificações recebidas.
O comerciante é responsável por garantir que o endpoint de callback está publicamente acessível e é capaz de receber e processar pedidos da IZI Pay.
Este callback aplica-se a referências PPR criadas através da API atual.
Resumo
Durante o onboarding, o comerciante deve fornecer os seguintes dados à equipa de desenvolvimento da IZI Pay:
- Callback URL: O endpoint HTTPS para onde a IZI Pay enviará notificações de estado do pagamento.
- Access-Key: Um valor secreto escolhido e fornecido pelo comerciante. A IZI Pay inclui este valor nos cabeçalhos de todos os pedidos de callback, permitindo ao comerciante verificar que a notificação teve origem na IZI Pay.
Headers
Access-KeyChave de acesso escolhida ou gerada pelo comerciante para este webhook. A IZI Pay envia este mesmo valor no cabeçalho Access-Key para que o seu endpoint possa autenticar a notificação.
Receber Webhook de Pagamento PPR › Request Body
idTransacaoIdentificador da transação.
numLogSistemaNúmero de log do sistema associado à notificação de pagamento.
idLogSistemaIdentificador de período/log do sistema.
dataTransaccaoClienteData e hora em que o pagamento do cliente foi registado.
montantePagoMontante pago pelo cliente.
tipoTerminalTipo de terminal usado no pagamento.
iIdentTerminalIdentificador do terminal.
localidadeTerminalLocalidade do terminal.
refPagamentoReferência de pagamento paga pelo cliente.
IdIdentificador único da notificação. Use este valor para idempotência.
nibNIB da conta debitada, quando disponível.
bancoNome do banco, quando disponível.
Receber Webhook de Pagamento PPR › Responses
Devolva HTTP 2xx com Success: true quando a notificação for processada com sucesso ou já tiver sido processada antes.
SuccessDevolva true quando a notificação for processada com sucesso ou já tiver sido processada antes.
ObsNota curta sobre o processamento.
IdIdentificador interno do pagamento no sistema do comerciante.
Receber Webhook de Pagamento QR Code
Endpoint de Callback do Comerciante
O endpoint de callback é um URL HTTPS hospedado pelo comerciante e fornecido à equipa de desenvolvimento da IZI Pay durante a configuração. Este é o endpoint para onde a IZI Pay envia atualizações de estado do pagamento e notificações.
Juntamente com o URL de callback, o comerciante também deve fornecer um Access-Key. A IZI Pay inclui esta chave nos cabeçalhos de todos os pedidos de callback para que o comerciante possa autenticar e validar as notificações recebidas.
O comerciante é responsável por garantir que o endpoint de callback está publicamente acessível e é capaz de receber e processar pedidos da IZI Pay.
Este callback aplica-se a pagamentos GPO QR Code criados através da API de Pagamentos.
Resumo
Durante o onboarding, o comerciante deve fornecer os seguintes dados à equipa de desenvolvimento da IZI Pay:
- Callback URL: O endpoint HTTPS para onde a IZI Pay enviará notificações de estado do pagamento.
- Access-Key: Um valor secreto escolhido e fornecido pelo comerciante. A IZI Pay inclui este valor nos cabeçalhos de todos os pedidos de callback, permitindo ao comerciante verificar que a notificação teve origem na IZI Pay.
Headers
Access-KeyChave de acesso escolhida ou gerada pelo comerciante para este webhook. A IZI Pay envia este mesmo valor no cabeçalho Access-Key para que o seu endpoint possa autenticar a notificação.
Receber Webhook de Pagamento QR Code › Request Body
creationDateData e hora em que a transação QR Code foi criada.
updatedDateData e hora em que o estado da transação QR Code foi atualizado.
idIdentificador único da transação no provedor. Use este valor para idempotência.
amountMontante pago pelo cliente.
clearingPeriodPeríodo de compensação associado à transação.
transactionNumberNúmero da transação no provedor.
statusEstado do pagamento QR Code.
transactionTypeTipo da transação.
orderOriginOrigem da ordem de pagamento.
currencyMoeda do pagamento.
merchantReferenceNumberNúmero de referência do comerciante associado ao pagamento QR Code.
Receber Webhook de Pagamento QR Code › Responses
Devolva HTTP 2xx com Success: true quando a notificação for processada com sucesso ou já tiver sido processada antes.
SuccessDevolva true quando a notificação for processada com sucesso ou já tiver sido processada antes.
ObsNota curta sobre o processamento.
IdIdentificador interno do pagamento no sistema do comerciante.