Offramp process flow support:

[*] - Onramp Money transaction initiation flow is supported only for networks:

ethereum, bsc, tron, polygon, solana, arbitrum, base, optimism, vechain, ethereumclassic, theta, fantom, cortex, avaxc, ronin, celo, rsk, moonriver, moonbeam, zksync, worldchain

The token list can be filtered using Only Crypto Networks (offramp) parameter.

Transaction Initiation Flow

Facilitate users with seamless crypto transfers without relying on manual QR code scanning or wallet address copy-pasting. This flow is recommended for integrations on mobile wallets and wallet-connected web applications.

If the offrampCashoutRedirectUrl is passed in the widget, the system will use the Transaction Initiation flow.

• Redirect to Partner System:
  At a certain point during the Transaction Initiation flow, the user will be redirected to the partner’s system. This redirect will happen to the URL defined in the offrampCashoutRedirectUrl parameter.
• Forwarded Query Parameters:
  When the redirect occurs, the following information will be forwarded as query parameters to the partner system:
  • offramp: Provider ID
  • partnerContext: Context or metadata provided by the partner, if any
  • providerWalletAddress: Target wallet address (where the crypto needs to be sent to)
  • wallet: Source wallet address (where the crypto is expected to be coming from, if it's known)
  • transactionId: Onramper transaction Id
  • sourceCurrency: Source currency ID for the transaction
  • targetCurrency: Target currency ID for the transaction
  • inAmount: Source crypto amount to be transferred.
  • paymentMethod: The ID of the payment method used for the fiat payout.
  • totalFee: Combined fees for the transaction in sourceCurrency
  • countryCode: ISO-3166 alpha-2 code of the country from where the transaction was placed
  • exchangeRate: The effective exchange rate that is applied for this transaction (inAmount / outAmount)\
    \
    
    The partner system will use this information to guide the user through the offramping process.

Crypto Transfer

• Once the user is redirected, they will be responsible for handling the crypto transfer to the provided wallet.

Transaction Confirmation:

• After the crypto transfer is completed, the partner system must call the transactions/confirm/{type} endpoint to confirm the crypto transfer.

QR-Code Flow

If the offrampCashoutRedirectUrl is not provided in the widget, and the selected offramp supports the QR-code process, the system will automatically switch to the QR-code flow.
In this flow, the user will be shown a screen where they can copy-paste the amount and wallet address where the user has to send crypto, as well as a QR code that can be scanned using a wallet to initiate the transaction.

📘

Key Points to Remember

• The offrampCashoutRedirectUrl is the key differentiator between the two flows. If it’s included, the system initiates the Transaction Initiation flow; otherwise, if the offramp supports it, the QR code flow will be used.
• For the Transaction Initiation flow, the partner will handle the crypto transfer after being redirected, and the system will confirm the transfer using the transactions/confirm/{type} endpoint.