1.1.0
  • 1.0.0
  • 1.1.0
    1.1.0
    • 1.0.0
    • 1.1.0
    Default module
    • Default module
    • Teste
    • Overview
    • Webhooks
    • Error codes
    • Transactions
      • Criar uma Transação
        POST
      • Criar uma Transação Com 3DS
        POST
      • Criar uma Transação PIX
        POST
      • Criar uma Transação Boleto
        POST
      • Criar uma Transação - Split
        POST
      • Estornar uma transação
        POST
      • Capturando uma Transação
        POST
      • Buscar Transação
        GET
      • Listar Transações
        GET
      • Retornar Histórico de uma Transação
        GET
      • Retornar Parcelas de uma transação
        GET
    • Payment Links
      • Criar Link
        POST
      • Atualizar Link
        PUT
      • Buscar Link
        GET
      • Listar Links
        GET
      • Transações de um link
        GET
    • Customer
      • Criar Cliente
        POST
      • Encontrar Cliente
        POST
      • Cartões do Cliente
        POST
      • Atualizar Cliente
        PUT
      • Buscar Cliente
        GET
      • Listar Clientes
        GET
      • Deletar um cliente
        DELETE
    • Cards
      • Criar Cartão
      • Obter Bandeira
      • Buscar Cartão
      • Listar Cartões
    • Simulate
      • Tax
    • Split
      • Receivers
        • Criando um recebedor
        • Atualizando um recebedor
        • Retornar um recebedor
        • Retornar recebedores
        • Deletar um recebedor
      • Receiver Bank Accounts
        • Criar banco para um recebedor
        • Retornar contas de um recebedor
        • Retornar conta de um recebedor por id da conta bancária
        • Deletar uma conta bancária de um recebedor
        • Atualizar o status da conta bancária de um recebedor
    • Recurrence
      • Prices
        • Criar novo preço
        • visualizar os preços de um plano
        • visualizar os preços de um plano Copy
        • Atualizar preço
        • Deletar preço
      • Plans
        • Criar um Plano
        • Atualizar Um Plano
        • Listar Planos
        • Buscar um Plano
        • Deletar um Plano
      • Subscriptions
        • Criar uma Assinatura (IDs)
        • Criar uma Assinatura (Sem IDs)
        • Atualizar uma Assinatura
        • Buscar uma Assinatura
        • Buscar Assinaturas
        • Cancelar uma Assinatura
        • Deletar uma Assinatura
    • Webhook
      • Criar um webhook
      • Atualizar Webhook
      • Retornar Webhooks Cadastrados
      • Retornar um Webhook
      • Remover um Webhook
    • Configuration
      • Adding Acquirers
      • Setting Main Acquirer
      • Configuring Anti Fraud
    • Esquemas
      • Teste 3

    Webhooks

    Conceito Básico#

    Gatilhos (ou Webhooks) são endereços (URLs) para onde a BcPag dispara avisos (Via método POST) para certos eventos que ocorrem em sua conta.
    As chamadas são enviadas com content-type application/json
    Os gatilhos podem ser cadastrados pelo painel da Pay Tools em Webhooks.
    TipoDescrição
    transaction.createdOcorre sempre que um transação é criada.
    transaction.status_changedOcorre quando o status da transação é alterado.
    link.createdOcorre sempre que um Link é criado.
    link.changedOcorre quando um Link é alterado.
    link.paidOcorre quando um Link é pago.
    customer.createdOcorre sempre que um Cliente é criado.
    customer.changedOcorre quando um Cliente é alterado.

    Objeto de envio#

    O objeto de envio dos webhooks consiste num padrão de evento, onde o payload é alterado de acordo com o seu contexto.

    Objeto default#

    {
       "event":"transaction.status_changed",
       "model":"transactions",
       "model_id":"123097",
       "payload":{…}
    }

    Objetos de payload#

    Transactions
    Links
    Customer
    Objeto do contexto de transações.
    Modificado em 2025-01-13 10:21:47
    Página anterior
    Overview
    Próxima página
    Error codes
    Built with