Pular para o conteúdo principal
curl "https://checkout.noxpay.io/v2/statement?limit=20&offset=0" \
  -H "api-key: <key>"

import requests

response = requests.get(
    "https://checkout.noxpay.io/v2/statement",
    headers={"api-key": "<key>"},
    params={"limit": 20, "offset": 0},
)
print(response.json())

const params = new URLSearchParams({ limit: 20, offset: 0 });
const response = await fetch(
  `https://checkout.noxpay.io/v2/statement?${params}`,
  { headers: { "api-key": "<key>" } }
);
const data = await response.json();

{
  "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"
        }
      }
    }
  ]
}
Cada lançamento representa uma única linha de débito ou crédito contra uma de suas sub-contas, com saldo antes e depois. Quando o movimento foi gerado por um processo Noxpay — Crossramp Checkout, onramp, offramp, saque — o objeto de transação completo é embutido inline.

​
Parâmetros de query

ParâmetroTipoDescrição
limitintegerMáximo de resultados por página (padrão: 20, máx: 100)
offsetintegerOffset de paginação (padrão: 0)
currencystringFiltrar por código de moeda (ex: USDT_TRX, BRL)
account_typestringFiltrar por sub-conta: available, in_transit, to_receive ou blocked
date_fromstringFiltro de data de início — YYYY-MM-DD
date_tostringFiltro de data de fim — YYYY-MM-DD

​
Campos do response

CampoTipoDescrição
totalintegerTotal de lançamentos correspondentes em todas as páginas
limitintegerTamanho da página usado
offsetintegerOffset atual
entriesarrayLista de objetos de lançamento do extrato

​
Lançamento do extrato

CampoTipoDescrição
idintegerIdentificador único do lançamento contábil
datestringTimestamp ISO 8601 do lançamento
account.idintegerID interno da conta contábil
account.namestringRótulo legível (ex: USDT (TRX) available)
account.codestringCódigo completo de conta de partidas dobradas (ex: 2.1.1.100.1.1.1)
account.currencystringCódigo de moeda bruto do livro-razão (ex: USDT_TRX)
account.currency_pretty_namestringNome exibido (ex: USDT (TRX))
debitfloatValor debitado desta conta
creditfloatValor creditado a esta conta
previous_balancefloatSaldo da conta antes deste lançamento
balancefloatSaldo da conta após este lançamento
transactionobject | nullObjeto 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ódigoTipoDescrição
1availableDisponível para saque imediato
2in_transitEnviado; aguardando confirmação on-chain
3to_receiveEntrada pendente
4blockedBloqueado 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 templateProcesso
crossramp_checkoutCrossramp Checkout
onrampOnramp para Conta Global
onramp_instantOnramp para Endereço Externo
offrampOfframp da Conta Global
offramp_instantOfframp de Endereço Externo
withdraw_dash_same_currSaque
O objeto attributes contém os campos relevantes para aquele template. Consulte as páginas de cada recurso para as tabelas completas de attributes. 
curl "https://checkout.noxpay.io/v2/statement?limit=20&offset=0" \
  -H "api-key: <key>"

import requests

response = requests.get(
    "https://checkout.noxpay.io/v2/statement",
    headers={"api-key": "<key>"},
    params={"limit": 20, "offset": 0},
)
print(response.json())

const params = new URLSearchParams({ limit: 20, offset: 0 });
const response = await fetch(
  `https://checkout.noxpay.io/v2/statement?${params}`,
  { headers: { "api-key": "<key>" } }
);
const data = await response.json();

{
  "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"
        }
      }
    }
  ]
}