Create Quote Example - NGN to NGN

This example demonstrates a quote request for sending 5,000 NGN (Nigerian Naira) within Nigeria. The NGN to NGN example is needed because it shows the transaction fee for NGN payouts depending on the amount.

Supported Payment Channels

Quotes are often generated with a specific payout method in mind, as fees or limits might vary. For NGN to USD, the Quote API supports getting quotes for payouts via:

BANK_TRANSFER

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": 5000,
        "country": "NG",
        "currency": "NGN"
    },
    "target": {
        "country": "NG",
        "currency": "NGN"
    }
}'

ℹ️

Note: BANK_TRANSFER is the supported payment channel for domestic transfers within Nigeria.

Sample Response (200 OK)

{
    "message": "quote successfully created",
    "status": "success",
    "data": {
        "id": "23cdd48e-06a9-4d1e-9704-7bb17e2312cd",
        "source": {
            "currency": "NGN",
            "country": "NG",
            "amount": 5000.00
        },
        "target": {
            "currency": "NGN",
            "country": "NG",
            "amount": 5000.00
        },
        "rate": 1.00000000,
        "fee": {
            "amount": 100.00
        },
        "rules": [
            {
                "category": "LIMIT",
                "appliedCurrency": "NGN",
                "appliedCountry": "NG",
                "transaction": {
                    "minimum": 10.00,
                    "maximum": 2000000.00
                },
                "invoice": 2000000.00
            }
        ],
        "summary": {
            "total": 5100.00
        }
    }
}

ℹ️

Note: Transaction fees and limits are subject to change.

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

Target (Receiving) Details

Field	Type	Description
`target.currency`	String	Currency to be received (`NGN`)
`target.country`	String	Recipient country (`NG`)
`target.amount`	Number	Amount recipient receives (`5000 NGN`)

Exchange Rate and Fees

Field	Type	Description
`rate`	Number	Exchange rate applied (`1.0`)
`fee.amount`	Number	Transaction fee (`100 NGN`)

⚖️ Transaction Rules

Field	Type	Description
`rules[].category`	String	Rule category (`LIMIT`)
`rules[].appliedCurrency`	String	Currency rule applies to (`NGN`)
`rules[].appliedCountry`	String	Country rule applies to (`NG`)
`rules[].transaction.minimum`	Number	Minimum transaction amount (`10 NGN`)
`rules[].transaction.maximum`	Number	Maximum transaction amount (`2,000,000 NGN`)
`rules[].invoice`	Number	Max invoice value (`2,000,000 NGN`)

Summary

Field	Type	Description
`summary.total`	Number	Total user pays (`5000 + 100 = 5100`)

Key Takeaways

A quote is generated for BANK_TRANSFER of 5,000 NGN.
A 100 NGN transaction fee is applied.
Total payable: 5,100 NGN.
Recipient receives: 5,000 NGN.
Transaction must comply with LIMIT rules (min: 10 NGN, max: 2,000,000 NGN).

Best Practices

Include a valid API key in the x-api-key header.
Use correct ISO codes for country and currency.
Always inspect returned rules to ensure compliance before initiating a transaction.

Update Quote NGN - CNY Example