Webhooks

Webhooks permitem que você receba notificações em tempo real sobre eventos que ocorrem no nosso sistema. Sempre que um evento especificado ocorre, enviaremos uma solicitação HTTP POST para a URL do webhook que você registrou.

Este documento fornece detalhes sobre os webhooks disponíveis para os tipos de eventos: payment_reservation_created, limit_reservation_canceled, limit_reservation_expired credit_analysis_completed, e merchant_able_to_transact. Os webhooks são usados para notificar seu sistema sobre eventos que ocorrem em nossa plataforma.

Cadastrando um webhookCopied!

Para garantir uma integração perfeita e um funcionamento eficiente dos nossos serviços, é essencial que você nos forneça os webhooks necessários. Encaminhe seus webhooks, para nossa equipe de Operação ou para o Time de Integração em contato com você. Isso nos permitirá testar a integração, assegurando que todas as funcionalidades estejam operando corretamente e que os dados sejam transmitidos de maneira segura e eficiente.

Autenticação dos WebhooksCopied!

Para garantir a segurança das notificações enviadas, incluímos um header HTTP em todas as requisições do webhook:

• X-Tino-Secret-Token: Este header contém o valor da API Key, permitindo a validação do webhook recebido.

Além de garantir a autenticidade da requisição, esse token também possibilita a identificação do fornecedor relacionado ao evento. Isso é especialmente útil para fornecedores que operam múltiplas lojas com o Tino usando a mesma URL de webhook, permitindo que cada notificação seja corretamente associada ao respectivo fornecedor e contexto operacional.

Tipos de EventoCopied!

payment_reservation_created 

payment_reservation_created: Disparado quando uma reserva de pagamento é criada.

limit_reservation_canceled

limit_reservation_canceled: Disparado quando uma reserva de limite é cancelada.

limit_reservation_expired  

limit_reservation_expired: Disparado quando lojista excede o limite de crédito.

credit_analysis_completed

credit_analysis_completed: Disparado quando a analise de crédito é completada.

merchant_able_to_transact

merchant_able_to_transact: Disparado quando lojista está apto a efetuar transações.

Exemplos de PayloadsCopied!

Exemplo para payment_reservation_created:

{
    "type": "payment_reservation_created",
    "data": {
            "paymentReservationId": "123e4567-e89b-12d3-a456-426614174002",
            "externalId": "abc123"
     }
}        

Exemplo para limit_reservation_canceled:

{
    "type": "limit_reservation_canceled",
    "data": {
            "paymentReservationId": "123e4567-e89b-12d3-a456-426614174003",
            "externalId": "def456"
    }
}

Exemplo para limit_reservation_expired:

{
    "type": "limit_reservation_expired",
    "data": {
            "externalId": "abc123",
            "paymentReservationId": "123e4567-e89b-12d3-a456-426614174002"
    }
}

Exemplo para credit_analysis_completed:

{
    "type": "credit_analysis_completed",
    "data": {
            "decision": "denied",
            "cnpj": "00000001000100",
            "company_id": "1a111aa1-a111-0000-1aa1-1aa11aa1a11a"
    }
}

Exemplo para merchant_able_to_transact:

{
    "type": "merchant_able_to_transact",
    "data": {
            "cnpj": "00000001000100"
    }
}