curl -G "https://api.zeriqpay.com.br/v1/payments/list" \
-H "X-API-Key: zeriq_sua_chave" \
--data-urlencode "page=1" \
--data-urlencode "limit=20"
{
"success": true,
"data": {
"transactions": [],
"pagination": {
"page": 1,
"limit": 20,
"total": 0,
"pages": 1
}
}
}{
"success": true,
"message": "<string>",
"data": {}
}{
"success": true,
"message": "<string>",
"data": {}
}{
"success": true,
"message": "<string>",
"data": {}
}{
"success": true,
"message": "<string>",
"data": {}
}Receber
Listar pagamentos PIX
Lista cobranças PIX com filtros
GET
/
v1
/
payments
/
list
curl -G "https://api.zeriqpay.com.br/v1/payments/list" \
-H "X-API-Key: zeriq_sua_chave" \
--data-urlencode "page=1" \
--data-urlencode "limit=20"
{
"success": true,
"data": {
"transactions": [],
"pagination": {
"page": 1,
"limit": 20,
"total": 0,
"pages": 1
}
}
}{
"success": true,
"message": "<string>",
"data": {}
}{
"success": true,
"message": "<string>",
"data": {}
}{
"success": true,
"message": "<string>",
"data": {}
}{
"success": true,
"message": "<string>",
"data": {}
}Lista somente transações de entrada (
CASH_IN) com paginação e filtros.
Autenticação
Todas as rotas exigem o headerX-API-Key. A chave deve começar com zeriq_.
X-API-Key: zeriq_sua_chave
curl -G "https://api.zeriqpay.com.br/v1/payments/list" \
-H "X-API-Key: zeriq_sua_chave" \
--data-urlencode "page=1" \
--data-urlencode "limit=20"
Escopo necessário
transactions.read
Referência
- Método:
GET - Rota:
/v1/payments/list - Autenticação:
X-API-Key
Guia de integração
- Envie a requisição para
https://api.zeriqpay.com.br/v1/payments/listusando 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.
Authorizations
API Key ZeriqPay iniciada por zeriq_.
Query Parameters
Página iniciando em 1.
Required range:
x >= 1Itens por página.
Required range:
1 <= x <= 100Tipo da transação.
Available options:
ALL, CASH_IN, CASH_OUT, CRYPTO_OUT, KYC, TRANSFER_IN, TRANSFER_OUT Status da transação.
Available options:
ALL, PENDING, COMPLETED, FAILED, EXPIRED Filtra por ID.
Data inicial em ISO 8601.
Data final em ISO 8601.