Documentation Index
Fetch the complete documentation index at: https://docs.noxpay.io/llms.txt
Use this file to discover all available pages before exploring further.
GET /v2/statement
Authorization: Bearer <your-api-key>
Parâmetros de query
| Parâmetro | Tipo | Descrição |
|---|
limit | integer | Máximo de resultados por página (padrão: 20, máx: 100) |
offset | integer | Offset de paginação (padrão: 0) |
currency | string | Filtrar por código de moeda (ex: USDT_TRX, BRL) |
account_type | string | Filtrar por sub-conta: available, in_transit, to_receive ou blocked |
date_from | string | Filtro de data de início — YYYY-MM-DD |
date_to | string | Filtro de data de fim — YYYY-MM-DD |
Response 200 OK
{
"total": 128,
"limit": 20,
"offset": 0,
"entries": [
{
"id": 4521,
"date": "2024-05-01T12:00:00Z",
"account": {
"id": 42,
"name": "USDT (TRX) available",
"code": "2.1.1.100.1.1.1",
"currency": "USDT_TRX",
"currency_pretty_name": "USDT (TRX)"
},
"debit": 0.00,
"credit": 100.00,
"previous_balance": 50.00,
"balance": 150.00,
"transaction": {
"end2end": "NOXabc123",
"template": "crossramp_checkout",
"created_at": "2024-05-01T11:59:00Z",
"updated_at": "2024-05-01T12:00:00Z",
"status": { "en": "Success", "pt": "Sucesso" },
"substatus": { "en": "Success", "pt": "Sucesso" },
"message": { "en": "Transaction completed successfully", "pt": "Transação concluída com sucesso" },
"error_message": { "en": "", "pt": "" },
"attributes": {
"quote": 5.45,
"currency_exit_received": "USDT (TRX)",
"amount_payment": 550.00,
"amount_received": 100.00,
"client_name": "João Silva",
"client_tax_id": "12345678901"
}
}
}
]
}
Campos do response
| Campo | Tipo | Descrição |
|---|
total | integer | Total de lançamentos correspondentes em todas as páginas |
limit | integer | Tamanho da página usado |
offset | integer | Offset atual |
entries | array | Lista de objetos de lançamento do extrato |
| Campo | Tipo | Descrição |
|---|
id | integer | Identificador único do lançamento contábil |
date | string | Timestamp ISO 8601 do lançamento |
account.id | integer | ID interno da conta contábil |
account.name | string | Rótulo legível (ex: USDT (TRX) available) |
account.code | string | Código completo de conta de partidas dobradas (ex: 2.1.1.100.1.1.1) |
account.currency | string | Código de moeda bruto do livro-razão (ex: USDT_TRX) |
account.currency_pretty_name | string | Nome exibido (ex: USDT (TRX)) |
debit | float | Valor debitado desta conta |
credit | float | Valor creditado a esta conta |
previous_balance | float | Saldo da conta antes deste lançamento |
balance | float | Saldo da conta após este lançamento |
transaction | object | null | Objeto de transação embutido quando gerado por um processo Noxpay; null para ajustes internos |
Subtipo de conta pelo código
O último segmento de account.code identifica o bucket de sub-conta:
| Segmento do código | Tipo | Descrição |
|---|
1 | available | Disponível para saque imediato |
2 | in_transit | Enviado; aguardando confirmação on-chain |
3 | to_receive | Entrada pendente |
4 | blocked | Bloqueado para conformidade ou disputa |
Objeto de transação embutido
Quando transaction está presente, o campo template informa o tipo de processo que gerou o lançamento:
| Valor do template | Processo |
|---|
crossramp_checkout | Crossramp Checkout |
onramp | Onramp para Conta |
onramp_instant | Onramp para Endereço |
offramp | Offramp da Conta |
offramp_instant | Offramp de Endereço Externo |
withdraw_dash_same_curr | Saque |
attributes contém os campos relevantes para aquele template. Consulte as páginas de cada recurso para as tabelas completas de attributes.
