Onramp

Start an onramp order

Changed on Nov 6, 2026

Signs a hosted checkout for the account. The order is visible at GET /onramp/orders/{orderId} once the provider first reports it.

post/onramp/orders

Request

Base URL
https://v1.orchestrator.rhinestone.dev/deposit-processor
Auth
- API key in header x-api-key
- or HTTP bearer
TypeScript
https://skmtc.dev/rhinestonewtf/apis/deposit-service-api/docs/onramp/orders/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

x-api-keystring

API key for authentication

Example:your-api-key

x-user-countrystring

Trusted edge-resolved ISO country. When present it overrides body.baseCountry and x-client-ip, and enables country-specific payment-method validation.

Example:PH

x-client-ipstring

The end user's IP address as observed by the edge, for edges that can name the IP but cannot resolve a country themselves (no local GeoIP database). Used only when x-user-country is absent, and ignored unless it is a publicly-routable address. Prefer x-user-country when your edge already has a country — for example Cloudflare's cf-ipcountry — since it needs no lookup here.

Example:203.0.113.7

Request body

Example request

{
  "account": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
  "baseCountry": "US",
  "baseCurrencyCode": "USD",
  "method": "apple-pay",
  "methodSelectionSource": "personalized"
}

Response

Hosted checkout ready

orderIdstring uuid required

expiresAtstring date-time required

Start the checkout before this

Changes

Nov 6, 2026aa1767d704fa Revision changes
- breaking
  the / response's property format changed from uri to no format for status
- warning
  added the new PROVIDER_FORBIDDEN enum value to the response property for the response status
- warning
  added the new PROVIDER_FORBIDDEN enum value to the response property for the response status
- warning
  added the new PROVIDER_FORBIDDEN enum value to the response property for the response status
- warning
  added the new PROVIDER_FORBIDDEN enum value to the response property for the response status
- warning
  added the new PROVIDER_FORBIDDEN enum value to the response property for the response status
- warning
  added the new PROVIDER_REJECTED enum value to the response property for the response status
- warning
  added the new PROVIDER_REJECTED enum value to the response property for the response status
- warning
  added the new PROVIDER_REJECTED enum value to the response property for the response status
- warning
  added the new PROVIDER_REJECTED enum value to the response property for the response status
- warning
  added the new PROVIDER_REJECTED enum value to the response property for the response status
- warning
  added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new READ_ONLY_SESSION enum value to the response property for the response status
- warning
  added the new READ_ONLY_SESSION enum value to the response property for the response status
- warning
  added the new READ_ONLY_SESSION enum value to the response property for the response status
- warning
  added the new READ_ONLY_SESSION enum value to the response property for the response status
- warning
  added the new READ_ONLY_SESSION enum value to the response property for the response status
- info
  the endpoint scheme security internalProjectBearer was added to the API
- info
  the endpoint scheme security tenantApiKey was added to the API
- info
  the header request parameter x-api-key became optional
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Oct 7, 20268b74181ef9e2 Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history (3 revisions)