Extrato
Lista as movimentações da conta no período informado (créditos e débitos), com paginação.
Overview
startDate e endDate são obrigatórios. Cada item em data tem type (credit/debit), amount, description, balanceAfter.
Endpoint
GETGET /accounts/statement
Base URL:
https://api.onnixpay.com/api/v1/sdkHeaders
| Header | Obrigatório | Descrição |
|---|---|---|
| X-API-Key | Sim | Sua API Key. |
Query Parameters
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| startDate | string | Sim | Data inicial do período (ISO 8601). |
| endDate | string | Sim | Data final do período (ISO 8601). |
| page | number | Não | Página. Padrão: 1. |
| limit | number | Não | Itens por página. Padrão: 20. |
Exemplo cURL
cURL
curl -X GET "https://api.onnixpay.com/api/v1/sdk/accounts/statement?startDate=2025-02-01T00:00:00Z&endDate=2025-02-09T23:59:59Z" \
-H "X-API-Key: ox_sua_chave_aqui"Response — Sucesso (200)
JSON
{
"data": [
{
"id": "mov_001",
"type": "credit",
"amount": 1000,
"description": "Recebimento PIX",
"createdAt": "2025-02-09T12:00:00.000Z",
"balanceAfter": 151000
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"totalPages": 1
}
}Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
| data | array | Lista de movimentações. Cada item: id, type (credit/debit), amount, description, createdAt, balanceAfter. |
| pagination | object | page, limit, total, totalPages. |
Status codes e erros comuns
| Status | Código | Mensagem |
|---|---|---|
| 400 | INVALID_REQUEST | Datas inválidas ou faltando (startDate/endDate obrigatórios). |
| 401 | INVALID_API_KEY | Chave de API inválida ou ausente. |
| 403 | INSUFFICIENT_PERMISSIONS | Sem permissão para extrato. |
Exemplo de resposta de erro
JSON
{
"code": "INVALID_REQUEST",
"message": "startDate e endDate são obrigatórios."
}