API reference
POST
/quotesPreview a payment quote
Preview the fee and exact charge or debit without moving funds
Overview
Calculate the current fee and exact payer charge or wallet debit without creating a payment. An idempotency header is unnecessary because this operation moves no funds.
A quote does not reserve funds, lock the fee or promise live provider availability. Show the returned amount to the payer before creating the payment.
Example request
curl -X POST https://api.nuepay.net/v1/quotes \
-H "Authorization: Bearer $NUEPAY_TEST_KEY" \
-H 'Content-Type: application/json' \
-d '{"type":"collection","amount":"500.00","currency":"UGX"}'Request body
| Field | Type | Details |
|---|---|---|
typerequired | string | collection, disbursement |
amountrequired | string | Wallet principal for collections; recipient amount for disbursements. |
currencyrequired | string | UGX |
Example response
{
"data": {
"type": "collection",
"currency": "UGX",
"amount": "500.00",
"fee": "20.00",
"gross_amount": "520.00",
"payer_charge": "520.00",
"wallet_credit": "500.00",
"recipient_amount": null,
"wallet_debit": null,
"mode": "test"
}
}Examples omit timestamps for readability. Use POST /quotes to confirm current fees rather than hard-coding these examples.
Response fields
| Field | Type | Details |
|---|---|---|
amount | string | See the response and related guide. |
fee | string | See the response and related guide. |
gross_amount | string | See the response and related guide. |
currency | string | See the response and related guide. |
payer_charge | string or null | See the response and related guide. |
wallet_credit | string or null | See the response and related guide. |
recipient_amount | string or null | See the response and related guide. |
wallet_debit | string or null | See the response and related guide. |
type | string | collection, disbursement |
mode | string | live, test |
HTTP status codes
| Status | Meaning |
|---|---|
200 | Quote in UGX decimal strings. Collection total is rounded up to whole UGX. Quotes do not reserve funds or guarantee provider availability. |
201 | Invalid credentials. |
202 | Access unavailable or operation paused. |
203 | Resource not found in this application and environment. |
204 | Idempotency conflict, insufficient funds, or payout setup required. |
205 | Invalid input; inspect errors and code. |
206 | Rate limit exceeded. |
207 | Live provider unavailable; accepted payments can still be read or retried. |
Errors contain a stable code and support request_id. See error handling for recovery guidance.