Stater Platform
API Reference

Consultar webhook

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

Consulta endpoint de webhook

Retorna o detalhe de um webhook específico. Mesmo shape de cada item retornado pela listagem — o authToken não vem incluído (só aparece na criação).

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

Path params

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

Headers

  • AuthorizationObrigatório
    string
    Bearer SUA_API_KEY

Exemplo de requisição

bash
curl https://api.staterpay.io/v1/pix-accounts/cmoxample0001qkxyzaccount/webhooks/cmoxample0001qkxyzwebhook \  -H "Authorization: Bearer SUA_API_KEY"

Resposta

  • id
    string
    Identificador do webhook.
  • url
    string (HTTPS)
    Endpoint público que recebe os eventos.
  • events
    string[]
    Lista de eventos assinados.
  • pixAccountId
    string
    Conta Pix proprietária.
  • coreEndpointId
    string | null
    ID do endpoint no core, quando espelhado.
  • enabled
    boolean
    Se o webhook está ativo.
  • createdAt
    string (ISO-8601 UTC-3)
    Criação.
  • updatedAt
    string (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

Registrar webhook

POST /v1/pix-accounts/:accountId/webhooks — cadastra URL para receber eventos.

Remover webhook

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

On this page

Path paramsHeadersExemplo de requisiçãoResposta