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.
Um saque move fundos do seu saldo Noxpay para uma carteira ou chave PIX na whitelist.
Consultar um saque individual
GET /v2/withdrawal/{id}
Authorization: Bearer <your-api-key>
Parâmetros de caminho
| Parâmetro | Descrição |
|---|
id | O identificador end2end (ex: NOXwdr001) |
Response 200 OK
{
"end2end": "NOXwdr001",
"component": "success_withdrawl_dash",
"state": "DONE",
"template": "withdraw_dash_same_curr",
"created_at": "2024-05-03T14:00:00Z",
"updated_at": "2024-05-03T14:05:00Z",
"status": { "en": "Success", "pt": "Sucesso" },
"substatus": { "en": "Withdrawal Completed", "pt": "Saque Concluído" },
"message": {
"en": "Withdrawal completed successfully",
"pt": "Saque concluído com sucesso"
},
"error_message": { "en": "", "pt": "" },
"attributes": {
"amount_discounted": 99.00,
"amount_received": 100.00,
"currency_received": "USDT TRC20",
"currency_receive_code": "USDT",
"address": "TXyZ...abc",
"tx_hash": "0xabc123...",
"explorer_url": "https://tronscan.org/#/transaction/0xabc123",
"network_fee": "1.00",
"group_id": "wl-group-id",
"notes": "Monthly payout"
}
}
Attributes
| Campo | Tipo | Descrição |
|---|
amount_discounted | float | Valor efetivamente enviado após deduzir a taxa de rede |
amount_received | float | Valor originalmente solicitado |
currency_received | string | Nome exibido do ativo (ex: USDT TRC20) |
currency_receive_code | string | Código do ativo (ex: USDT) |
address | string | Endereço blockchain de destino |
tx_hash | string | Hash da transação on-chain |
explorer_url | string | URL do block explorer para a transação |
network_fee | string | Taxa de rede blockchain paga |
group_id | string | ID do grupo de whitelist usado para este saque |
notes | string | Notas opcionais anexadas ao saque |
404 — saque não encontrado ou não pertence à sua conta.
Para todos os valores de status / substatus veja Statuses de Withdrawal.
Listar saques
GET /v2/withdrawals
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) |
group_id | string | Filtrar por ID do grupo de whitelist |
address | string | Filtrar por endereço de destino |
receive_currency_code | string | Filtrar por código de moeda (ex: USDT, BRL) |
Response 200 OK
{
"version": "v2",
"total": 3,
"limit": 20,
"offset": 0,
"results": [ ]
}
results tem o mesmo formato do response do GET individual.
