Onramper

https://docs.onramper.com/docs
Admin
Onramper is a fiat-to-crypto aggregator that integrates over 30 on-ramp providers, enabling users to...
Tokens:26,751
Snippets:337
Trust Score:9.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Signed GET Request Example

Source: https://docs.onramper.com/docs/api-sign-requests-v2

A cURL example demonstrating the required headers for a signed GET request to the Onramper API.

```bash
curl -X GET "https://api.onramper.com/quotes/usd/btc?amount=100" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "x-onramper-signature: v2:MEUCIQDKZf3L8gT2x..." \
  -H "x-onramper-timestamp: 2024-01-15T10:30:00.000Z" \
  -H "x-onramper-nonce: 550e8400-e29b-41d4-a716-446655440000"
```

--------------------------------

### Example Widget URL with Swaps Enabled

Source: https://docs.onramper.com/docs/widget-swaps

A complete integration URL example including the required API key and swap parameters.

```text
https://buy.onramper.com?apiKey=pk_prod_01HETEQF46GSK6BS5JWKDF31BT&supportSwap=true&mode=swap
```

--------------------------------

### Configure Widget with API Key

Source: https://docs.onramper.com/docs/supported-widget-parameters

Example URL structure for initializing the Onramper widget with a required API key.

```text
https://buy.onramper.com/?apiKey=pk_prod_01HETEQF46GSK6BS5JWKDF31BT
```

--------------------------------

### Canonical String Example

Source: https://docs.onramper.com/docs/widget-sign-a-url-v2

A representation of the 8-line canonical string required for V2 signature generation.

```text
ONRAMPER-SIG-V2
2024-01-15T10:00:00.000Z
550e8400-e29b-41d4-a716-446655440000
GET
/
apiKey=pk_test_xxx&defaultAmount=100&wallets=btc%3Abc1qxy...

e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
```

--------------------------------

### GET /

Source: https://docs.onramper.com/docs/supported-widget-parameters

Configures the Onramper widget behavior using query parameters.

```APIDOC
## GET /

### Description
Configures the Onramper widget by appending query parameters to the base URL.

### Method
GET

### Endpoint
https://buy.onramper.com/

### Parameters
#### Query Parameters
- **defaultPaymentMethod** (string) - Optional - The ID of the preferred payment method.
- **onlyOnramps** (string) - Optional - A comma-separated list of allowed onramps.
- **excludePaymentMethods** (string) - Optional - A comma-separated list of payment methods to exclude.
- **wallets** (string) - Optional - A string of wallet addresses formatted as 'TokenID:Address' separated by commas.
- **networkWallets** (string) - Optional - A string of network-level wallet addresses formatted as 'NetworkID:Address'.
- **walletAddressTags** (string) - Optional - A string of destination tags or memos formatted as 'TokenID:Tag' separated by commas.
- **endUserIpHash** (string) - Optional - A SHA256 lowercase hex digest of the end user's IP address for session binding.
- **supportRecurringPayments** (boolean) - Optional - Set to 'true' to enable recurring cryptocurrency purchase plans.
```

--------------------------------

### GET /quotes/{currency}/{crypto}

Source: https://docs.onramper.com/docs/api-sign-requests-v2

Example of a signed GET request to the Onramper quotes endpoint.

```APIDOC
## GET /quotes/{currency}/{crypto}

### Description
Retrieves a quote for a currency pair. This request must be signed using the V2 signing protocol.

### Method
GET

### Endpoint
https://api.onramper.com/quotes/{currency}/{crypto}

### Parameters
#### Path Parameters
- **currency** (string) - Required - The source currency code.
- **crypto** (string) - Required - The target cryptocurrency code.

#### Query Parameters
- **amount** (number) - Required - The amount to exchange.

### Request Headers
- **Authorization** (string) - Required - Your API Key.
- **x-onramper-signature** (string) - Required - The V2 signature string.
- **x-onramper-timestamp** (string) - Required - ISO 8601 timestamp.
- **x-onramper-nonce** (string) - Required - A unique UUID for the request.
```

--------------------------------

### GET https://buy.onramper.com/

Source: https://docs.onramper.com/docs/integration-steps

Directly initiate an onramp transaction by skipping the transaction screen.

```APIDOC
## GET https://buy.onramper.com/

### Description
Initiates an onramp transaction while skipping the Onramper transaction screen, redirecting the user directly to the provider's checkout UI.

### Method
GET

### Endpoint
https://buy.onramper.com/

### Parameters
#### Query Parameters
- **skipTransactionScreen** (boolean) - Required - Indicates whether to skip the transaction screen (true).
- **txnAmount** (number) - Required - Specifies the requested fiat amount.
- **txnFiat** (string) - Required - The Fiat Currency ID.
- **txnCrypto** (string) - Required - The Crypto Currency ID.
- **txnType** (string) - Optional - Indicates the transaction type (e.g. buy).
- **txnPaymentMethod** (string) - Optional - The Payment Method ID.
- **txnOnramp** (string) - Optional - The ID of the provider processing the transaction.
- **txnRedirect** (boolean) - Optional - Allows direct redirection to the provider’s widget.

### Request Example
https://buy.onramper.com/?skipTransactionScreen=true&txnAmount=300&txnFiat=eur&txnCrypto=btc&txnPaymentMethod=creditcard&txnRedirect=true
```

