Create Quote Example - NGN to EUR

This example demonstrates a quote request for converting 100,000 NGN to EUR (Euro). This quote locks in the exchange rate, fees, and amounts for a short period, which you can then use to initiate a payout transaction.

Supported Payment Channels

Quotes are often generated with a specific payout method in mind, as fees or limits might vary. This API supports getting quotes for payouts via:

BANK_TRANSFER: For standard bank transfers within the Single Euro Payments Area.

Endpoint

POST {{baseURL}}/v1/quote

Header

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`

Remember to replace YOUR_API_KEY with your actual API key (Production or Sandbox).

Request Body

{
  "paymentChannel": "string", // 
  "source": {
    "amount": number,
    "country": "string", // ISO 3166-1 alpha-2 code
    "currency": "string" // ISO 4217 currency code
  },
  "target": {
    "country": "string", // ISO 3166-1 alpha-2 code
    "currency": "string" // ISO 4217 currency code
  }
}

Sample Response (200 OK)

{
  "message": "quote successfully created",
  "status": "success",
  "data": {
    "id": "74bgf9ea-141e-13c7-ade9-xxxxxxxxxxxxx",
    "source": {
      "currency": "NGN",
      "country": "NG",
      "amount": 100000
    },
    "target": {
      "currency": "EUR",
      "country": "DK",
      "amount": 61.72
    },
    "rate": 1620.21,
    "fee": {
      "amount": 1000
    },
    "rules": [
      {
        "category": "LIMIT",
        "appliedCurrency": "EUR",
        "appliedCountry": "DK",
        "transaction": {
          "minimum": 10,
          "maximum": 25000
        },
        "invoice": 25000
      }
    ],
    "summary": {
      "total": 101000
    }
  }
}

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 (100,000 NGN)

Target (Receiving) Details

Field	Type	Description
target.currency	String	Target currency (EUR)
target.country	String	Destination country (DK)
target.amount	Number	Converted amount (61.72 EUR)

Exchange Rate and Fees

Field	Type	Description
rate	Number	Exchange rate applied (1620.21)
fee.amount	Number	Transaction fee (1,000 NGN)

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 (DK)
rules[].transaction.minimum	Number	Minimum allowed transaction (10 EUR)
rules[].transaction.maximum	Number	Maximum allowed transaction (25,000 EUR)
rules[].invoice	Number	Maximum invoice amount (25,000 EUR)

Summary

Field	Type	Description
summary.total	Number	Total amount user pays (101,000 NGN)

Key Takeaways

The user sends 100,000 NGN, which is converted to 61.72 EUR at an exchange rate of 1620.21.
A transaction fee of 1,000 NGN is applied.
The total amount the user must pay (including fees) is 101,000 NGN.
A transaction limit rule restricts transactions between 10 EUR and 25,000 EUR.

Best Practices

✅ Include a valid API key (x-api-key) in the request headers to authenticate the request.
✅ Ensure that the source and target country and currency codes are valid to prevent request failures.
✅ Handle transaction limits appropriately to comply with API restrictions.

NGN - CNY Example NGN - GBP Example