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

> ## Agent Instructions
> HEVN accounts are non-custodial in both products. Self-serve (the General tab): the person who owns the email holds the only key and signs for themselves. Whitelabel (the Whitelabel and REST API tabs): the integrator's customer creates and owns their account through Sign in with HEVN, a HEVN-hosted popup on the integrator's site; the integrator's backend holds a developer key, operates linked accounts and books their payouts, and the account holder approves every payout in that popup. The developer key signs only for the integrator's own wallet; it never signs a client's money.
> Use HEVN's terms exactly. A rail is a bank route a client can request. A virtual account (bnk_) is an opened rail. Account details are what a payer needs in order to wire money, and arrive in a field named requisites. A client is a customer's own account linked to the integrator through Sign in with HEVN (POST /dapi/v1/connect/sessions, then POST /dapi/v1/clients/link); there is no API call that creates one. The business behind it is the integrator's customer. A contact is a saved destination; a beneficiary is the party at the far end of a fiat payout. Every departure of money is a payout, to a bank account or to a wallet alike.
> Never name a banking partner. Say 'a licensed banking partner'.
> There are no published fee rates, spreads or minimums. Prices come from a quote on a specific payment; direct pricing questions to HEVN rather than inventing numbers.
> The whitelabel API is at /dapi/v1 and takes a developer-key session plus an X-Hevn-Account header. Developer keys have an IP allowlist and no scopes. Remote transfers are at /api/v1/remote_spend_limit and take a remote transfer key (rsl_) in X-Api-Key, bounded by an onchain spend permission the account holder grants. They are different credentials and neither works on the other surface. The HEVN CLI is discontinued.

# Retrieve the receiving conversion rate

> Return the current conversion rate and fixed fee for this receiving payment method. The result is indicative until an incoming transfer is created.



## OpenAPI

````yaml /openapi.json get /banks/{product}/rate
openapi: 3.1.0
info:
  title: HEVN Platform API
  description: >-
    HEVN's account, verification and money-movement API. Verification follows a
    submission workflow: save applicant info and documents, inspect outstanding
    requirements, then explicitly complete the submission to send an immutable
    snapshot for review. Completing a submission is separate from editing it.
  version: 1.0.0
servers: []
security: []
tags:
  - name: auth
    description: Authenticate an integration and issue short-lived account sessions.
  - name: accounts
    description: Create and manage business or individual customer accounts.
  - name: verification
    description: >-
      Collect business-applicant and related-individual information, inspect
      requirements, and complete a verification submission for review.
  - name: documents
    description: Upload verification and payment evidence for later reference by id.
  - name: virtual accounts
    description: Discover payment methods and create persistent receiving account details.
  - name: transfers
    description: Quote, create, authorize and track incoming or outgoing transfers.
  - name: contacts
    description: Create saved contacts and inspect their available payment channels.
  - name: transactions
    description: Read and export the account ledger.
  - name: escrow
    description: Create, authorize and reconcile on-chain escrow agreements.
  - name: sandbox
    description: Emulate funding and lifecycle events in the sandbox environment.
paths:
  /banks/{product}/rate:
    get:
      tags:
        - virtual accounts
      summary: Retrieve the receiving conversion rate
      description: >-
        Return the current conversion rate and fixed fee for this receiving
        payment method. The result is indicative until an incoming transfer is
        created.
      operationId: read_rail_rate_banks__product__rate_get
      parameters:
        - name: product
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/RailProduct'
            description: Region product, for example eu or us
            examples:
              - eu
          description: Region product, for example eu or us
        - name: X-Hevn-Account
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              The client account to act for, as a `cl_…` id. Omit it to act as
              yourself.
            examples:
              - cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41
            title: X-Hevn-Account
          description: >-
            The client account to act for, as a `cl_…` id. Omit it to act as
            yourself.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RailRateView'
        '422':
          description: Request validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformErrorResponse'
      security:
        - HTTPBearer: []