--------------------------------

### GET https://buy.onramper.com/ (Offramp)

Source: https://docs.onramper.com/docs/integration-steps

Directly initiate an offramp transaction by skipping the transaction screen.

```APIDOC
## GET https://buy.onramper.com/

### Description
Initiates an offramp transaction while skipping the Onramper transaction screen, redirecting the user directly to the provider's checkout UI.

### Method
GET

### Endpoint
https://buy.onramper.com/

### Parameters
#### Query Parameters
- **skipTransactionScreen** (boolean) - Required - Indicates whether to skip the transaction screen (true).
- **txnType** (string) - Required - Indicates the transaction type (e.g. sell).
- **txnAmount** (number) - Required - Specifies the requested crypto amount.
- **txnFiat** (string) - Required - The Fiat Currency ID.
- **txnCrypto** (string) - Required - The Crypto Currency ID.
- **txnPaymentMethod** (string) - Optional - The Payment Method ID.
- **txnOfframp** (string) - Optional - The ID of the provider processing the transaction.
- **txnRedirect** (boolean) - Optional - Allows direct redirection to the provider’s widget.

### Request Example
https://buy.onramper.com/?skipTransactionScreen=true&txnType=sell&txnAmount=0.08&txnFiat=eur&txnCrypto=eth&txnPaymentMethod=sepabanktransfer&txnRedirect=true
```

--------------------------------

### signWidgetUrlV2

Source: https://docs.onramper.com/docs/widget-sign-a-url-v2

A TypeScript function example for generating a signed widget URL using the V2 signature scheme.

```APIDOC
## signWidgetUrlV2

### Description
Signs a widget URL server-side using the V2 signature scheme to ensure the integrity of sensitive parameters like wallet addresses and API keys.

### Parameters
- **baseUrl** (string) - The base URL of the widget.
- **privateKeyPem** (string) - The private key in PEM format used for signing.
- **fields** (object) - The parameters to be included in the URL and signed, including `apiKey`, `wallets`, and optional `endUserIpHash`.

### Code Example
```typescript
const widgetUrl = signWidgetUrlV2({
  baseUrl: 'https://buy.onramper.com',
  privateKeyPem: process.env.PRIVATE_KEY!,
  fields: {
    apiKey: 'YOUR_API_KEY',
    wallets: 'btc:bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh',
    endUserIpHash: sha256(userIp),
  },
});
```
```

--------------------------------

### Include Signature in API Request

Source: https://docs.onramper.com/docs/sign-api-request

Example of the request body structure including the generated signature and signContent.

```TypeScript
{
   body: {
    signature:
      'a1b8609646d0f37d31970fa37e6ae37215aaada91be418b09575dbe8d510d04d',
    signContent:
      'walletAddress=1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa&walletMemo=1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2',
    onramp: 'coinify',
    source: 'eur',
    destination: 'btc',
    amount: 200,
    type: 'buy',
    paymentMethod: 'creditcard',
    network: 'bitcoin',
    uuid: '6756256e-d07f-42f0-a873-4d992eec09',
    originatingHost: 'buy.onramper.dev',
    partnerContext: '123-CLIENT-ORDER-ID-456',
    wallet: {
      address: '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',
      memo: '1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2',
    },
    allowOnrampPmSelection: false,
    supportedParams: {
      theme: {
        isDark: false,
        themeName: 'light-theme',
        primaryColor: '#241D1C',
        secondaryColor: '#FFFFFF',
        primaryTextColor: '#141519',
        secondaryTextColor: '#6B6F80',
        cardColor: '#F6F7F9',
      },
      partnerData: {
        redirectUrl: {
          success: 'http%3A%2F%2Fredirecturl.com%2F',
        },
      },
    },
  },
}
```

--------------------------------

### GET https://buy.onramper.com

Source: https://docs.onramper.com/docs/supported-widget-parameters

The Onramper widget is initialized via a URL with various optional query parameters to control the user experience.

```APIDOC
## GET https://buy.onramper.com

### Description
Initializes the Onramper widget with specific configuration settings passed via query parameters.

### Method
GET

### Endpoint
https://buy.onramper.com

### Parameters
#### Query Parameters
- **mode** (string) - Optional - Comma-separated list of modes (buy, sell, swap). Defaults to buy.
- **apiKey** (string) - Optional - Your Onramper API key.
- **partnerContext** (string) - Optional - Unique identifier for the session, included in webhooks.
- **successRedirectUrl** (string) - Optional - URL-encoded URL to redirect to after a successful transaction.
- **failureRedirectUrl** (string) - Optional - URL-encoded URL to redirect to after a failed transaction.
- **defaultFiat** (string) - Optional - Default fiat currency code (e.g., USD).
- **onlyFiats** (string) - Optional - Comma-separated list of allowed fiat currencies.
- **excludeFiats** (string) - Optional - Comma-separated list of excluded fiat currencies.
- **defaultAmount** (number) - Optional - Pre-populated amount for the fiat input.
- **defaultCrypto** (string) - Optional - Default cryptocurrency Onramper ID.
- **excludeCryptos** (string) - Optional - Comma-separated list of excluded cryptocurrency Onramper IDs.
- **onlyCryptos** (string) - Optional - Comma-separated list of allowed cryptocurrency Onramper IDs.
- **excludeCryptoNetworks** (string) - Optional - Comma-separated list of excluded network Onramper IDs.
- **onlyCryptoNetworks** (string) - Optional - Comma-separated list of allowed network Onramper IDs.
```

