Get & List Withdrawals

GET /v2/withdrawal/ and GET /v2/withdrawals — retrieve a single withdrawal or list all withdrawals.

A withdrawal moves funds from your Noxpay balance to a whitelisted wallet or PIX key.

---

Get a single withdrawal

GET /v2/withdrawal/{id}
Authorization: Bearer <your-api-key>

Path parameters

Parameter	Description
id	The end2end identifier (e.g. 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

Field	Type	Description
amount_discounted	float	Amount actually sent after deducting the network fee
amount_received	float	Amount originally requested
currency_received	string	Asset display name (e.g. USDT TRC20)
currency_receive_code	string	Asset code (e.g. USDT)
address	string	Destination blockchain address
tx_hash	string	On-chain transaction hash
explorer_url	string	Block explorer URL for the transaction
network_fee	string	Blockchain network fee paid
group_id	string	Whitelist group ID used for this withdrawal
notes	string	Optional notes attached to the withdrawal

404 — withdrawal not found or does not belong to your account.

For all status / substatus values see Withdrawal statuses.

---

List withdrawals

GET /v2/withdrawals
Authorization: Bearer <your-api-key>

Query parameters

Parameter	Type	Description
limit	integer	Max results per page (default: 20, max: 100)
offset	integer	Pagination offset (default: 0)
group_id	string	Filter by whitelist group ID
address	string	Filter by destination address
receive_currency_code	string	Filter by currency code (e.g. USDT, BRL)

Response 200 OK

{
  "version": "v2",
  "total": 3,
  "limit": 20,
  "offset": 0,
  "results": [ ]
}

Each item in results has the same shape as the single GET response.