Endpoint
onramp scope.
Body
NGN only, at most 2 decimal places. The exact NGN amount the payer will transfer. Provide this or
amount_usdc, not both.KES only, required. The customer’s Kenyan mobile number, any common format (
0712345678, +254712345678, 254712345678).KES only.
Safaricom. Optional: the network is detected from the number. Set it for numbers ported to Safaricom. Only Safaricom M-Pesa is supported. Airtel returns 400.NGN only, required. The payer’s bank account, used for refunds if the order fails after payment.
institution: bank code fromGET /api/onramp/institutions.account_number: the 10-digit NUBAN.account_name: optional. Looked up from the bank. Required only when a422asks for it.
A wallet address you control, starting with
0x. USDC is released here on Base after payment.Your own reference, such as your order ID. Returned as
external_reference in responses and webhooks.Example, KES
Response (201), KES
Example, NGN
Response (201), NGN
NGN only. Present while the order is
pending. Show amount to the payer exactly as returned: it’s a string and may include kobo.The payment deadline, ISO 8601. After it, the order is
expired. Always read it from the response.