--------------------------------

### GET /quotes/{currency}/{crypto}

Source: https://docs.onramper.com/docs/checkout-v2

Retrieves available quotes for a currency pair, requiring a platform parameter to ensure compatibility with providers.

```APIDOC
## GET /quotes/{currency}/{crypto}

### Description
Fetches quotes for a specific currency and cryptocurrency pair. The platform parameter is required to filter providers that require whitelisting.

### Method
GET

### Endpoint
/quotes/{currency}/{crypto}

### Parameters
#### Path Parameters
- **currency** (string) - The fiat currency code.
- **crypto** (string) - The cryptocurrency code.

#### Query Parameters
- **amount** (number) - The amount to purchase.
- **paymentMethod** (string) - The payment method used.
- **platform** (string) - The platform where the integration runs (e.g., web, mobile-ios, mobile-android, webview-ios, webview-android, browser-extension, desktop).
```

--------------------------------

### Retrieve quotes with platform parameter

Source: https://docs.onramper.com/docs/checkout-v2

Include the platform parameter in the GET request to ensure providers requiring whitelisting are correctly filtered.

```http
GET /quotes/usd/btc?amount=100&paymentMethod=creditcard&platform=mobile-ios
```

--------------------------------

### Configure Wallet Initiation Flow

Source: https://docs.onramper.com/docs/supported-widget-parameters-offramp

Redirects the user to your system at the point where they need to send crypto, bypassing the standard QR code flow.

```text
https://buy.onramper.com?offrampCashoutRedirectUrl=example.com
```

--------------------------------

### Enable Swaps via URL Parameters

Source: https://docs.onramper.com/docs/widget-swaps

Add these query parameters to the widget URL to activate the swap functionality.

```text
supportSwap=true&mode=swap
```

--------------------------------

### Prepare the Signature Content

Source: https://docs.onramper.com/docs/sign-api-request

Define the string containing the wallet address and memo that requires signing.

```TypeScript
const signContent = 'walletAddress=1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa&walletMemo=1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2';
```

--------------------------------

### Set default source amount

Source: https://docs.onramper.com/docs/supported-swap-parameters

Pre-fills the source amount; requires the swap_defaultSource parameter to be set.

```text
https://buy.onramper.com/?mode=swap&swap_defaultSource=usdc_ethereum&swap_defaultAmount=140
```

--------------------------------

### Configure MCP Server for AI Editors

Source: https://docs.onramper.com/docs/mcp

Add the Onramper MCP server URL to the configuration files of Cursor, Windsurf, or Claude Desktop to enable integration.

```json
{
  "mcpServers": {
    "onramper": {
      "url": "https://docs.onramper.com/mcp"
    }
  }
}
```

--------------------------------

### Wallet Initiation Flow

Source: https://docs.onramper.com/docs/supported-widget-parameters-offramp

Initiate your wallet's in-built flow to send crypto instead of showing a QR code.

```APIDOC
## Wallet Initiation Flow

### Endpoint
https://buy.onramper.com

### Query Parameters
- **offrampCashoutRedirectUrl** (string) - The URL to redirect the user to when they need to send crypto.
```

--------------------------------

### Webhook JSON Payload Structure

Source: https://docs.onramper.com/docs/optional-set-up-webhooks

Example of the JSON object sent to your webhook endpoint when a transaction status changes.

```json
{
    "apiKey": "pk_test_01K4MF4ZBPGDCV3GFFNA684NT0",
    "country": "us",
    "inAmount": 100,
    "onramp": "gatefi",
    "onrampTransactionId": "8bf94c80-test-aabb-851-143835984d1d",
    "outAmount": 3.83527521,
    "paymentMethod": "creditcard",
    "partnerContext": "",
    "sourceCurrency": "usd",
    "status": "pending",  	
    "statusDate": "2023-08-09T13:15:18.725Z",
    "targetCurrency": "sol",
    "transactionId": "01H7D547TESTV2RQJ52ZAB7WF7",
    "transactionType": "buy",
    "transactionHash": "",
    "walletAddress": "testG15oy66q7cU6aNige54PxLLEfGZvRsAADjbF7D4",
    "partnerFee": "0.01",
    "alternateRouteData": {
      "finalCurrency": "ccc_solana",
      "finalAmount": 3000.3302,
      "intermediateCurrencyId": "sol",
      "alternateRouteProvider": "moongate",
    }

}
```

--------------------------------

### Configure Widget Modes

Source: https://docs.onramper.com/docs/supported-widget-parameters

Specify enabled modes as a comma-separated string to determine tab order.

```text
https://buy.onramper.com?mode=buy

https://buy.onramper.com?mode=buy,sell

https://buy.onramper.com?mode=sell

https://buy.onramper.com?mode=buy,sell,swap
```

