Skip to main content
Tells you what a collection will cost and what you’ll receive, without creating anything or sending a payment prompt.

Endpoint

Requires the onramp scope. See getting access.

Body

string
required
KES (M-Pesa) or NGN (bank transfer).
number
How much USDC you want to receive. Your customer pays that amount in local currency, plus the platform fee. Send this or amount_kes / amount_ngn, not both.
number
KES only. Exactly how much KES to charge your customer. We take the fee from it and turn the rest into USDC. Send this or amount_usdc, not both.
number
NGN only, up to 2 decimal places. Exactly how much NGN to charge the payer. We take the fee from it and turn the rest into USDC. Send this or amount_usdc, not both.

Example

Response (200), KES

Response (200), NGN

string
required
mpesa or bank_transfer.
number
KES only. Exactly what your customer will be asked to pay on their phone.
number
KES only. Our fee in KES. It’s already part of amount_kes.
number
KES only. amount_kes minus fee_kes. This is the part that becomes USDC.
number
NGN only. Exactly what the payer will be asked to send.
number
NGN only. Our fee in NGN. It’s already part of amount_ngn.
number
NGN only. amount_ngn minus fee_ngn. This is the part that becomes USDC.
number
required
What your address will receive.
number
required
How much local currency 1 USDC is worth right now.
string
required
Roughly how long this quote holds, ISO 8601. A quote doesn’t fix the price. The order uses the live rate at the moment you create it.

Errors

See error handling for the response shape.