Skip to main content
Returns the current state of an onramp order. Use webhooks for updates, and this endpoint to confirm a state.

Endpoint

Requires the onramp scope. Orders you don’t own return 404.

Example

Response (200), KES

Response (200), NGN pending

string
required
pending, deposit_received, completed, failed, cancelled, or expired. See order statuses. deposit_received occurs only on NGN orders, and cancelled only on KES orders. An unpaid order past expires_at returns expired.
string
required
mpesa or bank_transfer.
object
NGN only. The payer’s verified refund account.
object
NGN only. Present only while the order is pending. Don’t show it after expires_at.
string
KES only. The M-Pesa confirmation code, when available.
string
The Base transaction hash of the USDC release. Set on or shortly after completion.
string
Set on failed and cancelled orders. See onramp.failed for the values.
string
ISO 8601.

Errors