curl -X GET "https://api.zeriqpay.com.br/v1/payments/check/cmtransaction" \
-H "X-API-Key: zeriq_sua_chave"
{
"success": true,
"data": {
"id": "cmtransaction",
"type": "CASH_IN",
"status": "PENDING",
"amount": 25.5,
"qrCodeBase64": "data:image/png;base64,...",
"qrcodeUrl": "https://...",
"copyPaste": "000201..."
}
}{
"success": true,
"message": "<string>",
"data": {}
}{
"success": true,
"message": "<string>",
"data": {}
}{
"success": true,
"message": "<string>",
"data": {}
}{
"success": true,
"message": "<string>",
"data": {}
}Receber
Consultar pagamento
Consulta uma cobrança PIX por ID
GET
/
v1
/
payments
/
check
/
{id}
curl -X GET "https://api.zeriqpay.com.br/v1/payments/check/cmtransaction" \
-H "X-API-Key: zeriq_sua_chave"
{
"success": true,
"data": {
"id": "cmtransaction",
"type": "CASH_IN",
"status": "PENDING",
"amount": 25.5,
"qrCodeBase64": "data:image/png;base64,...",
"qrcodeUrl": "https://...",
"copyPaste": "000201..."
}
}{
"success": true,
"message": "<string>",
"data": {}
}{
"success": true,
"message": "<string>",
"data": {}
}{
"success": true,
"message": "<string>",
"data": {}
}{
"success": true,
"message": "<string>",
"data": {}
}Use a variante com
/{id} para consultar diretamente uma transação. Também existe a variante sem path, que aceita id ou transactionId como query parameter.
Autenticação
Todas as rotas exigem o 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/payments/check/cmtransaction" \
-H "X-API-Key: zeriq_sua_chave"
Escopo necessário
transactions.read
Referência
- Método:
GET - Rota:
/v1/payments/check/{id} - Autenticação:
X-API-Key
Guia de integração
- Envie a requisição para
https://api.zeriqpay.com.br/v1/payments/check/{id}usando o métodoGET. - Inclua
X-API-Keye conceda à chave o escopotransactions.read. - Trate
success: truecomo sucesso e leia o resultado dentro dedata. - Em erros
4xx, preservemessagee o status HTTP para diagnóstico e retry controlado.
Referência rápida
- Autenticação:
X-API-Key: zeriq_sua_chave - Content-Type:
application/jsonquando houver body - Base URL:
https://api.zeriqpay.com.br - Contrato: consulte o bloco OpenAPI interativo desta página para visualizar parâmetros, schemas e exemplos de resposta.