components:
  schemas:
    RailProduct:
      type: string
      enum:
        - us
        - swift
        - eu
        - uae
        - uk
        - br
        - mx
        - co
        - ar
        - au
        - ng
        - ca
        - dk
        - 'no'
        - pl
        - tr
        - il
        - sa
        - bo
        - cl
        - cr
        - do
        - gt
        - hn
        - jm
        - eg
        - sl
        - tz
        - ug
        - waemu
        - zm
        - bd
        - cn
        - hk
        - in
        - id
        - jp
        - my
        - pk
        - ph
        - kr
        - th
        - vn
        - card
      title: RailProduct
    RailRateView:
      properties:
        currency:
          type: string
          title: Currency
          description: ISO 4217 fiat currency code for this conversion.
        rate:
          anyOf:
            - type: string
              example: '500.00'
            - type: 'null'
          title: Rate
          description: Conversion rate net of markup, when currently available.
        fixedFee:
          anyOf:
            - type: string
              example: '500.00'
            - type: 'null'
          title: Fixedfee
          description: Fixed fee component, when charged.
        fixedFeeCurrency:
          anyOf:
            - type: string
            - type: 'null'
          title: Fixedfeecurrency
          description: Currency in which the fixed fee is charged.
      type: object
      required:
        - currency
      title: RailRateView
    PlatformErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/PlatformErrorBody'
          description: Public error body.
      type: object
      required:
        - error
      title: PlatformErrorResponse
    PlatformErrorBody:
      properties:
        code:
          $ref: '#/components/schemas/PlatformErrorCode'
          description: Stable machine-readable error code.
        message:
          type: string
          title: Message
          description: Human-readable explanation safe to show to an end user.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: Structured context for this error, when available.
      type: object
      required:
        - code
        - message
      title: PlatformErrorBody
    PlatformErrorCode:
      type: string
      enum:
        - invalid_request
        - validation_failed
        - invalid_cursor
        - invalid_id
        - idempotency_key_invalid
        - idempotency_key_reused
        - unauthenticated
        - token_expired
        - forbidden
        - not_found
        - method_not_allowed
        - conflict
        - gone
        - payload_too_large
        - rate_limited
        - provider_unavailable
        - database_unavailable
        - internal_error
        - invalid_credentials
        - request_expired
        - challenge_not_found
        - challenge_consumed
        - challenge_expired
        - signature_invalid
        - key_not_registered
        - signer_not_attached
        - wallet_not_linked
        - approval_consumed
        - approval_expired
        - approval_mismatch
        - signing_policy_refused
        - login_unavailable
        - login_mode_unavailable
        - developer_key_not_found
        - developer_key_already_exists
        - account_header_invalid
        - account_scope_conflict
        - account_not_found
        - account_forbidden
        - account_read_only
        - account_not_controlled
        - contact_not_found
        - quote_not_submitted
        - quote_not_fundable
        - funding_mode_unsupported
        - funding_token_unsupported
        - insufficient_funds
        - smart_wallet_not_deployed
        - wallet_owner_unverified
        - already_funded
        - payment_slot_consumed
        - funding_in_progress
        - funding_attempt_expired
        - contact_changed
        - user_operation_rejected
        - user_operation_unavailable
        - transfer_policy_denied
        - client_creation_not_enabled
        - client_not_found
        - link_code_invalid
        - link_code_expired
        - client_already_linked
        - redirect_uri_not_allowed
        - payout_not_awaiting_signature
        - verification_not_applicable
        - profile_locked
        - contact_not_payable
        - contact_chain_unsupported
        - contact_token_unsupported
        - contact_payment_details_invalid
        - amount_below_minimum
        - amount_above_maximum
        - amount_precision_unsupported
        - payout_not_found
        - payout_not_fundable
        - quote_expired
        - bundler_rejected
        - bundler_unavailable
        - contact_details_invalid
        - contact_in_use
        - kyb_incomplete
        - kyb_documents_processing
        - kyb_roster_conflict
        - kyb_subject_conflict
        - document_not_found
        - document_type_unsupported
        - invalid_enum_value
        - entity_not_found
        - escrow_not_found
        - escrow_action_not_found
        - escrow_not_operated_by_you
        - escrow_state_changed
        - action_in_flight
        - simulation_failed
        - stale_nonce
        - amount_out_of_range
        - amount_not_allowed
        - window_closed
        - token_not_supported
        - receiver_not_a_client
        - rail_not_found
        - rail_not_available
        - payin_not_available
        - payin_expired
        - payin_not_found
        - transaction_not_found
        - account_unavailable
        - account_not_supported
        - swap_not_found
        - swap_route_unavailable
        - swap_not_confirmable
        - intent_not_signable
        - sandbox_amount_limit_exceeded
        - sandbox_faucet_balance_too_high
      title: PlatformErrorCode
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.