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.
Cobre os templates: onramp (BRL → saldo) e onramp_instant (BRL → carteira externa). Campos marcados com o nome do template estão presentes apenas naquela variante.
Consultar um onramp individual
GET /v2/onramp/{id}
Authorization: Bearer <your-api-key>
Parâmetros de caminho
| Parâmetro | Descrição |
|---|
id | O identificador end2end (ex: NOXabc456) |
Response 200 OK
{
"end2end": "NOXabc456",
"component": "success",
"state": "DONE",
"template": "onramp_instant",
"created_at": "2024-05-01T10:00:00Z",
"updated_at": "2024-05-01T10:08: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,
"ref_quote": 5.30,
"fees": 10.00,
"currency_entry": "BRL",
"currency_exit_received": "USDT (TRX)",
"currency_exit_received_code": "USDT",
"amount_payment": 550.00,
"amount_received": 100.00,
"pix_e2e": "E00038166202405011000...",
"client_name": "Maria Souza",
"client_tax_id": "98765432100",
"expiration": "2024-05-01T10:30:00Z",
"return_url": "https://yourapp.com/done",
"external_code": "ref_99",
"webhook": "https://yourapp.com/webhooks/nox",
"template": "onramp_instant",
"wallet": "TXyZ...abc",
"tx_hash": "0xabc123...",
"network_fee": "1.00"
}
}
Attributes
| Campo | Tipo | Template | Descrição |
|---|
quote | float | todos | Taxa de câmbio BRL→cripto efetiva utilizada |
ref_quote | float | todos | Taxa de referência mid-market |
fees | float | todos | Total de tarifas (BRL) |
currency_entry | string | todos | Moeda de origem — sempre BRL |
currency_exit_received | string | todos | Nome exibido do ativo de destino (ex: USDT (TRX)) |
currency_exit_received_code | string | todos | Código da moeda de destino |
amount_payment | float | todos | Valor em BRL pago |
amount_received | float | todos | Valor em cripto recebido |
pix_e2e | string | todos | ID end-to-end do PIX (preenchido após o pagamento) |
client_name | string | todos | Nome do cliente |
client_tax_id | string | todos | CPF ou CNPJ do cliente |
expiration | string | todos | Timestamp de expiração da sessão (ISO 8601) |
return_url | string | todos | URL de redirecionamento pós-checkout |
external_code | string | todos | Referência do lojista |
webhook | string | todos | URL de webhook |
template | string | todos | Nome do template (onramp ou onramp_instant) |
wallet | string | onramp_instant | Endereço de carteira de destino |
tx_hash | string | onramp_instant | Hash da transação on-chain da entrega |
network_fee | string | onramp_instant | Taxa de rede blockchain cobrada |
404 — transação não encontrada ou não pertence à sua conta.
Para todos os valores de status / substatus veja Statuses do Onramp.
Listar onramps
GET /v2/onramps
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) |
pix_e2e | string | Filtrar pelo ID end-to-end do PIX |
client_tax_id | string | Filtrar por CPF ou CNPJ do cliente |
wallet | string | Filtrar por endereço de carteira de destino |
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
{
"version": "v1",
"total": 10,
"limit": 20,
"offset": 0,
"results": [ ]
}
results tem o mesmo formato do response do GET individual.
