WebHooks & Notificações
Atualizações de status de forma assíncrona
Webhooks (também conhecidos como HTTP Callbacks) são uma forma de se registrar para receber informações úteis em uma URL específica de sua escolha.
Quando ocorre uma alteração no estado de um recurso dentro das plataformas da IOPAY (por exemplo, uma transação é aprovada com sucesso), um evento é gerado por essa ocorrência e imediatamente enviamos uma request do tipo POST para as URL cadastrada na sua conta digital. Estes disparos automáticos são para informar a criação ou alteração de uma transação de pagamento processada com IOPAY.
Para utilizar a notificação de eventos você precisa: - Implementar o seu sistema de recebimento de notificações - Cadastrar as URLs desse sistema na IOPAY, através da sua conta digital IO. - Quando ocorrer uma ação ou atualização de status nas transações enviadas para a IO, as notificações serão disparadas de acordo com os webhooks cadastrados
Parâmetros recebidos por WebHook
Parâmetro | Exemplo | Descrição |
id | 75f9451f3bcd49ab9710bfa7026e4a62 | ID da transação que esta sendo informada |
reference_id | 321 | ID da sua aplicação (o mesmo reference_id enviado na integração, que reflete o id do pedido na sua aplicação) |
Exemplo de Request da IOPAY para a sua Aplicação
application/json
POST
Como usar a atualização por eventos e WebHooks da IO
O evento é disparado à partir da estrutura da IO para o sua aplicação, fornecendo os três parâmetros acima. Você deverá receber esse evento e realizar uma chamada para obtenção da atualização da transação. Ou seja, a IO avisa a sua aplicação, através do WebHook que houve alteração para determinada transação (id) e sua aplicação deve acessar a endpoint específica para obter detalhes de uma transação (com o id recebido), para então checar a mudança de status ocorrida.
Para obter detalhes de uma transação pelo id da mesma, utilize a endpoint "Recupera uma transação"
Erros no disparo de eventos
O evento é disparado e caso encontre falha na execução do request ou falha no status code da sua aplicação (status code diferente de 200), o webbook fará mais 3 tentativas, com intervalo de tempo entre elas.
URL Custom
Para determinar para qual URL a IOPAY deve direcionar os eventos, acesse a Conta Digital e navegue no menu principal até a opção:
Configurações > Transações Online
Desça até a porcão destacada na imagem abaixo abaixo:
Basta Informar a URL da aplicação para qual a IOPAY fará disparos de notificação no campo "URL de notificação (HTTPS)" e clicar no botão Salvar Alterações.
Exemplo https://minhaloja.com.br/loja/ReceivePaymentStatusChange
Apenas URL´s com protocolo seguro HTTPS são permitidas
Last updated