--------------------------------

### Prepare the string to be signed

Source: https://docs.onramper.com/docs/signing-widget-url

Define the subset of sensitive URL parameters that require signing.

```typescript
const signContent = 'wallets=btc:1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71,eth:1Lbcfr7sAUTEFCgdQo3HTMTkV8LK4ZnX71&networkWallets=ethereum:1BvBMSEYstWetqTFn5wrwrhGFryetusJaNVN2,bitcoin:1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2&walletAddressTags=btc:1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2,eth:1BvBMSEYstWetqTFn5wrwrhGFryetusJaNVN2'
```

--------------------------------

### Enable Recurring Payments

Source: https://docs.onramper.com/docs/supported-widget-parameters

Activate the beta recurring payments feature by appending supportRecurringPayments=true to the URL.

```text
https://buy.onramper.com/?supportRecurringPayments=true
```

--------------------------------

### Widget Configuration Parameters

Source: https://docs.onramper.com/docs/supported-widget-parameters-offramp

A list of available URL parameters to configure the offramp widget behavior.

```APIDOC
## Widget Configuration Parameters

### Parameters
- **sell_onlyCryptoNetworks** (string) - Limit the blockchain networks to be displayed.
- **sell_defaultPaymentMethod** (string) - The default payment method to be displayed.
- **sell_excludePaymentMethods** (string) - Payment Methods to be excluded.
- **onlyOfframps** (string) - Limit the offramps to be displayed.
- **sell_isAmountEditable** (boolean) - Determine whether crypto amount should be editable.
- **sell_recommendation** (string) - Override default ranking engine with specific offramp.
- **sell_popularCryptos** (string) - A comma-separated list of crypto ids to be displayed at the top of the source selection dropdown.
- **sell_maxAvailableCrypto** (number) - The maximum amount of available crypto for user to sell.
- **offrampCashoutRedirectUrl** (string) - URL to redirect the user to for the wallet initiation flow.
- **sell_defaultFiat** (string) - Set a default fiat currency to be displayed.
- **sell_onlyFiats** (string) - Force one or multiple fiat currencies in your widget.
- **sell_excludeFiats** (string) - Omit certain fiat currencies.
- **sell_defaultAmount** (number) - Pre-populate the fiat currency input with a desired amount (used with sell_defaultFiat).
```

--------------------------------

### Swap Widget Configuration Parameters

Source: https://docs.onramper.com/docs/supported-swap-parameters

Parameters used to configure the behavior of the Onramper swap widget via URL query strings.

```APIDOC
## Swap Widget URL Parameters

### Description
These parameters are used to configure the Onramper swap widget by appending them to the widget URL.

### Parameters
#### Query Parameters
- **swap_targetWallets** (string) - Optional - Defines target wallet addresses for individual tokens. Format: `TOKEN_ID:address`. Multiple values separated by commas.
- **swap_targetNetworkWallets** (string) - Optional - Specifies a single target wallet address for all tokens within a specific blockchain network. Format: `NETWORK_ID:address`. Multiple values separated by commas.
- **swap_excludeCryptos** (string) - Optional - A comma-separated list of Onramper IDs for cryptocurrencies to exclude from the widget.
- **swap_onlyCryptos** (string) - Optional - A comma-separated list of Onramper IDs for cryptocurrencies to exclusively display in the widget.
- **swap_excludeCryptoNetworks** (string) - Optional - A comma-separated list of Onramper IDs for crypto networks to exclude from the widget.
- **swap_onlyCryptoNetworks** (string) - Optional - A comma-separated list of Onramper IDs for crypto networks to exclusively display in the widget.

### Request Example
https://buy.onramper.com?mode=swap&swap_excludeCryptos=BTC,ETH&swap_onlyCryptoNetworks=ethereum,polygon
```

--------------------------------

### Configure Network Wallets

Source: https://docs.onramper.com/docs/supported-widget-parameters

Use networkWallets to provide a wallet address that functions across multiple currencies on a specific network.

```text
https://buy.onramper.com/?networkWallets=ETHEREUM:0xb794f5ea0ba39494ce839613fffba74279579268
```

--------------------------------

### Set default source token

Source: https://docs.onramper.com/docs/supported-swap-parameters

Configures the initial source token displayed in the widget.

```text
https://buy.onramper.com/?mode=swap&swap_defaultSource=usdc_ethereum
```

--------------------------------

### POST /checkout/v2/intent

Source: https://docs.onramper.com/docs/checkout-v2

Initiates a purchase intent by providing a hashed user IP address. Returns a redirect URL and session ID for the checkout flow.

```APIDOC
## POST /checkout/v2/intent

### Description
Initiates a purchase intent. The backend must hash the user's IP with SHA256 and provide it to the endpoint.

### Method
POST

### Endpoint
/checkout/v2/intent

### Response
#### Success Response (200)
- **redirectUrl** (string) - The URL to redirect the user's browser to.
- **sessionId** (string) - The unique identifier for the checkout session.
```

--------------------------------

### Configure Wallet Addresses

Source: https://docs.onramper.com/docs/supported-widget-parameters

Pass user wallet addresses to the widget using the wallets parameter, formatted as TokenID:Address.

