Get Quote API Documentation

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

Endpoint

GET https://{{baseURL}}/v1/quote/{{quote_id}}

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 'https://{{baseURL}}/v1/quote/{quote_id}' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json'

Success Response (200 OK)

If the request is successful, the API returns the following JSON response:

response.json

{
    "message": "quote successfully fetched",
    "status": "success",
    "data": {
        "id": "90b8cb00-5fc2-4a01-87fc-558f4bd53231",
        "source": {
            "currency": "NGN",
            "country": "NG",
            "amount": 5000.00
        },
        "target": {
            "currency": "CNY",
            "country": "CN",
            "amount": 23.58
        },
        "rate": 212.02000000,
        "fee": {
            "amount": 12.00
        },
        "rules": [
            {
                "category": "LIMIT",
                "appliedCurrency": "CNY",
                "appliedCountry": "CN",
                "transaction": {
                    "minimum": 2.00,
                    "maximum": 48000.00
                },
                "invoice": 48000.00
            }
        ],
        "summary": {
            "total": 5012.00
        }
    }
}

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 (`5000 NGN`)

Target (Receiving) Details

Field	Type	Description
`target.currency`	String	Target currency (`CNY`)
`target.country`	String	Destination country (`CN`)
`target.amount`	Number	Converted amount (`23.58 CNY`)

Exchange Rate and Fees

Field	Type	Description
`rate`	Number	Exchange rate applied (`212.02`)
`fee.amount`	Number	Transaction fee (`12 NGN`)

Transaction Rules

Field	Type	Description
`rules[].category`	String	Type of rule applied (`LIMIT`)
`rules[].appliedCurrency`	String	Currency the rule applies to (`CNY`)
`rules[].appliedCountry`	String	Country the rule applies to (`CN`)
`rules[].transaction.minimum`	Number	Minimum allowed transaction (`2 CNY`)
`rules[].transaction.maximum`	Number	Maximum allowed transaction (`48,000 CNY`)
`rules[].invoice`	Number	Maximum invoice amount (`48,000 CNY`)

Summary

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

Key Takeaways

The user sends 5,000 NGN, which is converted to 23.58 CNY at an exchange rate of 212.02.
A transaction fee of 12 NGN is applied.
The total amount the user must pay (including fees) is 5,012 NGN.
A transaction limit rule restricts transactions between 2 CNY and 48,000 CNY.

Best Practices

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

Create Quote Update Quote