Get Quote (Crypto-to-Crypto)

This endpoint fetches the complete details of a previously created crypto-to-crypto quote using its quote_id . The data includes source and target crypto information, exchange rates, and transaction rules.

Endpoint

GET {{appUrl}}/v1/ramp/quote/{{quote_id}}

Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
x-api-keyYOUR_API_KEYYes

Path Parameter

ParameterTypeDescription
quote_idstringUnique identifier of the quote

Example Request

This example shows how to retrieve the details of a specific ramp quote using its unique ID.

    Successful Response 200 OK

    {
      "message": "quote successfully created",
      "status": "success",
      "data": {
        "id": "92da6ea0-79fe-4000-971d-xxxxxxxxxxxxxxxx",
        "source": {
          "currency": "Polygon",
          "symbol": "POL",
          "addressRegex": "^(0x)[0-9A-Fa-f]{40}$",
          "amount": 0.12,
          "blockchain": "MATIC",
          "type": "CRYPTOCURRENCY"
        },
        "target": {
          "currency": "Polygon",
          "symbol": "POL",
          "addressRegex": "^(0x)[0-9A-Fa-f]{40}$",
          "amount": 0.12,
          "blockchain": "MATIC",
          "type": "CRYPTOCURRENCY"
        },
        "rate": 0.00102300,
        "fees": {
          "symbol": "POL",
          "amount": 0.00,
          "gas": {
            "type": "MEDIUM",
            "amount": 0.01909123
          }
        },
        "rules": [
          {
            "category": "LIMIT",
            "appliedCurrency": "USDC",
            "transaction": {
              "minimum": 10.00,
              "maximum": 2000000.00
            },
            "invoice": 2000000.00
          }
        ],
        "summary": {
          "total": 0.12
        }
      }
    }
    

    Response Breakdown

    FieldTypeDescription
    messagestringStatus message (e.g., "quote successfully created")
    statusstringStatus of the request (e.g., "success")
    data.idstringUnique identifier of the quote
    data.sourceobjectDetails of the source cryptocurrency
    data.source.currencystringName of the source currency (e.g., "Polygon")
    data.source.symbolstringSymbol of the source cryptocurrency (e.g., "POL")
    data.source.addressRegexstringRegular expression pattern for validating crypto addresses
    data.source.amountnumberAmount of source cryptocurrency
    data.source.blockchainstringBlockchain network (e.g., "MATIC")
    data.source.typestringType of the asset ("CRYPTOCURRENCY")
    data.targetobjectDetails of the target cryptocurrency
    data.target.currencystringName of the target currency (e.g., "Polygon")
    data.target.symbolstringSymbol of the target cryptocurrency (e.g., "POL")
    data.target.addressRegexstringRegular expression pattern for validating target crypto addresses
    data.target.amountnumberAmount of target cryptocurrency
    data.target.blockchainstringBlockchain network of the target currency
    data.target.typestringType of the asset ("CRYPTOCURRENCY")
    data.ratenumberExchange rate between source and target cryptocurrencies
    data.feesobjectFee breakdown for the transaction
    data.fees.symbolstringCurrency symbol for fees
    data.fees.amountnumberFee amount charged
    data.fees.gasobjectGas fee details
    data.fees.gas.typestringGas fee level ("MEDIUM", etc.)
    data.fees.gas.amountnumberGas fee amount
    data.rulesarrayRules that apply to this transaction
    data.rules[].categorystringRule category (e.g., "LIMIT")
    data.rules[].appliedCurrencystringCurrency to which the rule applies (e.g., "USDC")
    data.rules[].transactionobjectTransaction limits
    data.rules[].transaction.minimumnumberMinimum transaction amount
    data.rules[].transaction.maximumnumberMaximum transaction amount
    data.rules[].invoicenumberMaximum invoice amount
    data.summaryobjectSummary of the transaction
    data.summary.totalnumberTotal amount of the source cryptocurrency involved in the transaction

    Error Codes

    CodeMessage
    400Bad request – invalid or missing fields
    401Unauthorized – invalid API key
    500Internal server error