Skip to main content
POST
Create cross-border collection quote
Calculates the estimated NGN amount a merchant will receive for a supported local-currency collection. For Kenya collections, send country as KE, currency as KES, and the customer amount in normal KES units. For Uganda collections, send country as UG, currency as UGX, and the customer amount in normal UGX units. The returned merchantReceives amount is the NGN amount after NexaPay’s FX margin.

Notes

  • Quotes use provider sell rates.
  • The rate shown by this endpoint is for preview.
  • The final locked rate is stored when the collection is initiated.
  • Merchant-facing integrations should display merchantRate and merchantReceives.

Authorizations

x-api-key
string
header
required

Merchant API Key (e.g., nexa-prod-... or nexa-test-...)

Headers

x-business-env
enum<string>
default:prod

Target environment selector (live production vs. simulated sandbox).

Available options:
prod,
test

Body

application/json
businessId
string
required

The unique ID of the business profile.

country
string
required
Example:

"UG"

currency
string
required
Example:

"UGX"

amount
number
required

Customer amount in source-currency units.

Example:

20000

sourceCurrency
string
Example:

"UGX"

targetCurrency
string
default:NGN
Example:

"NGN"

Response

Quote generated successfully.

success
boolean
Example:

true

quote
object