Casos de Disparos de Hooks

Os Webhooks da Paytime permitem que sua aplicação seja notificada em tempo real sobre eventos importantes que ocorrem em nossa plataforma, sem a necessidade de consultas constantes à API.

📌 Casos de disparo dos Webhooks

EventoQuando é disparado
new-billetCriação de boleto manual via Portal.
updated-billet-statusSempre que houver atualização de status do boleto (ações assíncronas). Disparado tanto em requisições via Portal quanto via API.
updated-establishment-gatewayAtualização do status de habilitação de gateway.
new-establishmentCriação de Estabelecimento (EC) manual via Portal.
updated-establishment-statusAtualização do status de cadastrado do estabelecimento.
updated-establishment-dataAtualização de dados do Estabelecimento realizado via Portal.
new-sub-splitSempre que houver qualquer tipo de split em uma transação (independente da origem).
canceled-sub-splitSempre que um split de transação for cancelado (independente da origem).
new-sub-transactionSempre que uma transação Sub for criada (exceto via API).
updated-sub-transactionDisparado quando:
• Uma transação é estornada
• Uma transação sofre split.
• Uma transação é liquidada.
• Sofre qualquer alteração de status
new-pagseguro-transactionSempre que uma transação PagSeguro for criada.
updated-pagseguro-transactionDisparado quando:
• Uma transação é estornada
• Sofre qualquer alteração de status
new-transfer-ted-inNova transferência TED de entrada
new-transfer-ted-outNova transferência TED de saída
new-transfer-pix-inNova transferência PIX de entrada
new-transfer-pix-outNova transferência PIX de saída
new-transfer-p2p-inNova transferência P2P de entrada
new-payment-billetNovo pagamento de boleto
new-sub-checkoutNovo checkout Sub
updated-sub-checkoutCheckout Sub atualizado
updated-export-fileNovo arquivo de exportação

⚠️ É importante

Os eventos síncronos, como chamadas diretas de rotas POST e PUT, já retornam a resposta na própria requisição e não disparam Webhooks adicionais.


Exemplo do Conteúdo do evento

Quando o evento webhook é disparado enviaremos:

  • event: é o nome do evento que está sendo enviado, sua aplicação precisa estar preparada para identificar o tipo de evento;
  • event_date: é a data que o evento foi enviado;
  • data: É objeto JSON que contém as informações do webhook cadastrado, seguindo o padrão de resposta dos endpoints de criação, edição e atualização

Exemplo de evento: updated-sub-transaction

{
  "event": "updated-sub-transaction",
  "event_date": "2025-09-25T19:10:51.852Z",
  "data": {
    "_id": "68d593bb9849a930c4ac192e",
    "status": "PAID",
    "interest": "STORE",
    "establishment": {
      "id": 155085,
      "type": "INDIVIDUAL",
      "first_name": "EC Cobranças API",
      "last_name": null,
      "document": "10068114001",
      "access_type": "ACQUIRER"
    },
    "marketplace": {
      "id": 26,
      "type": "LICENSED",
      "nickname": "Parceiro Integrações",
      "active": true,
      "first_name": "Webhooks Integrações",
      "last_name": "API Integrações",
      "document": "60274849000185"
    },
    "representative": {
      "id": 63,
      "marketplace_id": 26,
      "active": true,
      "first_name": "EC Cobranças API",
      "last_name": null,
      "document": "10068114001"
    },
    "amount": 993,
    "original_amount": 1005,
    "fees": 12,
    "type": "PIX",
    "gateway_key": "8dd94b26894e4abf99d77a1efd902e18",
    "gateway_authorization": "PAYTIME",
    "card": null,
    "installments": 1,
    "customer": {
      "_id": "68d593bb9849a930c4ac191b"
    },
    "point_of_sale": {
      "type": "ONLINE",
      "identification_type": "API"
    },
    "acquirer": {
      "name": "SANTANDER",
      "key": "60701190000104",
      "gateway_key": "8dd94b26894e4abf99d77a1efd902e18",
      "_id": "68d593bb9849a930c4ac193f"
    },
    "expected_on": [
      {
        "date": "2025-09-26T12:00:00.539Z",
        "amount": 993,
        "status": "PENDING",
        "installment": 1
      }
    ],
    "emv": "00020101021226910014BR.GOV.BCB.PIX2569spi-h.santander.com.br/pix/qr/v2/af581bdc-624e-4333-af38-1adaddfa6ce05204000053039865802BR5914PMD BASHAR RIO6009SAO PAULO62070503***6304E7DB",
    "antifraud": [
      {
        "analyse_status": "NO_ANALYSED",
        "_id": "68d593bb9849a930c4ac192c"
      }
    ],
    "created_at": "2025-09-25T19:10:51.543Z",
    "info_additional": []
  }
}


Did this page help you?