Get Quote API

The Get Quote API allows users to retrieve the details of a previously created exchange quote using the unique quoteId.
This API provides details such as the exchange rate, transaction fees, applicable limits, and the total amount after fees.

Endpoint

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

Headers

Header	Description	Required	Example Value
`x-api-key`	API key for authentication	✅ Yes	`YOUR_API_KEY`
`Content-Type`	Request content type	✅ Yes	`application/json`

Request Example

cURL Request

curl --location --request GET '{{baseURL}}/v1/quote/{quote_id}' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json'

Responses

response.json

{
"message": "quote successfully fetched",
"status": "success",
"data": {
    "id": "15tyyba81-f71a-76ha-b579-xxxxxxxxxxxxx",
    "source": {
        "currency": "NGN",
        "country": "NG",
        "amount": 150000.00
    },
    "target": {
        "currency": "EUR",
        "country": "AT",
        "amount": 81.97
    },
    "rate": 1830.00000000,
    "fee": {
        "amount": 0.00
    },
    "rules": [
        {
            "category": "LIMIT",
            "appliedCurrency": "EUR",
            "appliedCountry": "AT",
            "transaction": {
                "minimum": 1.00,
                "maximum": 20000000000000.00
            },
            "invoice": 200000000000.00
        }
    ],
    "summary": {
        "total": 150000.00
    },
    "expiresInSeconds": 600
}
}

Response Breakdown

General Information

Field	Type	Description
`message`	String	Confirmation message
`status`	String	Indicates success or failure
`data.id`	String	Unique identifier for the quote

Source (Sending) Details

Field	Type	Description
`source.currency`	String	Currency being exchanged (`NGN`)
`source.country`	String	Country where the transaction originates (`NG`)
`source.amount`	Number	Amount to be converted (`150000 NGN`)

Target (Receiving) Details

Field	Type	Description
`target.currency`	String	Target currency (`EUR`)
`target.country`	String	Destination country (`AT`)
`target.amount`	Number	Converted amount (`81.97 EUR`)

Exchange Rate and Fees

Field	Type	Description
`rate`	Number	Exchange rate applied (`1830.00`)
`fee.amount`	Number	Transaction fee (`0.00`)

Transaction Rules

Field	Type	Description
`rules[].category`	String	Type of rule applied (`LIMIT`)
`rules[].appliedCurrency`	String	Currency the rule applies to (`EUR`)
`rules[].appliedCountry`	String	Country the rule applies to (`AT`)
`rules[].transaction.minimum`	Number	Minimum allowed transaction (`1.00 EUR`)
`rules[].transaction.maximum`	Number	Maximum allowed transaction (`20000000000000.00 EUR`)
`rules[].invoice`	Number	Maximum invoice amount (`200000000000.00 EUR`)

Summary

Field	Type	Description
`summary.total`	Number	Total amount user pays (`150000 NGN`)

Expiration

Field	Type	Description
`expiresInSeconds`	Number	Quote expiration time in seconds (`600`)

Error Handling

Status Code	Meaning	Example Response	How to Handle
400	Bad Request (No API Key)	No API key found in request	Ensure `x-api-key` header is sent with a valid key
404	Route Not Found	The Route is not supported	Contact support to get the correct route
400	Validation Error	Quote does not exist	Check the `quoteId` value and confirm it is correct or exists
401	Unauthorized (Invalid Parameter or API Key)	Invalid authentication credentials	Verify the API key is correct and exists in your dashboard settings
403	Forbidden (Non-whitelisted IP)	Your IP address is not allowed to access this service	Whitelist your IP address in the Developer on the dashboard
422	Unprocessable Entity (Semantic Error)	Invalid value in request body	Check request body for incorrect values or semantic mistakes
429	Too Many Requests (Rate Limited)	API rate limit exceed	Implement retry with exponential backoff; stay within rate limits (e.g., 50 requests/sec)
500	Internal Server Error	An unexpected error occurred on the server	Retry later; contact support if the issue persists

Best Practices

✅ Include a valid API key (x-api-key) in the request headers to authenticate the request.
✅ Ensure that the quoteId is retrieved from the Create Quote API before making the request.
✅ Handle transaction limits appropriately to comply with API restrictions.

Create Quote NGN - NGN Example