Stater Platform
API Reference

Remover webhook

DELETE /v1/pix-accounts/:accountId/webhooks/:webhookId — desativa o endpoint.

Remove endpoint de webhook

Desativa o webhook (soft delete). O registro permanece para auditoria, mas eventos futuros deixam de ser entregues. Para reativar, basta criar um novo webhook.

DELETE/v1/pix-accounts/:accountId/webhooks/:webhookId

É um soft delete: o registro continua aparecendo em listagens com enabled: false. Eventos pix.* deixam de ser entregues imediatamente para esta URL.

Path params

  • accountIdObrigatório
    string
    ID da conta Pix.
  • webhookIdObrigatório
    string
    Identificador do webhook.

Headers

  • AuthorizationObrigatório
    string
    Bearer SUA_API_KEY
  • Idempotency-KeyObrigatório
    string
    UUID para retry seguro.

Exemplo de requisição

bash
curl -X DELETE https://api.staterpay.io/v1/pix-accounts/cmoxample0001qkxyzaccount/webhooks/cmoxample0001qkxyzwebhook \  -H "Authorization: Bearer SUA_API_KEY" \  -H "Idempotency-Key: 56dbefc2-0506-4d49-b723-46ded961585e"

Resposta

  • id
    string
    Identificador do webhook desativado.
  • enabled
    boolean
    Sempre false após DELETE.
json
{  "id": "cmoxample0001qkxyzwebhook",  "enabled": false}
URL base:https://api.staterpay.io

Consultar webhook

GET /v1/pix-accounts/:accountId/webhooks/:webhookId — detalhe do endpoint.

On this page

Path paramsHeadersExemplo de requisiçãoResposta