curl -X POST "https://api.zeriqpay.com.br/v1/webhooks/create" \
-H "X-API-Key: zeriq_sua_chave" \
-H "Content-Type: application/json" \
-d '{"name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid","payment.failed"]}'
{"success":true,"message":"Endpoint de webhook criado com sucesso. Guarde o segredo, ele não será exibido novamente.","data":{"id":"cmid_webhook","name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid","payment.failed"],"active":true,"secret":"whsec_exemplo"}}
Gerenciamento
Criar endpoint de webhook
Cadastra uma URL HTTPS para receber eventos
POST
/
v1
/
webhooks
/
create
curl -X POST "https://api.zeriqpay.com.br/v1/webhooks/create" \
-H "X-API-Key: zeriq_sua_chave" \
-H "Content-Type: application/json" \
-d '{"name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid","payment.failed"]}'
{"success":true,"message":"Endpoint de webhook criado com sucesso. Guarde o segredo, ele não será exibido novamente.","data":{"id":"cmid_webhook","name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid","payment.failed"],"active":true,"secret":"whsec_exemplo"}}
Cadastre o destino das notificações. A API gera um segredo único e o retorna uma única vez.
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 POST "https://api.zeriqpay.com.br/v1/webhooks/create" \
-H "X-API-Key: zeriq_sua_chave" \
-H "Content-Type: application/json" \
-d '{"name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid","payment.failed"]}'
Body
name(opcional): nome entre 1 e 120 caracteres.url(obrigatório): URL HTTPS que receberá os eventos.events(obrigatório): lista única com pelo menos um evento suportado.
Referência
- Método:
POST - Rota:
/v1/webhooks/create - Escopo:
webhooks.create - Resposta de sucesso:
201 Created
secret começa com whsec_ e não aparece novamente em consultas futuras. Armazene-o em um secret manager.
Exemplo de resposta
{"success":true,"message":"Endpoint de webhook criado com sucesso. Guarde o segredo, ele não será exibido novamente.","data":{"id":"cmid_webhook","name":"Pagamentos","url":"https://app.exemplo.com/webhooks/zeriqpay","events":["payment.paid","payment.failed"],"active":true,"secret":"whsec_exemplo"}}
Erros comuns
400: URL, eventos ou body inválidos.401: API Key ausente ou inválida.403: a chave não possui o escopowebhooks.create.404: endpoint não encontrado ou não pertence à conta.
Authorizations
API Key ZeriqPay iniciada por zeriq_.
Body
application/json
Maximum 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 Required string length:
1 - 120