Webhook e notificações
Um webhook é uma comunicação leve e orientada por eventos que permite que um aplicativo notifique automaticamente outro via HTTP, evitando a busca constante de atualizações e permitindo a troca e integração de dados em tempo real. Para implementar um webhook, o cliente fornece uma URL exclusiva para a API do servidor e especifica qual evento ele deseja conhecer.
Para configurar as notificações do GetNet via webhook, você deve indicar 4 URLs no momento do seu credenciamento na Plataforma Digital. Cada um será destinado a receber notificações diferentes dos seguintes tipos:
- Transações de crédito,
- Transações de débito,
- transações de boleto bancário (boleto),
- Transações recorrentes (assinatura)
Depois que o webhook estiver configurado, o GetNet enviará automaticamente os dados relevantes para cada URL quando o evento especificado ocorrer. Em caso de erro, as informações serão reenviadas a cada 15 minutos até 4 vezes.
Sempre recomendamos ficar de olho na data de validade do certificado para cada URL. Em caso de renovação ou se você precisar modificar qualquer uma das URLs originalmente declaradas, entre em contato com nossa equipe de suporte de integração da GetNet.
Estrutura de notificações
Em termos gerais, as solicitações HTTP têm a seguinte estrutura:
https://YOUR_HOST_EXAMPLE/YOUR_SERVICE_EXAMPLE?query_param_1=valueExample1&query_param_2=valueExample2
Onde:
https://YOUR_HOST/YOUR_SERVICEse refere a um dos 4 URLs declarados anteriormente.?indica o início da seção de consulta.query_param_1=valueExample1é um exemplo de parâmetro de consulta.&é usado como um conector entre vários parâmetros de consulta.
O Notificações HTTP GET fornecido pelo GetNet incluirá um conjunto específico de parâmetros de consulta, alguns dos quais são compartilhados entre diferentes eventos de gatilho, enquanto outros são exclusivos e específicos para um único evento de gatilho.
Notificações de crédito
Parâmetro de consulta compartilhado para todos os eventos Abaixo, você encontrará a lista dos parâmetros de consulta compartilhados em todos os eventos relacionados às transações com cartão de crédito: Aprovado, Autorizado, Pendente, Confirmado, Cancelado, Negado e Erro.
| Parâmetros de consulta | Descrição |
|---|---|
| tipo_de_pagamento | (único valor possível:) crédito |
| ID do cliente | (código de identificação do cliente) |
| id_do_pedido | (número do pedido) |
| id_do_pagamento | (ID da transação no formato UUIDv4) |
| montante | (valor da transação) |
| status | (valores possíveis dependendo do tipo de evento de transação:) APROVADO AUTORIZADO PENDENTE CONFIRMADO CANCELADO NEGADO ERRO |
| número_parcelas | (número de parcelas) |
| terminal_nsu | (código de autorização gerado pelo emissor quando uma transação é realizada com sucesso) |
| código_de_autorização | (código de autorização gerado pelo sistema de comércio eletrônico GetNet) |
Abaixo, você encontrará os parâmetros de consulta adicionais para cada evento específico.
Parâmetros adicionais para Aprovado, Autorizado, e Pendente eventos de transação
| Parâmetros de consulta | Descrição |
|---|---|
| id da transação do adquirente | (código de transação do comprador) |
| timestamp de autorização | (data e hora da autorização) |
| marca | (marca do cartão) |
Parâmetros adicionais para Cancelado eventos de transação
| Parâmetros de consulta | Descrição |
|---|---|
| id da transação do adquirente | (código de transação do comprador) |
Parâmetros adicionais para Negado e eventos de transação com erro
| Parâmetros de consulta | Descrição |
|---|---|
| id da transação do adquirente | (código de transação do comprador) |
| detalhe_descrição | (descrição do erro ocorrido durante a transação) |
| código_de_erro | (código numérico negado ou com erro) |
Notificações de débito
Parâmetro de consulta compartilhado para todos os eventos
Abaixo, você encontrará a lista dos parâmetros de consulta compartilhados em todos os eventos relacionados às transações com cartão de débito: Aprovado, Negado e Erro.
| Parâmetros de consulta | Descrição |
|---|---|
| tipo_de_pagamento | (único valor possível:) débito |
| ID do cliente | (código de identificação do cliente) |
| id_do_pedido | (número do pedido) |
| id_do_pagamento | (ID da transação no formato UUIDv4) |
| montante | (valor da transação) |
| status | (valores possíveis dependendo do tipo de evento de transação:) APROVADO NEGADO ERRO |
| marca | (marca do cartão) |
Abaixo, você encontrará os parâmetros de consulta adicionais para cada evento específico.
Parâmetros adicionais para Aprovado eventos de transação
| Parâmetros de consulta | Descrição |
|---|---|
| id da transação do adquirente | (código de transação do comprador) |
| timestamp de autorização | (data e hora da autorização) |
| terminal_nsu | (código de autorização gerado pelo emissor quando uma transação é realizada com sucesso) |
| código_de_autorização | (código de autorização gerado pelo sistema de comércio eletrônico GetNet) |
Parâmetros adicionais para Negado e Erro eventos de transação
| Parâmetros de consulta | Descrição |
|---|---|
| detalhe_descrição | (descrição do erro ocorrido durante a transação) |
| código_de_erro | (código numérico negado ou com erro) |
Notificações de boleto bancário (Boleto)
No caso de uma notificação de boleto bancário, ela será enviada em duas etapas. Na primeira etapa, uma notificação é enviada quando o cadastro do boleto bancário é finalizado e, na segunda etapa, uma notificação é enviada quando o boleto é baixado. O serviço permanece o mesmo; no entanto, os campos de resposta serão diferentes entre os dois estágios.
Primeira etapa
Parâmetro de consulta compartilhado para todos os eventos Abaixo, você encontrará a lista dos parâmetros de consulta compartilhados em todos os eventos relacionados às ações do primeiro estágio: Pendente, Negado e Erro.
| Parâmetros de consulta | Descrição |
|---|---|
| tipo_de_pagamento | (único valor possível:) boleto |
| id_do_pedido | (número do pedido) |
| id_do_pagamento | (identificador de pagamento) |
| montante | (valor do boleto bancário) |
| status | (valores possíveis dependendo do tipo de evento de transação:) PENDENTE NEGADO ERRO |
| banco | (código bancário do emissor do boleto bancário. O único valor possível é Banco Santander) |
| nosso_número | (nosso número. Se você não declarar, ele será gerado pelo banco emissor) |
| typefull_line | (linha digitada no boleto bancário devolvido pelo banco emissor) |
| data_de_emissão | (Data de emissão, formato: DDMMYYYY) |
| data_de_expiração | (Data de validade, formato: DDMMYYYY) |
Abaixo, você encontrará os parâmetros de consulta adicionais para cada evento específico.
Parâmetros adicionais para Negado e Erro eventos de transação
| Parâmetros de consulta | Descrição |
|---|---|
| id | (identificador do boleto bancário, formato: UUIDv4. É usado para identificar o boleto bancário para a notificação de download) |
| detalhe_descrição | (descrição do erro ocorrido durante a transação) |
| código_de_erro | (código numérico negado ou com erro) |
Segunda etapa
Parâmetro de consulta compartilhado para todos os eventos Abaixo, você encontrará a lista dos parâmetros de consulta compartilhados em todos os eventos relacionados às ações do segundo estágio: Pago e Cancelado.
| Parâmetros de consulta | Descrição |
|---|---|
| id | (identificador do boleto bancário, formato: UUIDv4. É usado para identificar o boleto bancário para a notificação de download) |
| montante | (valor do boleto bancário) |
| status | (valores possíveis dependendo do tipo de evento de transação:) PAGO CANCELADO |
| data_de_pagamento | (Data em que seu cliente paga o boleto bancário, formato: DDMMYYYY) |
Notificações de transações recorrentes (assinatura)
Parâmetro de consulta compartilhado para todos os eventos Abaixo, você encontrará a lista dos parâmetros de consulta compartilhados em todos os eventos relacionados às transações recorrentes: Autorizado, Aprovado, Confirmado, Cancelado, Negado e Erro.
| Parâmetros de consulta | Descrição |
|---|---|
| tipo_de_pagamento | (único valor possível:) crédito |
| ID do cliente | (código de identificação do cliente) |
| id_do_pedido | (número do pedido) |
| id_do_pagamento | (ID da transação no formato UUIDv4) |
| montante | (valor da transação) |
| status | (valores possíveis dependendo do tipo de evento de transação:) AUTORIZADO APROVADO CONFIRMADO CANCELADO NEGADO ERRO |
| timestamp de autorização | (data e hora da autorização) |
| id da transação do adquirente | (código de transação do comprador) |
| ID da assinatura | (identificador de assinatura, formato: UUIDv4) |
| ID do plano | (identificador do plano usado na assinatura, formato: UUIDv4) |
| ID de cobrança | (identificador de cobrança, formato: UUIDv4) |
| número_parcelas | (número de parcelas) |
| número_de_cobrança | (número de parcelas processadas) |
| marca | (marca do cartão) |
| terminal_nsu | (código de autorização gerado pelo emissor quando uma transação é realizada com sucesso) |
| código_de_autorização | (código de autorização gerado pelo sistema de comércio eletrônico GetNet) |
| número_de_tentativa | (número de tentativas repetidas) |
Abaixo, você encontrará os parâmetros de consulta adicionais para cada evento específico.
Parâmetros adicionais para Negado e Erro eventos de transação
| Parâmetros de consulta | Descrição |
|---|---|
| detalhe_descrição | (descrição do erro ocorrido durante a transação) |
| código_de_erro | (código numérico negado ou com erro) |
Notificações de método de pagamento alternativo (PIX)
Parâmetro de consulta compartilhado para todos os eventos
Abaixo, você encontrará a lista dos parâmetros de consulta compartilhados em todos os eventos relacionados às transações do PIX: Aprovado, Negado e Erro.
| Parâmetros de consulta | Descrição |
|---|---|
| tipo_de_pagamento | (único valor possível:) foto |
| ID do cliente | (código de identificação do cliente) |
| id_do_pedido | (número do pedido) |
| id_do_pagamento | (ID da transação no formato UUIDv4) |
| montante | (valor da transação) |
| status | (valores possíveis dependendo do tipo de evento de transação:) APROVADO NEGADO ERRO |
| ID da transação | (identificador da transação na instituição PSP após a geração do QR Code) |
| carimbo de data e hora da transação | (Data e hora da transação PIX, formato: ISO) |
| terminal_nsu | (código de autorização gerado pelo emissor quando uma transação é realizada com sucesso) |
Abaixo, você encontrará os parâmetros de consulta adicionais para cada evento específico.
Parâmetros adicionais para Aprovado eventos de transação
| Parâmetros de consulta | Descrição |
|---|---|
| nome_do_psp_pagador | Nome da instituição PSP do pagador |
| payer_psp_code | Código da instituição PSP do pagador |
| nome_do_pagador | Nome do pagador |
| pagador_cnpj | Número do CNPJ do pagador da pessoa jurídica |
| pagador_cpf | Número do CPF do pagador para pessoas físicas |
| nome_do_psp_receptor | Nome da instituição PSP do receptor |
| código_psp_receptor | Código da instituição PSP do receptor |
| nome_do_receptor | Nome do destinatário |
| receptor_cnpj | Número do CNPJ do receptor para pessoa jurídica |
| receptor_cpf | Número do CPF do receptor para pessoas físicas |
Parâmetros adicionais para Negado e Erro eventos de transação
| Parâmetros de consulta | Descrição |
|---|---|
| detalhe_descrição | (descrição do erro ocorrido durante a transação) |
Nesta página