```text
btc:3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5
```

```text
wallets=btc:3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5,ETH:0xb794f5ea0ba39494ce839613fffba74279579268
```

```text
https://buy.onramper.com?wallets=btc:3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5,ETH:0xb794f5ea0ba39494ce839613fffba74279579268
```

--------------------------------

### Configure Fiat Currencies

Source: https://docs.onramper.com/docs/supported-widget-parameters

Set default, allowed, or excluded fiat currencies for the widget.

```text
https://buy.onramper.com?defaultFiat=USD
```

```text
https://buy.onramper.com?onlyFiats=USD,EUR
```

```text
https://buy.onramper.com?excludeFiats=USD,EUR
```

--------------------------------

### Configure Redirect URLs

Source: https://docs.onramper.com/docs/supported-widget-parameters

Set URLs for successful or failed transaction redirects. Ensure the URLs are URL-encoded.

```text
https://buy.onramper.com?apiKey=pk_prod_01HETEQF46GSK6BS5JWKDF31BT&successRedirectUrl=https%3A%2F%2Fonramper.com%2F
```

```text
https://buy.onramper.com?apiKey=pk_prod_01HETEQF46GSK6BS5JWKDF31BT&failureRedirectUrl=https%3A%2F%2Fonramper.com%2F
```

--------------------------------

### Define Target Wallets

Source: https://docs.onramper.com/docs/supported-swap-parameters

Specify target wallet addresses for individual tokens using the swap_targetWallets parameter.

```text
BTC:3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5
```

```text
BTC:3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5,ETH:0xb794f5ea0ba39494ce839613fffba74279579268.
```

--------------------------------

### Widget Configuration Parameters

Source: https://docs.onramper.com/docs/supported-widget-parameters

A list of supported parameters that can be used to configure the Onramper widget behavior and appearance.

```APIDOC
## Widget Parameters

### Parameters

- **defaultPaymentMethod** (string) - The default payment method to be displayed. Leave blank for auto-determination.
- **excludePaymentMethods** (string) - Payment Methods to be excluded.
- **onlyOnramps** (string) - Limit the onramps to be displayed.
- **wallets** (string) - The wallet address(-es) to be passed to the widget.
- **networkWallets** (string) - Multiple wallet addresses for use with all tokens supported by a single blockchain network.
- **walletAddressTags** (string) - String of wallet address tags (destination tags/memos).
- **endUserIpHash** (string) - SHA256 hash of the end user's IP. Binds the checkout session to that IP (Signature V2 only).
- **enableCountrySelector** (boolean) - Display the country selector.
- **uuid** (string) - UUID to track the user’s session or device.
- **redirectAtCheckout** (boolean) - Redirect to provider in current tab. Defaults to false.
- **hideTopBar** (boolean) - Removes the top header of the main page.
- **email** (string) - A URL-encoded email address of the customer.
- **popularCryptos** (string) - A comma-separated list of crypto IDs to be displayed at the top of the destination selection dropdown.
- **preventTxnClose** (boolean) - Allows you to disable the X icon in the iFrame providers.
- **hideIframeHeader** (boolean) - Allows you to completely disable the header for iFrame ramps.
```

--------------------------------

### Configure Redirect at Checkout

Source: https://docs.onramper.com/docs/supported-widget-parameters

Controls whether the provider opens in the same tab or a new browser tab.

```text
https://buy.onramper.com/?redirectAtCheckout=true
```

--------------------------------

### Configure Default Amount

Source: https://docs.onramper.com/docs/supported-widget-parameters

Pre-populate the fiat input field when used with defaultFiat.

```text
https://buy.onramper.com?defaultFiat=EUR&defaultAmount=125
```

--------------------------------

### Sign a Widget URL with V2

Source: https://docs.onramper.com/docs/widget-sign-a-url-v2

Use this function to generate a signed URL by providing the base URL, private key, and the fields to be signed. Ensure the private key is stored securely in environment variables.

```typescript
const widgetUrl = signWidgetUrlV2({
  baseUrl: 'https://buy.onramper.com',
  privateKeyPem: process.env.PRIVATE_KEY!,
  fields: {
    apiKey: 'YOUR_API_KEY',
    wallets: 'btc:bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh',
    endUserIpHash: sha256(userIp),
  },
});
```

--------------------------------

### POST /checkout/v2/intent

Source: https://docs.onramper.com/docs/checkout-v2

Creates a new checkout intent session. Requires a signed request and a hashed end-user IP address.

```APIDOC
## POST /checkout/v2/intent

### Description
Creates a checkout intent to generate a redirect URL for the user. The request must be signed using the V2 signing helper.

### Method
POST

### Endpoint
/checkout/v2/intent

### Request Body
- **onramp** (string) - Required - The onramp provider identifier
- **source** (string) - Required - Source currency code
- **destination** (string) - Required - Destination currency code
- **amount** (number) - Required - Transaction amount
- **type** (string) - Required - Transaction type (e.g., 'buy')
- **country** (string) - Required - User country code
- **paymentMethod** (string) - Required - Payment method identifier
- **network** (string) - Required - Blockchain network
- **wallet** (object) - Required - Wallet details including address
- **endUserIpHash** (string) - Required - SHA256 hash of the end user's IP address
- **platform** (string) - Required - Integration platform identifier

### Response
#### Success Response (200)
- **redirectUrl** (string) - The URL to redirect the user to for completing the session
```

