Sign in

v1

latestOpenAPI 3.0.02026-07-224537337.5 KB

Create a Quote

Create a locked exchange rate quote. The quote is valid for the specified duration and can be used once to create a transfer.

post/v2/quote

Request body

amountstring required

The quote amount (denominated in source currency).

customerIdstring required

The customer's ID.

quoteDurationSeconds30 | 60 | 300

The duration in seconds for which the quote rate is locked. Defaults to 60.

integratorBpsFeeRatestring

The integrator BPS fee rate. The BPS rate should be an integer represented as a string.

Example request

{
  "amount": "100.00",
  "customerId": "customer_3faa484998f44cfead9668608b9ee1f5",
  "quoteDurationSeconds": 60,
  "integratorBpsFeeRate": "20"
}

Response

idstring required

A unique identifier for the quote.

type'on_ramp' | 'off_ramp' required

The transfer type this quote is for.

customerIdstring required

The customer ID.

expiresAtstring date-time required

The datetime when this quote expires.

createdstring date-time required

The datetime the quote was created.

Example response

{
  "id": "quote_d243ab2b1de4447d8a046d87fefe58cf",
  "type": "off_ramp",
  "customerId": "customer_d243ab2b1de4447d8a046d87fefe58cf",
  "fees": {
    "integratorFee": {
      "fixedAmount": "0.00",
      "bpsRate": "0",
      "totalAmount": "0.00",
      "currency": "usdc"
    },
    "platformFee": {
      "fixedAmount": "0.00",
      "bpsRate": "20",
      "totalAmount": "2.00",
      "currency": "usdc"
    }
  },
  "source": {
    "network": "polygon",
    "amount": "100.00"
  },
  "destination": {
    "network": "polygon",
    "amount": "545.50",
    "exchangeRate": "5.455"
  },
  "expiresAt": "2025-01-01T00:01:00.000Z",
  "created": "2025-01-01T00:00:00.000Z"
}