curl -X PATCH "https://api.zeriqpay.com.br/v1/webhooks/update/cmid_webhook" \
-H "X-API-Key: zeriq_sua_chave" \
-H "Content-Type: application/json" \
-d '{"events":["payment.paid","refund.completed"],"active":true}'
{"success":true,"message":"Endpoint de webhook atualizado com sucesso.","data":{"id":"cmid_webhook","name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid","refund.completed"],"active":true,"lastDeliveryAt":null,"createdAt":"2026-10-28T12:00:00.000Z","updatedAt":"2026-10-28T12:00:00.000Z"}}
Gerenciamento
Atualizar endpoint de webhook
Atualiza nome, URL, eventos ou estado
PATCH
/
v1
/
webhooks
/
update
/
{id}
curl -X PATCH "https://api.zeriqpay.com.br/v1/webhooks/update/cmid_webhook" \
-H "X-API-Key: zeriq_sua_chave" \
-H "Content-Type: application/json" \
-d '{"events":["payment.paid","refund.completed"],"active":true}'
{"success":true,"message":"Endpoint de webhook atualizado com sucesso.","data":{"id":"cmid_webhook","name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid","refund.completed"],"active":true,"lastDeliveryAt":null,"createdAt":"2026-10-28T12:00:00.000Z","updatedAt":"2026-10-28T12:00:00.000Z"}}
Atualiza somente os campos enviados. O array
events substitui a inscrição anterior.
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 PATCH "https://api.zeriqpay.com.br/v1/webhooks/update/cmid_webhook" \
-H "X-API-Key: zeriq_sua_chave" \
-H "Content-Type: application/json" \
-d '{"events":["payment.paid","refund.completed"],"active":true}'
Body
Todos os campos são opcionais:name, url, events e active. A URL deve ser HTTPS e events deve conter ao menos um evento quando enviado.
Referência
- Método:
PATCH - Rota:
/v1/webhooks/update/{id} - Escopo:
webhooks.update - Resposta de sucesso:
200 OK
active: false. Para remover definitivamente, use a rota de revogação.
Exemplo de resposta
{"success":true,"message":"Endpoint de webhook atualizado com sucesso.","data":{"id":"cmid_webhook","name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid","refund.completed"],"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.update.404: endpoint não encontrado ou não pertence à conta.
Authorizations
API Key ZeriqPay iniciada por zeriq_.
Path Parameters
ID do endpoint.
Body
application/json
Required string length:
1 - 120Maximum string length:
2048Pattern:
^https://Minimum array length:
1Available options:
payment.created, payment.paid, payment.failed, payment.pix.expired, refund.requested, refund.completed, refund.failed, transfer.created, transfer.completed, transfer.failed, transfer.internal.completed, transfer.internal.received, med.created, med.evidence_sent, med.updated, webhook.test