--------------------------------

### TypeScript Implementation for V2 Signing

Source: https://docs.onramper.com/docs/widget-sign-a-url-v2

A complete implementation using Node.js crypto to generate a signed widget URL.

```typescript
import { createHash, createPrivateKey, randomUUID, sign } from 'crypto';

function sha256(data: string): string {
  return createHash('sha256').update(data).digest('hex');
}

interface SignWidgetUrlOptions {
  baseUrl: string;
  privateKeyPem: string;
  fields: Record<string, string>;  // All signed fields — apiKey MUST be included
  expiryMinutes?: number;
}

function signWidgetUrlV2(options: SignWidgetUrlOptions): string {
  const { baseUrl, privateKeyPem, fields, expiryMinutes = 15 } = options;

  const timestamp = new Date().toISOString();
  const nonce = randomUUID();
  const expiry = new Date(Date.now() + expiryMinutes * 60 * 1000).toISOString();

  // Canonical query: URLSearchParams matches server-side encoding exactly
  const canonicalParams = new URLSearchParams(fields);
  canonicalParams.sort();
  const canonicalQuery = canonicalParams.toString();

  // 8-line canonical string
  const contentToSign = [
    'ONRAMPER-SIG-V2',
    timestamp,
    nonce,
    'GET',
    '/',
    canonicalQuery,
    '',          // No headers for widget URLs
    sha256(''),  // Empty body hash
  ].join('\n');

  const privateKey = createPrivateKey(privateKeyPem);
  const signature = sign(null, Buffer.from(contentToSign), privateKey);

  const url = new URL(baseUrl);
  for (const [key, value] of Object.entries(fields)) {
    url.searchParams.set(key, value);
  }
  url.searchParams.set('sigV2', `v2:${signature.toString('base64')}`);
  url.searchParams.set('sigV2Timestamp', timestamp);
  url.searchParams.set('sigV2Nonce', nonce);
  url.searchParams.set('sigV2Expiry', expiry);
  url.searchParams.set('sigV2Fields', Object.keys(fields).sort().join(','));

  return url.toString();
}

// Usage — apiKey MUST be included in fields
const widgetUrl = signWidgetUrlV2({
  baseUrl: 'https://buy.onramper.com',
  privateKeyPem: process.env.PRIVATE_KEY!,
  fields: {
    apiKey: 'YOUR_API_KEY',
    wallets: 'btc:bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh',
    defaultAmount: '100',
    defaultFiat: 'USD',
  },
});
```

--------------------------------

### Set default target token

Source: https://docs.onramper.com/docs/supported-swap-parameters

Configures the initial target token displayed in the widget.

```text
https://buy.onramper.com/?mode=swap&swap_defaultTarget=usdc_solana
```

--------------------------------

### Set Partner Context

Source: https://docs.onramper.com/docs/supported-widget-parameters

Include a unique session identifier in the URL for webhook tracking.

```text
https://buy.onramper.com?apiKey=pk_prod_01HETEQF46GSK6BS5JWKDF31BT&partnerContext=<partner_context>
```

--------------------------------

### Fiat Currency Configuration

Source: https://docs.onramper.com/docs/supported-widget-parameters-offramp

Parameters to control which fiat currencies are available or selected by default.

```APIDOC
## Fiat Currency Configuration

### Endpoint
https://buy.onramper.com

### Query Parameters
- **sell_defaultFiat** (string) - Set a default fiat currency.
- **sell_onlyFiats** (string) - Force specific fiat currencies.
- **sell_excludeFiats** (string) - Omit specific fiat currencies.
- **sell_defaultAmount** (number) - Pre-populate the fiat amount.
```

--------------------------------

### Configure Crypto Currencies

Source: https://docs.onramper.com/docs/supported-widget-parameters

Override the default crypto selection or filter available cryptocurrencies using Onramper IDs.

```text
https://buy.onramper.com/?defaultCrypto=ETH
```

```text
https://buy.onramper.com?excludeCryptos=BTC,ETH
```

```text
https://buy.onramper.com?onlyCryptos=ETH,BTC
```

--------------------------------

### Create Checkout Intent in TypeScript

Source: https://docs.onramper.com/docs/checkout-v2

Uses the signApiRequestV2 helper to sign the request and create a checkout session. Ensure the end user's IP is hashed correctly before sending.

```typescript
const API_BASE = 'https://api.onramper.com';
const PLATFORM = 'mobile-ios'; // match your integration type

function sha256(data: string): string {
  return createHash('sha256').update(data).digest('hex');
}

async function createCheckout(userIp: string, onramp: string) {
  const body = {
    onramp,
    source: 'eur',
    destination: 'btc',
    amount: 300,
    type: 'buy',
    country: 'de',
    paymentMethod: 'creditcard',
    network: 'bitcoin',
    wallet: { address: 'bc1q...' },
    endUserIpHash: sha256(userIp),
    platform: PLATFORM,
  };

  const resp = await fetch(`${API_BASE}/checkout/v2/intent`, {
    method: 'POST',
    headers: {
      ...signApiRequestV2({
        method: 'POST',
        path: '/checkout/v2/intent',
        body,
        contentType: 'application/json',
      }),
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(body),
  });

  const { redirectUrl } = await resp.json();
  return redirectUrl; // send the user's browser here
}
```

