> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rhinestone.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# List onramp options

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



## OpenAPI

````yaml https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /onramp/options
openapi: 3.1.0
info:
  title: Deposit Service API
  version: 1.0.0
  description: >-
    Rhinestone Deposits API: accept deposits from any chain, asset or payment
    method, and settle them as one token on one chain.
servers:
  - url: https://v1.orchestrator.rhinestone.dev/deposit-processor
security: []
paths:
  /onramp/options:
    get:
      tags:
        - Onramp
      summary: List onramp options
      description: >-
        What a checkout of this `kind` can offer: fiat payment methods for the
        caller’s country, or exchange connections.
      parameters:
        - schema:
            type: string
            enum:
              - swapped
          required: true
          name: provider
          in: query
        - schema:
            type: string
            enum:
              - fiat
              - exchange
          required: true
          name: kind
          in: query
        - schema:
            type: string
            maxLength: 1024
            description: >-
              `exchange` only. Comma-separated allowlist, served in catalogue
              order; an unknown slug is a 400
          required: false
          description: >-
            `exchange` only. Comma-separated allowlist, served in catalogue
            order; an unknown slug is a 400
          name: connections
          in: query
        - schema:
            type: string
            enum:
              - exchange
              - wallet
              - all
            description: '`exchange` only, ignored with `connections`'
          required: false
          description: '`exchange` only, ignored with `connections`'
          name: connectionKind
          in: query
        - schema:
            type: string
            description: API key for authentication
            example: your-api-key
          required: true
          description: API key for authentication
          name: x-api-key
          in: header
        - schema:
            type: string
            pattern: ^[A-Z]{2}$
            description: >-
              Trusted edge-resolved ISO country. When present it overrides
              body.baseCountry and x-client-ip, and enables country-specific
              payment-method validation.
            example: PH
          required: false
          description: >-
            Trusted edge-resolved ISO country. When present it overrides
            body.baseCountry and x-client-ip, and enables country-specific
            payment-method validation.
          name: x-user-country
          in: header
        - schema:
            type: string
            description: >-
              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
          required: false
          description: >-
            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.
          name: x-client-ip
          in: header
      responses:
        '200':
          description: The options
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnrampOptions'
        '400':
          description: Invalid query
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '401':
          description: Authentication required or invalid API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '403':
          description: API key lacks deposits:read
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '500':
          description: Internal failure serving the request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '503':
          description: Onramp not configured
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
components:
  schemas:
    OnrampOptions:
      oneOf:
        - type: object
          properties:
            provider:
              type: string
              enum:
                - swapped
            kind:
              type: string
              enum:
                - fiat
            country:
              type:
                - string
                - 'null'
              pattern: ^[A-Z]{2}$
              description: >-
                Null when the country or catalogue is unknown; fall back to your
                own defaults
              example: US
            methods:
              type: array
              items:
                type: object
                properties:
                  method:
                    type: string
                  label:
                    type: string
                  iconUrl:
                    type:
                      - string
                      - 'null'
                  iconUrlLight:
                    type:
                      - string
                      - 'null'
                  minAmount:
                    type:
                      - number
                      - 'null'
                    minimum: 0
                  maxAmount:
                    type:
                      - number
                      - 'null'
                    minimum: 0
                  badge:
                    type:
                      - string
                      - 'null'
                    enum:
                      - Popular
                required:
                  - method
                  - label
                  - iconUrl
                  - iconUrlLight
                  - minAmount
                  - maxAmount
                  - badge
            recommendedMethod:
              type:
                - string
                - 'null'
          required:
            - provider
            - kind
            - country
            - methods
            - recommendedMethod
          additionalProperties: false
        - type: object
          properties:
            provider:
              type: string
              enum:
                - swapped
            kind:
              type: string
              enum:
                - exchange
            connections:
              type: array
              items:
                type: object
                properties:
                  connection:
                    type: string
                  name:
                    type: string
                  logoUrl:
                    type:
                      - string
                      - 'null'
                  kind:
                    type: string
                    enum:
                      - exchange
                      - wallet
                    example: exchange
                  appHandoff:
                    type: string
                    enum:
                      - none
                      - https_link
                      - custom_scheme
                    example: none
                required:
                  - connection
                  - name
                  - logoUrl
                  - kind
                  - appHandoff
          required:
            - provider
            - kind
            - connections
          additionalProperties: false

````