Referência / Webhooks
Atualizar webhook
/api/v1/user/webhook/{user_id}/{webhook_type}/{webhook_id}Atualiza apenas os campos enviados no body. Usuários com perfil Customer só podem editar os próprios webhooks. Usuários com perfil Director ou Superuser podem editar webhooks de qualquer usuário.
Parâmetros de path
3 camposuser_idintegerObrigatórioID do usuário dono do webhook.
webhook_typestring · enumObrigatórioTipo do webhook.
Valores: pix_inpix_outaccount
webhook_idstring · uuidObrigatórioUUID do webhook.
Parâmetros do body
3 camposwebhook_routestring · uriOpcionalNova URL que receberá as notificações por webhook. Deve começar com `https://`.
webhook_api_keystringOpcionalNova chave usada como username no HTTP Basic Auth.
webhook_secret_keystringOpcionalNovo segredo usado como password no HTTP Basic Auth.
Resposta
WebhookResponseWebhook atualizado com sucesso.
{
"id": "0b4f9c2b-1df5-4a2e-b4db-2e9bbd4f0a10",
"created_at": "2026-04-16T00:00:00",
"updated_at": "2026-04-16T12:30:00",
"webhook_route": "https://novo-url.com/callback",
"webhook_api_key": "nova-chave",
"webhook_secret_key": "nova****gredo"
}Campos da resposta
6 camposidstring · uuidObrigatórioUUID do webhook.
created_atstring · date-timeObrigatórioData de criação do webhook.
updated_atstring · date-timeObrigatórioData da última atualização do webhook.
webhook_routestring · uriObrigatórioURL que recebe as notificações por webhook.
webhook_api_keystringOpcionalChave usada como username no HTTP Basic Auth.
webhook_secret_keystringOpcionalSegredo usado como password no HTTP Basic Auth. Na listagem e atualização, esse valor pode vir mascarado.
Status HTTP
200Webhook atualizado com sucesso.
400Usuário não encontrado, URL inválida, webhook_id inexistente ou usuário com perfil Customer tentando acessar outro usuário.
401Token Basic ausente ou inválido.
PIX Out (Envio) POST
Realiza uma transferência PIX para a chave de destino informada e retorna o identificador da operação.
Criar webhook POST
Cria um webhook para o tipo informado. Usuários com perfil Customer só podem criar webhooks para a própria conta. Usuários com perfil Director ou Superuser podem criar para qualquer usuário.