Skip to main content
Use this endpoint to fetch the latest state of a quote before completing the payout. It returns the locked-in rate, fees, and the remaining validity window.

Endpoint

GET {{baseURL}}/v1/quote/{quoteId}

Request headers

HeaderDescriptionRequiredExample
x-api-keyAPI key tied to your environment.✅ YesYOUR_API_KEY
Content-TypeMedia type of the request.✅ Yesapplication/json

Request examples

curl --request GET '{{baseURL}}/v1/quote/15tyyba81-f71a-76ha-b579-xxxxxxxxxxxxx' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json'

Successful response

copy
{
  "message": "quote successfully fetched",
  "status": "success",
  "data": {
    "id": "15tyyba81-f71a-76ha-b579-xxxxxxxxxxxxx",
    "source": {
      "currency": "NGN",
      "country": "NG",
      "amount": 150000
    },
    "target": {
      "currency": "EUR",
      "country": "AT",
      "amount": 81.97
    },
    "rate": 1830,
    "fee": {
      "amount": 0
    },
    "rules": [
      {
        "category": "LIMIT",
        "appliedCurrency": "EUR",
        "appliedCountry": "AT",
        "transaction": {
          "minimum": 1,
          "maximum": 200000
        },
        "invoice": 200000
      }
    ],
    "summary": {
      "total": 150000
    },
    "settlementTime": "1 hr",
    "quoteCurrency": "EUR",
    "expiresInSeconds": 600
  }
}

Field reference

FieldTypeDescription
messageStringOverall result of the request.
statusStringsuccess if the quote was found; error otherwise.
data.idStringQuote identifier you supplied in the path.
data.sourceObjectSource currency, country, and amount.
data.targetObjectTarget currency, country, and converted amount.
data.rateNumberExchange rate locked for the quote.
data.fee.amountNumberTotal fees applied.
data.rulesArrayRule evaluations (limits, compliance constraints, etc.).
data.summary.totalNumberTotal debit amount in the source currency.
data.expiresInSecondsNumberTime remaining before the quote expires.

Error responses

StatusMeaningExample messageHow to fix
400Quote not found or invalid ID.Quote does not existConfirm the quoteId is correct and unexpired.
401Authentication failed.Invalid API keyVerify the x-api-key header.
403IP not whitelisted.Access denied: IP address not whitelistedRegister your IP under Developers → IP Whitelisting.
429Rate limit exceeded.Too many requestsBack off and retry after the window resets.
500Server error.Internal server errorRetry later or contact support if the issue persists.

Usage tips

  • Fetch the quote immediately before you initiate a payout to ensure it is still valid.
  • Cache the quote in your session store so you can re-display the guaranteed amount in confirmation UIs.
  • If the quote has expired, call Create Quote again and repeat the flow.