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.
Crossramp Checkout
Flow: static_entry → pre_kyc → valida_id_netrin_v2 → depositpix_v2 → swap_transfer_v2 → success
| Status | Substatus | Meaning |
|---|
| Created | Collecting Amount | Customer is entering the payment amount |
| Created | Quote Ready | Rate displayed; awaiting customer confirmation |
| Created | Quote Accepted | Customer confirmed the quote |
| Created | Collecting Identity | Collecting customer CPF or CNPJ |
| Created | Confirming Identity | Customer confirming their document |
| Pending | KYC Step Up Pending | Transaction requires additional identity verification |
| Pending | Pending KYC Validation | Identity check in progress |
| Pending | Manual Review | Identity flagged for manual review |
| Pending | Awaiting Payment | PIX QR code generated; waiting for payment |
| Processing | PIX Deposit Completed | PIX payment received; conversion in progress |
| Processing | Swap Fiat → Crypto | Funds being converted to crypto |
| Success | Success | Transaction fully completed |
| Failed | Error on PIX Deposit | Error during PIX payment processing |
| Failed | Swap Fiat → Crypto Failed | Error during BRL→crypto conversion |
| Failed | KYC Step Up Denied | Identity check failed |
| Expired | PIX Deposit Expired | QR code TTL exceeded; customer did not pay |
| Cancelled | PIX Deposit Divergent Titularity | PIX sender’s CPF does not match the pre-KYC document |
| Cancelled | Quote Expired | Session expired before payment was initiated |
| Cancelled | Quote Error | Could not generate a quote |
Onramp
Templates: onramp and onramp_instant.
Flow (onramp): quote → depositpix → valida_id_netrin → swap_transfer → success
Flow (onramp_instant): quote → depositpix → valida_id_netrin → swap_transfer → saque_cripto_fireblocks_to_merchant → success
| Status | Substatus | Template | Meaning |
|---|
| Created | Quote Available | all | Rate presented to customer |
| Created | Quote Accepted | all | Customer accepted the quote |
| Pending | Awaiting PIX Deposit | all | QR code generated; waiting for payment |
| Pending | KYC Step Up Pending | all | Additional identity check required |
| Pending | Pending KYC Validation | all | Identity check in progress |
| Pending | Manual Review | all | Identity flagged for manual review |
| Pending | KYC Step Up Approved | all | Identity verified; continuing |
| Processing | PIX Deposit Completed | all | PIX received; conversion in progress |
| Processing | Swap Fiat → Crypto | all | BRL→crypto conversion in progress |
| Processing | Crypto Withdrawal Processing | onramp_instant | Sending crypto to destination wallet |
| Success | Crypto Withdrawal Completed | onramp_instant | Crypto delivered to wallet |
| Success | Success | onramp | Transaction fully completed |
| Partial Success | Crypto Withdrawal Error | onramp_instant | On-chain delivery failed after conversion; crypto credited to your balance |
| Failed | Error on Pix Deposit | all | Error during PIX payment |
| Failed | Swap Fiat → Crypto Failed | all | Error during BRL→crypto conversion |
| Failed | KYC Step Up Denied | all | Identity check failed |
| Expired | PIX Deposit Expired | all | QR code expired |
| Expired | KYC Step Up Expired | all | Identity validation session expired |
| Cancelled | PIX Deposit Divergent Titularity | all | PIX sender’s CPF does not match the pre-KYC document |
| Cancelled | Quote Error | all | Failed to generate a quote |
| Cancelled | Quote Expired | all | Quote TTL exceeded |
Offramp
Templates: offramp and offramp_instant.
Flow (offramp): quote → kyc → transfer_swap → withdrawpix → success
Flow (offramp_instant): quote → kyc → deposit_crypto_fireblocks_to_merchant → transfer_swap → withdrawpix → success
| Status | Substatus | Template | Meaning |
|---|
| Created | Quote Available | all | Rate presented |
| Created | Quote Accepted | all | Customer accepted the quote |
| Created | Collecting Identity | all | Collecting payee CPF or CNPJ |
| Created | Identity Received | all | KYC document received |
| Pending | Awaiting Crypto Deposit | offramp_instant | Waiting for payer to deposit crypto |
| Processing | Crypto Deposit Completed | offramp_instant | On-chain deposit confirmed |
| Processing | Swap Crypto → Fiat | all | Crypto→BRL conversion in progress |
| Processing | PIX Withdrawal Processing | all | BRL payout being sent to the payee’s PIX key |
| Partial Success | PIX Withdrawal Completed | all | PIX payout confirmed by the payment network |
| Success | Success | all | Transaction fully completed |
| Failed | Swap Crypto → Fiat Failed | all | Error during crypto→BRL conversion |
| Failed | Error on PIX Withdrawal | all | PIX payout failed |
| Failed | KYC Step Up Denied | all | Identity check failed |
| Cancelled | Crypto Deposit Expired | offramp_instant | Payer did not deposit crypto in time |
| Cancelled | Crypto Deposit Cancelled | offramp_instant | Crypto deposit error |
| Cancelled | PIX Withdrawal Divergent Titularity | all | Payout rejected — titularity mismatch |
| Cancelled | Quote Error | all | Failed to generate a quote |
| Cancelled | Quote Expired | all | Quote TTL exceeded |
Withdrawal
Flow: saque_cripto_fireblocks_to_merchant_dash → success_withdrawl_dash
| Status | Substatus | Meaning |
|---|
| Created | Crypto Balance Withdrawal Pending Acceptance | Awaiting acceptance of the withdrawal request |
| Pending | Crypto Balance Withdrawal Queued | Queued for policy approval |
| Processing | Crypto Balance Withdrawal Processing | Transfer submitted; awaiting on-chain confirmation |
| Success | Withdrawal Completed | Transaction fully completed |
| Failed | Crypto Balance Withdrawal Error | Error during transfer; balance reverted |
| Failed | Crypto Balance Withdrawal Failed | Transfer failed on-chain; balance reverted |
| Cancelled | Crypto Balance Withdrawal Cancelled | Withdrawal cancelled; balance unaffected |
