Criar uma configuração de webhook

Esse endpoint permite o cadastro de uma configuração para um webhook. É possivel cadastrar o recebimento de webhooks de cada entidade para cada conta escrow, mas por enquanto só está habilitado os webhooks de SLC.

Os webhooks podem ser configurados de maneira distintas para cada ambiente (homologação/sandbox e produção).

Parâmetros da URL

  • account_id (string): ID de cadastro da conta a ser configurada.

Parâmetros da Requisição

  • webhookType (string, obrigatório): O tipo do webhook a ser cadastrado. Possíveis valores aceitos:

    • SLC_PAYMENT_IN = 'SLC-PAYMENT-IN', -> entrada de SLC

    • PIX_PAYMENT_IN = 'PIX-PAYMENT-IN', -> entrada de pix

    • PIX_PAYMENT_OUT = 'PIX-PAYMENT-OUT', -> saida de pix

    • SPB_TRANSFER_IN = 'SPB-TRANSFER-IN', -> entrada de ted

    • SPB_TRANSFER_OUT = 'SPB-TRANSFER-OUT', -> saida de ted

    • ACCOUNT_STATUS_CHANGE = 'ACCOUNT-STATUS-CHANGE', -> mudança de status no onboarding da conta

    • CHARGE_SETTLEMENT = 'CHARGE-SETTLEMENT', -> liquidação do boleto

    • CHARGE_CREATE = 'CHARGE-CREATE', -> criação do boleto

    • CHARGE_CANCELATION = 'CHARGE-CANCELATION', -> cancelamento / expiração de um boleto

  • url (string, obrigatório): A URL a ser cadastrada para o envio dos webhooks.

Resposta

Se a requisição for processada com sucesso será retornado um código 200 e um ID do webhook configurada:

  • id (string/uuid): ID do webhook cadastrada.
Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!