Skip to main content
Prices a payout without creating anything. Optionally validates the recipient and returns the registered account name in the same call.

Endpoint

Requires the offramp scope. See getting access.

Body

amount
number
required
USDC amount, 0.5 – 50,000. The local equivalent must also fall inside the per-transaction range for the currency.
currency
string
required
Payout currency: KES, NGN, GHS, or UGX.
recipient
object
Optional. When present, the account is validated and the registered name is returned as recipient_name. Shape per method in recipients. An invalid account returns 422.

Example

Response (200)

rate
number
required
Local currency per 1 USDC.
amount_local
number
required
Gross local amount (amount × rate, floored to whole units).
fee
number
required
Minisend fee in local units: 1% for KES, GHS, UGX; 0 for NGN.
recipient_amount
number
required
What the recipient nets: amount_local − fee.
recipient_name
string
The registered account name, when a recipient was supplied and a name was resolved.
expires_at
string
required
Indicative 5-minute quote validity, ISO 8601. For KES, GHS, and UGX the payout executes at the live rate at deposit time regardless; for NGN the rate is locked when you create the order.

Errors

See error handling for the response shape.