Skip to main content

Configurando Webhook

Cada chave Pix receptora pode ter um webhook associado.
A configuração da URL de callback utilizada pelo webhook é feita da seguinte forma:

curl --location --request POST 'https://secureapi.onz.finance/api/v2/webhooks/{webhook_type}' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer eyJhbGc...' \
    --data {
        "uri": "{partner_callback_url}",
        "enabled": true,
    }

Onde:

  • webhook_type: Webhook que deseja configurar (transfer, receive, refund, cashout, infraction, invoice ou CRYPTO)

Não há webhook de alteração de status da conta, do titular ou do onboarding. Acompanhe por consulta. Veja Status de contas e pessoas. Com credencial BaaS, o webhook financeiro é da conta filha: envie x-account-id. Veja Como operar.

  • partner_callback_url: URL de callback fornecida pelo parceiro para receber a solicitação POST com os dados respectivos a cada webhook.

Para eventos de cobrança Pix/boleto (invoice.registered, invoice.paid, invoice.settled, invoice.cancelled, invoice.overdue), veja Webhook de cobrança.

Para eventos CaaS (crypto.wallet.registered, crypto.wallet.first_purchase, crypto.order.updated, crypto.order.settled), veja Webhook CRYPTO. O path CRYPTO é case-insensitive.