--------------------------------

### Set Default Crypto for Offramp

Source: https://docs.onramper.com/docs/supported-widget-parameters-offramp

Overrides the default crypto recommendation algorithm using the sell_defaultCrypto parameter.

```text
https://buy.onramper.com/?sell_defaultCrypto=ETH
```

--------------------------------

### Configure Amount Editability

Source: https://docs.onramper.com/docs/supported-widget-parameters-offramp

Toggles whether users can edit the sell amount using the sell_isAmountEditable parameter.

```text
https://buy.onramper.com?sell_isAmountEditable=false
```

--------------------------------

### Set Default Amount

Source: https://docs.onramper.com/docs/supported-widget-parameters-offramp

Pre-populates the fiat currency input with a specific amount when used with sell_defaultFiat.

```text
https://buy.onramper.com?sell_defaultFiat=EUR&selldefaultAmount=125
```

--------------------------------

### POST /checkout/v2/intent

Source: https://docs.onramper.com/docs/checkout-v2

Creates a new checkout intent session. This endpoint requires a signed request body and specific authentication headers.

```APIDOC
## POST /checkout/v2/intent

### Description
Creates a new checkout intent. The request body must be signed, and the request must include specific authentication headers.

### Method
POST

### Endpoint
/checkout/v2/intent

### Parameters
#### Request Body
- **endUserIpHash** (string) - Required - 64-character lowercase hex SHA256 of the end user's IP.
- **platform** (string) - Recommended - The same value sent to quotes.

### Response
#### Success Response (200)
- **redirectUrl** (string) - The URL to redirect the user to.
- **sessionId** (string) - The unique identifier for the session.
- **resumeToken** (string) - A one-time token for session resumption.

#### Response Example
{
  "redirectUrl": "https://buy.onramper.com?session=01ABC...&resumeToken=8f2c...",
  "sessionId": "01ABC...",
  "resumeToken": "8f2c..."
}
```

--------------------------------

### Define source wallets

Source: https://docs.onramper.com/docs/supported-swap-parameters

Maps specific tokens to wallet addresses using the Token ID and address format.

```text
BTC:3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5.
```

```text
BTC:3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5,ETH:0xb794f5ea0ba39494ce839613fffba74279579268.
```

--------------------------------

### Widget URL Query Parameters

Source: https://docs.onramper.com/docs/supported-widget-parameters-offramp

Parameters used to customize the behavior and initial state of the Onramper offramp widget via URL query strings.

```APIDOC
## Widget URL Query Parameters

### Description
These parameters are passed as query strings to the widget integration URL to configure the offramp experience.

### Parameters
- **offrampCashoutRedirectUrl** (boolean) - Optional - If passed, the system uses the Wallet Initiation flow for programmatic handling of the crypto transfer.
- **sell_defaultFiat** (string) - Optional - The default fiat currency to be displayed.
- **sell_onlyFiats** (string) - Optional - The only fiat currencies to be displayed.
- **sell_excludeFiats** (string) - Optional - Fiat currencies to be excluded.
- **sell_defaultCrypto** (string) - Optional - The default cryptocurrency to be displayed.
- **sell_excludeCryptos** (string) - Optional - Cryptocurrencies to be excluded.
- **sell_defaultAmount** (number) - Optional - The default amount to be displayed (requires sell_defaultFiat).
- **sell_onlyCryptos** (string) - Optional - The only cryptocurrencies to be displayed.
- **sell_excludeCryptoNetworks** (string) - Optional - Blockchain networks to be excluded.
```

--------------------------------

### Bind Session to End User IP

Source: https://docs.onramper.com/docs/supported-widget-parameters

Use endUserIpHash to bind a checkout session to a specific IP address using a SHA256 hash.

```text
https://buy.onramper.com/?apiKey=pk_prod_...&endUserIpHash=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
```

--------------------------------

### Set Default Payment Method

Source: https://docs.onramper.com/docs/supported-widget-parameters

Use the defaultPaymentMethod parameter to pre-select a specific payment method in the widget.

```text
https://buy.onramper.com/?defaultFiat=EUR&defaultAmount=200&defaultPaymentMethod=banktransfer
```

--------------------------------

### Final Signed URL Structure

Source: https://docs.onramper.com/docs/widget-sign-a-url-v2

The resulting URL format after appending signature parameters.

```text
https://buy.onramper.com
  ?apiKey=YOUR_API_KEY
  &wallets=btc:bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
  &defaultAmount=100
  &sigV2=v2:MEUCIQDKZf3L8gT2x...
  &sigV2Timestamp=2024-01-15T10:00:00.000Z
  &sigV2Nonce=550e8400-e29b-41d4-a716-446655440000
  &sigV2Expiry=2024-01-15T10:15:00.000Z
  &sigV2Fields=apiKey,defaultAmount,wallets
```

--------------------------------

