Create Quote Example - NGN to USD
The Create Quote API generates a foreign exchange quote for a specific transaction. This quote includes the exchange rate, transaction fee, applicable rules (e.g., limits), and the total amount the sender will pay.
In this example, we create a quote to convert 100,000 NGN (Nigerian Naira) to USD (United States Dollar) using BANK_TRANSFER as the payment channel.
Endpoint
POST https://{{baseURL}}/v1/quote
Authentication
Include these headers in your request:
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 --location --request POST 'https://{{baseURL}}/v1/quote' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"paymentChannel": "BANK_TRANSFER",
"source": {
"amount": 100000,
"country": "NG",
"currency": "NGN"
},
"target": {
"country": "US",
"currency": "USD"
}
}'
ℹ️
Note: BANK_TRANSFER is currently supported for NGN to USD quotes.
Sample Response (200 OK)
{
"message": "quote successfully created",
"status": "success",
"data": {
"id": "855a128a-f93f-4998-8227-dc4a4da86af3",
"source": {
"currency": "NGN",
"country": "NG",
"amount": 100000.00
},
"target": {
"currency": "USD",
"country": "US",
"amount": 61.39
},
"rate": 1629.00,
"fee": {
"amount": 200
},
"rules": [
{
"category": "LIMIT",
"appliedCurrency": "USD",
"appliedCountry": "US",
"transaction": {
"minimum": 2.00,
"maximum": 10000000.00
},
"invoice": 134000.00
}
],
"summary": {
"total": 100200.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 sent (NGN ) |
source.country | String | Sender country (NG ) |
source.amount | Number | Amount to be sent (100,000 NGN ) |
Target (Receiving) Details
Field | Type | Description |
---|---|---|
target.currency | String | Currency to be received (USD ) |
target.country | String | Recipient country (US ) |
target.amount | Number | Amount recipient receives (61.39 USD ) |
Exchange Rate and Fees
Field | Type | Description |
---|---|---|
rate | Number | Exchange rate applied (1629.00 ) |
fee.amount | Number | Transaction fee (200 NGN ) |
Transaction Rules
Field | Type | Description |
---|---|---|
rules[].category | String | Rule category (LIMIT ) |
rules[].appliedCurrency | String | Currency rule applies to (USD ) |
rules[].appliedCountry | String | Country rule applies to (US ) |
rules[].transaction.minimum | Number | Minimum transaction amount (2.00 USD ) |
rules[].transaction.maximum | Number | Maximum transaction amount (10,000,000 USD ) |
rules[].invoice | Number | Max invoice value (134,000 NGN ) |
Summary
Field | Type | Description |
---|---|---|
summary.total | Number | Total user pays (100,000 + 200 = 100,200 NGN ) |
Key Takeaways
- This quote converts 100,000 NGN to 61.39 USD at a rate of ₦1,629.00/USD.
- A 200 NGN processing fee is included in the total amount.
- The total amount payable by the sender is 100,200 NGN.
- The recipient will receive 61.39 USD.
- The transaction must comply with the limit rules: minimum 2 USD, maximum 10,000,000 USD.
- The quote expires after 10 minutes (600 seconds).
Best Practices
- ✅ Include a valid API key in the
x-api-key
header. - ✅ Use correct ISO codes for both country and currency.
- ✅ Always inspect the
rules
returned in the response to ensure the transaction complies with set limits.