> ## 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.

# Fiat currencies and payment methods

> Active Rampnow fiat currencies intersected with Hypermid's runtime shipping scope. Currencies with no currently available allowed payin method are omitted.



## OpenAPI

````yaml /api-reference/openapi.json get /onramp/fiat-capabilities
openapi: 3.1.0
info:
  title: Hypermid API
  description: >-
    Price and execute cross-chain swaps, read reference data and payer balances,
    and quote the fiat on-ramp. Quotes return an executable `transactionRequest`
    your frontend submits directly, so Hypermid never custodies the funds.


    Payments — `checkout`, `deposit`, and `withdrawal` sessions — and
    payment-link management are available through these merchant REST endpoints
    and the [`@hypermid/sdk`](https://docs.hypermid.io/sdk/payments) package.
    Payer-facing routes are intentionally omitted.
  version: 0.2.0
  contact: {}
servers:
  - url: https://server.hypermid.io
    description: Production — live keys (sk_live_…)
  - url: https://server.hypermid.io
    description: Sandbox — test keys (sk_test_…), testnets only
security: []
tags:
  - name: payments
    description: >-
      Create and read payment sessions, manage webhooks, and configure payout
      addresses with a secret partner key.
  - name: payment links
    description: >-
      Create, read, version, and revoke reusable checkout payment links with a
      secret partner key.
  - name: quote
    description: >-
      Route pricing for the orchestration product. Returns an executable
      `transactionRequest` your frontend submits directly, so Hypermid never
      custodies the funds.
  - name: status
    description: >-
      Resolve the state of a submitted swap or transfer. Two endpoints with
      different audiences — see each one's description before choosing.
  - name: catalog
    description: >-
      Reference data an integration needs to render a picker: supported chains
      and tokens, prices, routable connections, and fee configuration. A sandbox
      key sees only testnets here.
  - name: balances
    description: Read a payer wallet's token balances across supported chains.
  - name: onramp
    description: >-
      The fiat rail — card and bank payment for crypto, quoted and settled
      through our onramp partner. Requires per-partner onramp credentials on
      your account.
  - name: webhooks
    description: >-
      Events Hypermid sends TO you when a session completes. These are requests
      we make to your server, not endpoints you call.
paths:
  /onramp/fiat-capabilities:
    get:
      tags:
        - onramp
      summary: Fiat currencies and payment methods
      description: >-
        Active Rampnow fiat currencies intersected with Hypermid's runtime
        shipping scope. Currencies with no currently available allowed payin
        method are omitted.
      operationId: OnrampController_fiatCapabilities
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnrampFiatCapabilitiesResponseDto'
      security:
        - x-api-key: []
components:
  schemas:
    OnrampFiatCapabilitiesResponseDto:
      type: object
      properties:
        currencies:
          description: >-
            Fiat currencies and payment modes confirmed by Rampnow and allowed
            by runtime policy.
          type: array
          items:
            $ref: '#/components/schemas/OnrampFiatCurrencyCapabilityDto'
      required:
        - currencies
    OnrampFiatCurrencyCapabilityDto:
      type: object
      properties:
        code:
          type: string
          description: ISO 4217 fiat currency code.
          example: USD
        payinModes:
          description: >-
            Provider method codes offered now and enabled in Hypermid's runtime
            allowlist.
          type: array
          items:
            type: string
        payoutModes:
          description: Provider payout method codes enabled in the same runtime allowlist.
          type: array
          items:
            type: string
        buy:
          description: >-
            Buy direction confirmed by Rampnow, with provider bounds when
            supplied.
          allOf:
            - $ref: '#/components/schemas/OnrampOrderRangeCapabilityDto'
        sell:
          description: >-
            Sell direction confirmed by Rampnow, with provider bounds when
            supplied.
          allOf:
            - $ref: '#/components/schemas/OnrampOrderRangeCapabilityDto'
      required:
        - code
        - payinModes
        - payoutModes
    OnrampOrderRangeCapabilityDto:
      type: object
      properties:
        min:
          type: string
          description: Provider minimum, denominated in currency.
        max:
          type: string
          description: Provider maximum, denominated in currency.
        currency:
          type: string
          description: Currency that denominates min and max.
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Soft-auth read routes accept `x-api-key` with a publishable or partner
        key; money-moving routes require a secret partner key in `Authorization:
        Bearer`.

````