curl -X GET "https://api.zeriqpay.com.br/v1/webhooks/list" \
-H "X-API-Key: zeriq_sua_chave"
{"success":true,"data":[{"id":"cmid_webhook","name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid"],"active":true,"lastDeliveryAt":null,"createdAt":"2026-10-28T12:00:00.000Z","updatedAt":"2026-10-28T12:00:00.000Z"}]}
Gerenciamento
Listar endpoints de webhook
Lista os endpoints configurados
GET
/
v1
/
webhooks
/
list
curl -X GET "https://api.zeriqpay.com.br/v1/webhooks/list" \
-H "X-API-Key: zeriq_sua_chave"
{"success":true,"data":[{"id":"cmid_webhook","name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid"],"active":true,"lastDeliveryAt":null,"createdAt":"2026-10-28T12:00:00.000Z","updatedAt":"2026-10-28T12:00:00.000Z"}]}
Lista todos os endpoints da conta. O segredo nunca é incluído.
Autenticação
Todas as rotas exigem uma API Key no headerX-API-Key. A chave deve começar com zeriq_.
X-API-Key: zeriq_sua_chave
curl -X GET "https://api.zeriqpay.com.br/v1/webhooks/list" \
-H "X-API-Key: zeriq_sua_chave"
Referência
- Método:
GET - Rota:
/v1/webhooks/list - Escopo:
webhooks.read - Resposta de sucesso:
200 OK
Exemplo de resposta
{"success":true,"data":[{"id":"cmid_webhook","name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid"],"active":true,"lastDeliveryAt":null,"createdAt":"2026-10-28T12:00:00.000Z","updatedAt":"2026-10-28T12:00:00.000Z"}]}
Erros comuns
400: URL, eventos ou body inválidos.401: API Key ausente ou inválida.403: a chave não possui o escopowebhooks.read.404: endpoint não encontrado ou não pertence à conta.