Onramp

List onramp options

Changed on Nov 6, 2026

What a checkout of this kind can offer: fiat payment methods for the caller’s country, or exchange connections.

get/onramp/options

Request

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

Query parameters

provider'swapped' | 'noah' required

kind'fiat' | 'exchange'

swapped only, required there

currency'EUR' | 'USD'

noah only. One option for this currency; both without

connectionsstring

swapped exchange only. Comma-separated allowlist, served in catalogue order; an unknown slug is a 400

connectionKind'exchange' | 'wallet' | 'all'

swapped exchange only, ignored with connections

Headers

x-api-keystring

Integrator API key: the project’s orders

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

authorizationstring

Customer bearer from POST /compliance/sessions, or a project-scoped platform bearer where the route permits tenant access

Example:Bearer eyJhbGciOi...

Response

The options

Example response

{
  "country": "US",
  "methods": [
    {
      "currencies": [
        "EUR",
        "USD",
        "GBP"
      ]
    }
  ],
  "otherMethods": [
    {
      "currencies": [
        "EUR",
        "USD",
        "GBP"
      ]
    }
  ]
}

Changes

Nov 6, 2026aa1767d704fa Revision changes
- 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_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_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 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
- 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 complianceSessionBearer was added to the API
- info
  the endpoint scheme security internalProjectBearer was added to the API
- info
  the endpoint scheme security tenantApiKey was added to the API
- 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
- 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
- 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 required property / to the response with the status

Operation history (4 revisions)