Offramp process flow support:

Transaction Initiation Flow

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.
  • wallet: Wallet address for the crypto transaction
  • 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.
    
    
    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.

Manual Flow

If the offrampCashoutRedirectUrl is not provided in the widget, and the selected offramp supports the manual process, the system will automatically switch to the manual flow.
In this flow, the user will not be redirected to a partner system, and all processes will happen within the current system, requiring manual steps to complete the offramping.

📘

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 manual 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.