Endpoint
offramp scope. See getting access.
Body
number
required
The amount in USDC, from 0.5 to 50,000. The local amount also has to be within the limits for the currency.
string
required
Payout currency:
KES, NGN, GHS, or UGX.object
Optional. If you add it, we check the account and return the registered name as
recipient_name. See recipients for the fields. An invalid account returns 422.For KES, add it when you can. The recipient decides which way the order goes, and that changes the price. Without it, a KES quote is priced as a payout to an M-Pesa phone.Example
Response (200)
number
required
Local currency per 1 USDC.
number
required
The local amount before the fee:
amount × rate, rounded down to a whole number.number
required
Our fee in local currency, taken from the payout on send-and-confirm orders.
0 on automatic orders, where a sender fee is added to what you send instead.number
required
What the recipient actually gets:
amount_local − fee.number
Automatic orders only. Roughly what you’ll send, including the sender fee. A small network fee can be added when you create the order, so send the exact
total_deposit_usdc the order gives you, not this.string
The name the account is registered to, when you added a
recipient and we found a name.string
required
Roughly how long this quote holds, about 5 minutes, ISO 8601. On send-and-confirm orders, we pay out at the live rate when your USDC arrives anyway. On automatic orders, the rate is fixed when you create the order.
Errors
See error handling for the response shape.