### Widget URL Swap Parameters

Source: https://docs.onramper.com/docs/supported-swap-parameters

The Onramper swap widget supports various URL parameters to pre-configure the user experience. These parameters are appended to the widget URL.

```APIDOC
## Supported Swap Parameters

### Description
Customize the swap widget behavior by appending parameters to the widget URL.

### Parameters
#### Query Parameters
- **swap_defaultSource** (string) - Optional - The default source token to be displayed.
- **swap_defaultTarget** (string) - Optional - The default target token to be displayed.
- **swap_defaultAmount** (string) - Optional - The default amount to be displayed (must be used with swap_defaultSource).
- **swap_sourceWallets** (string) - Optional - Specifies source wallet addresses for individual tokens (Format: TokenID:Address, separated by commas).
- **swap_sourceNetworkWallets** (string) - Optional - Provides a source wallet address for all tokens on a specific network (Format: NetworkID:Address, separated by commas).
- **swap_targetWallets** (string) - Optional - Defines target wallet addresses for individual tokens.
- **swap_targetNetworkWallets** (string) - Optional - Specifies a target wallet address for all tokens on a particular network.
- **swap_excludeCryptos** (string) - Optional - Cryptocurrencies to be excluded.
- **swap_onlyCryptos** (string) - Optional - The only cryptocurrencies to be displayed.
- **swap_excludeCryptoNetworks** (string) - Optional - Blockchain networks to be excluded.
- **swap_onlyCryptoNetworks** (string) - Optional - The only blockchain networks to be displayed.

### Examples
- **Default Source**: `https://buy.onramper.com/?mode=swap&swap_defaultSource=usdc_ethereum`
- **Default Target**: `https://buy.onramper.com/?mode=swap&swap_defaultTarget=usdc_solana`
- **Default Amount**: `https://buy.onramper.com/?mode=swap&swap_defaultSource=usdc_ethereum&swap_defaultAmount=140`
- **Source Wallets**: `swap_sourceWallets=BTC:3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5,ETH:0xb794f5ea0ba39494ce839613fffba74279579268`
- **Source Network Wallets**: `swap_sourceNetworkWallets=ETHEREUM:3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5,SOLANA:0xb794f5ea0ba39494ce839613fffba74279579268`
```

--------------------------------

### Configure Crypto Networks

Source: https://docs.onramper.com/docs/supported-widget-parameters

Filter available crypto networks using Onramper network IDs.

```text
https://buy.onramper.com?excludeCryptoNetworks=bitcoin,ethereum
```

```text
https://buy.onramper.com/?onlyCryptoNetworks=ethereum,polygon
```

--------------------------------

### Set Popular Cryptocurrencies

Source: https://docs.onramper.com/docs/supported-widget-parameters-offramp

Displays specific tokens at the top of the selection list using the sell_popularCryptos parameter.

```text
https://buy.onramper.com/?sell_popularCryptos=eth,btc,sol
```

--------------------------------

### Onramper Offramp Widget Configuration

Source: https://docs.onramper.com/docs/supported-widget-parameters-offramp

The Onramper widget supports various query parameters to control the offramp experience. These parameters are appended to the base URL: https://buy.onramper.com/

```APIDOC
## Query Parameters

- **sell_defaultCrypto** (string) - Sets the default input cryptocurrency.
- **sell_excludeCryptos** (string) - Comma-separated list of cryptocurrency IDs to exclude.
- **sell_onlyCryptos** (string) - Comma-separated list of cryptocurrency IDs to exclusively display.
- **sell_excludeCryptoNetworks** (string) - Comma-separated list of network IDs to exclude.
- **sell_onlyCryptoNetworks** (string) - Comma-separated list of network IDs to exclusively display.
- **sell_defaultPaymentMethod** (string) - Sets the default payout method ID.
- **sell_excludePaymentMethods** (string) - Comma-separated list of payment method IDs to exclude.
- **onlyOfframps** (string) - Limits the displayed offramps to the specified selection.
- **sell_isAmountEditable** (boolean) - Sets whether the user can edit the sell amount (default: true).
- **sell_recommendation** (string) - Overrides the default recommended offramp.
- **sell_popularCryptos** (string) - Comma-separated list of crypto tokens to display as 'Popular'.
- **sell_maxAvailableCrypto** (number) - Sets the maximum available crypto amount for the user to sell.
```

--------------------------------

### Retrieve Quotes via HTTP

Source: https://docs.onramper.com/docs/integration-steps-1

Fetch real-time quotes by specifying source and destination currencies with the platform parameter.

```http
GET https://api.onramper.com/quotes/{sourceCurrency}/{destinationCurrency}?platform=web
```

--------------------------------

### POST /transactions/confirm/{type}

Source: https://docs.onramper.com/docs/offramp-process-flow

Confirms a crypto transfer after the partner system has completed the transfer process.

```APIDOC
## POST /transactions/confirm/{type}

### Description
This endpoint is used by the partner system to confirm that a crypto transfer has been completed.

### Method
POST

### Endpoint
/transactions/confirm/{type}

### Parameters
#### Path Parameters
- **type** (string) - Required - The type of transaction confirmation (e.g., 'sell').
```
Tokens:
Raw