Webhooks

Listar URLs cadastradas

GET
/v2/webhooks
AuthorizationBearer <token>

Chave de API da sua empresa. Por enquanto a SwitchPay gera a chave e entrega à sua empresa; em breve será possível criar pelo painel.

In: header

Response Body

curl -X GET "https://api.sandbox.switchpay.app.br/v2/webhooks"

{
  "data": [
    {
      "id": "whk_3a9d1b2c-4d5e-4f60-8a7b-9c0d1e2f3a4b",
      "url": "https://integracao.parceiro.com.br/switchpay/webhook",
      "events": [
        "transaction.created",
        "transaction.paid",
        "transaction.canceled"
      ],
      "description": "Produção — pedidos",
      "active": true,
      "createdAt": "2026-10-06T13:00:00.000Z"
    }
  ]
}

{
  "code": "UNAUTHORIZED",
  "message": "Chave de API ausente, inválida ou de outro ambiente."
}

{
  "code": "FORBIDDEN",
  "message": "Sua chave não tem permissão para esta operação."
}

{
  "code": "RATE_LIMITED",
  "message": "Limite de chamadas atingido. Aguarde e tente de novo."
}

{
  "code": "SERVICE_UNAVAILABLE",
  "message": "Serviço de autorização indisponível. Tente novamente em instantes."
}