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

# Get On-Ramp Config

> Get supported fiat currencies and payment methods

Returns the available fiat currencies and payment methods for the on-ramp service.

<ResponseExample>
  ```json 200 theme={"system"}
  {
    "data": {
      "currencies": [
        { "code": "USD", "name": "US Dollar", "symbol": "$" },
        { "code": "EUR", "name": "Euro", "symbol": "\u20ac" },
        { "code": "GBP", "name": "British Pound", "symbol": "\u00a3" },
        { "code": "CAD", "name": "Canadian Dollar", "symbol": "C$" },
        { "code": "AUD", "name": "Australian Dollar", "symbol": "A$" },
        { "code": "CHF", "name": "Swiss Franc", "symbol": "CHF" }
      ],
      "paymentMethods": [
        {
          "id": "credit_card",
          "name": "Credit Card",
          "processingTime": "Instant",
          "feePercentage": 3.49
        },
        {
          "id": "debit_card",
          "name": "Debit Card",
          "processingTime": "Instant",
          "feePercentage": 2.99
        },
        {
          "id": "bank_transfer",
          "name": "Bank Transfer",
          "processingTime": "1-3 business days",
          "feePercentage": 1.49
        }
      ]
    },
    "error": null,
    "meta": {
      "requestId": "u1d2e3f4-a5b6-7890-4567-901234567890",
      "timestamp": 1711234579,
      "rateLimit": {
        "limit": 2000,
        "remaining": 1979,
        "reset": 1711234627
      }
    }
  }
  ```
</ResponseExample>

<CodeGroup>
  ```typescript TypeScript theme={"system"}
  const config = await client.getOnrampConfig();

  console.log("Supported currencies:");
  for (const currency of config.data.currencies) {
    console.log(`  ${currency.symbol} ${currency.code} - ${currency.name}`);
  }

  console.log("Payment methods:");
  for (const method of config.data.paymentMethods) {
    console.log(`  ${method.name}: ${method.feePercentage}% fee, ${method.processingTime}`);
  }
  ```

  ```bash cURL theme={"system"}
  curl https://api.hypermid.io/v1/onramp/config \
    -H "X-API-Key: your-api-key"
  ```

  ```go Go theme={"system"}
  req, _ := http.NewRequest("GET",
      "https://api.hypermid.io/v1/onramp/config", nil)
  req.Header.Set("X-API-Key", "your-api-key")
  resp, _ := http.DefaultClient.Do(req)
  ```
</CodeGroup>


## OpenAPI

````yaml GET /v1/onramp/config
openapi: 3.0.3
info:
  title: Hypermid Partner API
  version: 1.0.0
  description: >-
    Cross-chain swap aggregator API. Supports 30+ EVM chains, Solana, Bitcoin,
    Sui, and Near Intents chains (NEAR, TON, Tron, XRP, etc.).


    ## Authentication

    Pass your API key via the `X-API-Key` header. Public endpoints work without
    a key (anonymous tier). Partner endpoints (`/v1/partner/*`) require a valid
    key.


    ## Rate Limits

    - **Anonymous**: 30 requests/minute (per IP)

    - **Partner (authenticated)**: 100 requests/minute (per API key)


    These limits are designed for human-driven widget usage and mirror our
    upstream aggregator (LiFi) limits to prevent any single user from exhausting
    shared quota.


    Rate limit info is returned in `meta.rateLimit` on every response.


    ## Response Envelope

    All responses follow the shape:

    ```json

    { "data": <T | null>, "error": <{ code, message, details? } | null>, "meta":
    { "requestId", "timestamp", "rateLimit?" } }

    ```
  contact:
    name: Hypermid
    url: https://hypermid.io
servers:
  - url: https://api.hypermid.io
    description: Production
security:
  - ApiKeyAuth: []
  - {}
tags:
  - name: Swap
    description: Cross-chain swap quoting, routing, status, and reference data
  - name: Execute
    description: Transaction execution and deposit management for Near Intents swaps
  - name: On-Ramp
    description: Fiat-to-crypto on-ramp via RampNow
  - name: Partner
    description: Partner account, analytics, and webhook management (requires X-API-Key)
  - name: Tracking
    description: Swap event tracking for partner attribution
  - name: System
    description: Health check and API metadata
paths:
  /v1/onramp/config:
    get:
      tags:
        - On-Ramp
      summary: On-ramp supported chains and tokens
      description: >-
        Returns a mapping of supported chains to their available tokens for fiat
        on-ramp. Cached for 5 minutes.
      operationId: getOnrampConfig
      responses:
        '200':
          description: Config data
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiResponse'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          chains:
                            type: object
                            additionalProperties:
                              type: array
                              items:
                                type: string
                            description: Map of chain name to array of token symbols
        '502':
          $ref: '#/components/responses/UpstreamError'
components:
  schemas:
    ApiResponse:
      type: object
      properties:
        data:
          description: Response payload (null on error)
        error:
          nullable: true
          type: object
          properties:
            code:
              type: string
              example: INVALID_PARAMS
            message:
              type: string
              example: 'Missing required parameters: fromChain'
            details:
              type: object
              additionalProperties: true
          required:
            - code
            - message
        meta:
          $ref: '#/components/schemas/Meta'
      required:
        - data
        - error
        - meta
    Meta:
      type: object
      properties:
        requestId:
          type: string
          format: uuid
        timestamp:
          type: integer
          description: Unix epoch seconds
        rateLimit:
          type: object
          properties:
            limit:
              type: integer
            remaining:
              type: integer
            reset:
              type: integer
              description: Unix epoch seconds when the window resets
      required:
        - requestId
        - timestamp
  responses:
    UpstreamError:
      description: Upstream provider error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Partner API key. Optional for public endpoints, required for
        /v1/partner/*.

````