API Reference
Listar endpoints de webhook
GET /v1/pix-accounts/:accountId/webhooks — endpoints registrados na conta.
Lista endpoints de webhook
Lista todos os webhooks registrados na conta Pix. Retorna um array JSON direto (sem wrapper).
GET/v1/pix-accounts/:accountId/webhooks
A listagem não retorna o authToken — ele só aparece na criação. Para webhooks desativados (enabled: false após DELETE), os eventos deixam de ser entregues mas o registro permanece para auditoria.
Path params
- accountIdObrigatóriostringID da conta Pix.
Headers
- AuthorizationObrigatóriostringBearer SUA_API_KEY
Exemplo de requisição
bash
curl https://api.staterpay.io/v1/pix-accounts/cmoxample0001qkxyzaccount/webhooks \ -H "Authorization: Bearer SUA_API_KEY"Resposta
- [].idstringIdentificador do webhook (cuid).
- [].urlstring (HTTPS)Endpoint público que recebe os eventos.
- [].eventsstring[]Lista de eventos assinados.
- [].pixAccountIdstringConta Pix proprietária do webhook.
- [].coreEndpointIdstring | nullID do endpoint no core, quando espelhado.
- [].enabledbooleanSe o webhook está ativo. Vai para false após DELETE.
- [].createdAtstring (ISO-8601 UTC-3)Criação.
- [].updatedAtstring (ISO-8601 UTC-3)Última atualização.
json
[ { "id": "cmoxample0001qkxyzwebhook", "url": "https://api.minhaempresa.com/webhooks/stater", "events": [ "pix.payout.succeeded", "pix.payout.failed", "pix.payout.cancelled", "pix.payout.refunded", "pix.charge.paid", "pix.charge.expired", "pix.charge.refunded", "pix.in.received" ], "pixAccountId": "cmoxample0001qkxyzaccount", "coreEndpointId": null, "enabled": true, "createdAt": "2026-05-06T18:41:01.240-03:00", "updatedAt": "2026-05-06T18:41:01.246-03:00" }]URL base:
https://api.staterpay.io