Skip to main content

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.

Templates come first

Every ramp transaction runs on top of a Template. You configure Templates — the rules for a corridor — and then transactions simply follow those rules when they are initiated. Think of a Template as a product configuration: “PIX-to-USDT, fees of X%, minimum R50,maximumR50, maximum R50,000.” Once set up, every transaction through that corridor inherits those rules automatically.

Compliance layer — applies to all four variants

All four ramp variants share the same compliance requirements. These run automatically and cannot be bypassed.

Identity verification

Every transaction requires the payee’s Brazilian tax ID (CPF for individuals, CNPJ for businesses) before it proceeds. The document is validated for format and then checked against a Brazilian identity database.
  • If the document is invalid or unregistered, the transaction is cancelled before any money moves.
  • Business documents (CNPJ) go through an additional business identity check.
  • A customer who has previously transacted is recognised by their document — verification completes faster on repeat transactions.

Titularity (onramp variants)

On transactions where the customer pays via PIX, Noxpay checks that the CPF of the PIX sender matches the document collected at identity verification. Payments from a third-party account are blocked and the transaction is set to UNCOMPLIANT.

Daily limit per payee

The maximum BRL equivalent that a single payee (identified by CPF/CNPJ) can transact across all ramp variants in a 24-hour window is R$ 50,000. Transactions that would breach this limit are rejected at initiation.

Monthly KYC tiers per payee

Noxpay applies a progressive compliance requirement based on cumulative monthly BRL volume per payee:
Monthly volume (per payee)Requirement
Up to R$ 50,000Standard identity check (CPF/CNPJ verification)
R50,001R 50,001 – R 500,000Enhanced KYC: payee must submit financial documentation before the transaction is processed
Above R$ 500,000Blocked — contact Noxpay to discuss institutional arrangements
When a payee crosses the R$ 50,000 monthly threshold, the next transaction is held at the identity verification stage until enhanced documents are reviewed. You receive a webhook notification with the hold reason and instructions for the payee.

Transaction lifecycle

Every ramp transaction moves through a predictable set of states. The exact stages differ between variants — see each variant’s page for the full step-by-step — but the state model is shared:
StateWhat it means
CreatedTransaction initiated, awaiting customer action
PendingIdentity verification or deposit confirmation in progress
ProcessingConversion or PIX transfer in progress
SuccessCompleted — crypto credited, balance debited, or PIX delivered
Partial SuccessConversion succeeded but on-chain delivery failed (Onramp Instant only) — crypto credited to balance
ExpiredCustomer did not pay or deposit within the quote window
FailedSystem error
CancelledIdentity verification failed or document was invalid
UNCOMPLIANTPIX sender CPF does not match the pre-KYC document

How funds flow — by variant

Onramp — Customer pays BRL via PIX → Noxpay converts → crypto credited to your Noxpay available balance. No blockchain transaction occurs; the credit is internal. Onramp Instant — Customer pays BRL via PIX → Noxpay converts → crypto broadcast on-chain to the wallet address specified at transaction creation. If on-chain delivery fails after a successful conversion, the transaction settles to Partial Success and the crypto is credited to your balance instead. Offramp — Noxpay reserves the required crypto from your available balance at quote creation → converts it to BRL → sends BRL via PIX to the payee. If the transaction fails or expires, the reserved crypto is released back to available. Offramp Instant — A unique deposit address is generated for the transaction. The payer deposits crypto on-chain to that address → Noxpay converts → BRL sent via PIX to the payee. Your Noxpay balance is not involved.

Your account as the liquidity backbone (Offramp)

For the standard Offramp variant, your Borderless Account is what makes it possible. When a transaction is initiated, Noxpay moves the required crypto from your available balance into blocked. On successful conversion and PIX delivery, that amount is permanently debited. If the transaction fails or expires, it returns to available. Keep your Borderless Account funded with enough stablecoin to cover your expected offramp volume. Insufficient balance causes new offramp transactions to be rejected.
Monitor your Borderless Account balance regularly if you run high-volume offramp flows. Running low will interrupt your users’ ability to cash out.

Dashboard

Onramp transactions appear in Noxpay Infra → Onramps. Offramp transactions appear in Noxpay Infra → Offramps. Each row shows the NOX... transaction ID, status, BRL and crypto amounts, currency, and timestamp. Settled transactions also appear in Account → Statement as debit or credit entries linked to the originating NOX... ID.

Webhooks

A webhook is sent at every stage transition on all variants. The payload follows the standard Noxpay format and includes amounts, rates, fees, the payee document, and — where applicable — on-chain transaction hashes. Configure the webhook URL per-template or per-transaction at creation time.