Get & List Offramps

GET /v2/offramp/ and GET /v2/offramps — retrieve a single offramp transaction or list all offramp transactions.

Covers templates: offramp (balance → BRL) and offramp_instant (external crypto deposit → BRL). Fields marked with a template name are only present for that variant.

---

Get a single offramp

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

Path parameters

Parameter	Description
id	The end2end identifier (e.g. NOXdef789)

Response 200 OK

{
  "end2end": "NOXdef789",
  "component": "success",
  "state": "DONE",
  "template": "offramp",
  "created_at": "2024-05-02T09:00:00Z",
  "updated_at": "2024-05-02T09:10: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,
    "ref_quote": 5,
    "fees": 10,
    "currency_exit": "BRL",
    "currency_entry_paid": "USDT (TRX)",
    "currency_entry_paid_code": "USDT",
    "amount_paid": 100.00,
    "amount_sent": 490.00,
    "pix_e2e": "E00038166202405020900...",
    "client_name": "Carlos Lima",
    "client_tax_id": "11122233344",
    "expiration": "2024-05-02T09:30:00Z",
    "return_url": "https://yourapp.com/done",
    "external_code": "payout_7",
    "webhook": "https://yourapp.com/webhooks/nox",
    "pix_key": "[e-mail]",
    "pix_key_type": "email"
  }
}

Attributes — offramp

Field	Type	Description
quote	integer	Effective crypto→BRL exchange rate used
ref_quote	integer	Mid-market reference rate
fees	integer	Total fees
currency_exit	string	Fiat payout currency — always BRL
currency_entry_paid	string	Crypto asset display name (e.g. USDT (TRX))
currency_entry_paid_code	string	Crypto currency code
amount_paid	float	Crypto amount debited from your balance
amount_sent	float	BRL amount the payee receives
pix_key	string	PIX key the BRL was sent to
pix_key_type	string	PIX key type (cpf, cnpj, email, phone, random)
pix_e2e	string	PIX end-to-end ID (populated after payout)
client_name	string	Payee name
client_tax_id	string	Payee CPF or CNPJ
expiration	string	Session expiration timestamp (ISO 8601)
return_url	string	Post-checkout redirect URL
external_code	string	Merchant reference
webhook	string	Webhook URL

Attributes — offramp_instant

Field	Type	Description
quote	integer	Effective crypto→BRL exchange rate used
ref_quote	integer	Mid-market reference rate
fees	integer	Total fees
currency_payment	string	Crypto currency the payer sends
currency_received	string	Fiat currency the payee receives
amount_payment	float	Crypto amount sent by the payer
amount_received	float	BRL amount the payee receives
amount_payment_display	string	Formatted display of the crypto amount
deposit_address	string	Blockchain deposit address the payer must send to
deposit_currency	string	Currency code for the deposit
exact_deposit_amount	string	Exact suffixed amount required (must be sent precisely)
tx_hash	string	On-chain transaction hash of the inbound deposit
pix_key	string	PIX key the BRL was sent to
pix_key_type	string	PIX key type (cpf, cnpj, email, phone, random)
pix_e2e	string	PIX end-to-end ID (populated after payout)
client_name	string	Payee name
client_tax_id	string	Payee CPF or CNPJ
expiration	string	Session expiration timestamp
return_url	string	Post-checkout redirect URL
external_code	string	Merchant reference
webhook	string	Webhook URL

For offramp_instant, always display exact_deposit_amount to the payer — not a rounded number. The suffixed amount is how Noxpay identifies which session a deposit belongs to.

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

For all status / substatus values see Offramp statuses.

---

List offramps

GET /v2/offramps
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)
pix_e2e	string	Filter by PIX end-to-end ID
client_tax_id	string	Filter by payee CPF or CNPJ
wallet	string	Filter by source wallet address
date_from	string	Start date filter — YYYY-MM-DD
date_to	string	End date filter — YYYY-MM-DD

Response 200 OK

{
  "version": "v1",
  "total": 5,
  "limit": 20,
  "offset": 0,
  "results": [ ]
}

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