Quotes

Use this API to create and fetch quotes for transactions. Currently, onramp and offramp transaction types are supported and will be inferred from the source and destination.

Create a quote

Creates a new quote for a transaction. This endpoint generates a quote for your specified currency route, guaranteeing the price for 5 min.

POSThttps://app.fernhq.com/api/v0/quotes

Body

customerId*string

A unique identifier for the customer initiating the transaction.

Example: "03b7030f-6da1-4d76-9352-cdebd82112c8"

source*object

destination*object

sendingAmount*number

The amount to convert and send, expressed in decimals and denominated in the source currency

Example: 100

developerFeeDeveloper Fees

Specifies additional fees which the developer can charge on top of fern fees

Response

Quote created successfully

Body

quoteId*string

Unique identifier for this quote

Example: "quote_abc123"

exchangeRate*number

The rate at which the source currency is multiplied to determine the equivalent amount in the destination currency

Example: 1.2

receivingAmount*number

The amount that will be received after conversion and fees

Example: 100

minGuaranteedReceivingAmount*number

The minimum amount guaranteed to be received, accounting for potential price fluctuations

Example: 98

expiresAt*string (date-time)

ISO timestamp when this quote expires (5 minutes from creation)

fees*Transaction Fees

Detailed breakdown of all fees associated with the transaction

Request

const response = await fetch('https://app.fernhq.com/api/v0/quotes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "customerId": "03b7030f-6da1-4d76-9352-cdebd82112c8",
      "sendingAmount": 100,
      "source": {
        "paymentMethod": "ethereum",
        "currency": "USDC"
      },
      "destination": {
        "bankAccountId": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
        "paymentMethod": "wire",
        "currency": "USD"
      }
    }),
});
const data = await response.json();

Response

{
  "quoteId": "quote_abc123",
  "exchangeRate": 1.2,
  "receivingAmount": 100,
  "minGuaranteedReceivingAmount": 98,
  "expiresAt": "2025-01-18T10:57:32.787Z",
  "fees": {
    "fernFee": {
      "type": "fern",
      "currency": "USD",
      "amount": 5.45,
      "usdAmount": 5.45
    },
    "developerFee": {
      "type": "fern",
      "currency": "USD",
      "amount": 5.45,
      "usdAmount": 5.45
    }
  }
}

Get quote details

GEThttps://app.fernhq.com/api/v0/quotes/{quoteId}

Path parameters

quoteId*string

The unique identifier for the quote to retrieve

Example: "c88ebfc2-3356-48b5-b2bb-6fca7b618c96"

Response

Quote details retrieved successfully

Body

quoteId*string

Unique identifier for this quote

Example: "quote_abc123"

exchangeRate*number

The rate at which the source currency is multiplied to determine the equivalent amount in the destination currency

Example: 1.2

receivingAmount*number

The amount that will be received after conversion and fees

Example: 100

minGuaranteedReceivingAmount*number

The minimum amount guaranteed to be received, accounting for potential price fluctuations

Example: 98

expiresAt*string (date-time)

ISO timestamp when this quote expires (5 minutes from creation)

fees*Transaction Fees

Detailed breakdown of all fees associated with the transaction

Request

const response = await fetch('https://app.fernhq.com/api/v0/quotes/{quoteId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "quoteId": "quote_abc123",
  "exchangeRate": 1.2,
  "receivingAmount": 100,
  "minGuaranteedReceivingAmount": 98,
  "expiresAt": "2025-01-18T10:57:32.787Z",
  "fees": {
    "fernFee": {
      "type": "fern",
      "currency": "USD",
      "amount": 5.45,
      "usdAmount": 5.45
    },
    "developerFee": {
      "type": "fern",
      "currency": "USD",
      "amount": 5.45,
      "usdAmount": 5.45
    }
  }
}

Last updated 29 days ago

const response = await fetch('https://app.fernhq.com/api/v0/quotes', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "customerId": "03b7030f-6da1-4d76-9352-cdebd82112c8", "sendingAmount": 100, "source": { "paymentMethod": "ethereum", "currency": "USDC" }, "destination": { "bankAccountId": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77", "paymentMethod": "wire", "currency": "USD" } }), }); const data = await response.json();

{ "quoteId": "quote_abc123", "exchangeRate": 1.2, "receivingAmount": 100, "minGuaranteedReceivingAmount": 98, "expiresAt": "2025-01-18T10:57:32.787Z", "fees": { "fernFee": { "type": "fern", "currency": "USD", "amount": 5.45, "usdAmount": 5.45 }, "developerFee": { "type": "fern", "currency": "USD", "amount": 5.45, "usdAmount": 5.45 } } }