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

# Get Exchange Rates

> Returns the current exchange rates for a payout currency.

Each rate provides its `exchange_rate`, base/payout currency and apply time. Use it to quote
the payout amount before creating a payout.



## OpenAPI

````yaml GET /api/platform/cross-border/rates
openapi: 3.1.0
info:
  title: paywint
  version: 0.1.0
servers:
  - url: https://api.paywint.com
  - url: https://api.sandbox.paywint.com
security: []
paths:
  /api/platform/cross-border/rates:
    get:
      tags:
        - Platform Cross-Border
      summary: Get Exchange Rates
      description: >-
        Returns the current exchange rates for a payout currency.


        Each rate provides its `exchange_rate`, base/payout currency and apply
        time. Use it to quote

        the payout amount before creating a payout.
      operationId: get_rates_api_platform_cross_border_rates_get
      parameters:
        - name: payout_currency
          in: query
          required: true
          schema:
            type: string
            description: Payout currency ISO code, e.g. INR.
            title: Payout Currency
          description: Payout currency ISO code, e.g. INR.
          example: INR
        - name: X-Platform-ID
          in: header
          required: true
          schema:
            type: string
            format: uuid
            description: >-
              Unique platform identifier (UUID). You receive this during
              onboarding. Must be sent with every API request.
            title: X-Platform-Id
          description: >-
            Unique platform identifier (UUID). You receive this during
            onboarding. Must be sent with every API request.
        - name: X-Signature
          in: header
          required: true
          schema:
            type: string
            description: >-
              HMAC-SHA256 request signature for authentication. Use your
              platform secret key to compute it as: `METHOD + PATH + QUERY +
              BODY_HASH`.
            title: X-Signature
          description: >-
            HMAC-SHA256 request signature for authentication. Use your platform
            secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse_list_UnitellerRateItem__'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CommonResponse_list_UnitellerRateItem__:
      properties:
        success:
          type: boolean
          title: Success
          description: Indicates whether the request was processed successfully.
          default: true
          example: true
        message:
          type: string
          title: Message
          description: >-
            A short, human-readable message describing the result of the
            request.
          default: Success
          example: Operation completed.
        data:
          anyOf:
            - items:
                $ref: '#/components/schemas/UnitellerRateItem'
              type: array
            - type: 'null'
          title: Data
          description: The main response payload, if applicable
        queryGeneratedTime:
          anyOf:
            - type: number
            - type: 'null'
          title: Querygeneratedtime
          description: >-
            The Unix timestamp (in seconds) indicating when the response was
            generated.
          default: 1783409763.80796
          example: 1718006400
      type: object
      title: CommonResponse[list[UnitellerRateItem]]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UnitellerRateItem:
      properties:
        id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Id
          description: Rate id.
          example: 1071
        payout_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Payout Currency
          description: Currency paid out.
          example: INR
        base_currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Base Currency
          description: Source (base) currency.
          example: USD
        exchange_rate:
          anyOf:
            - type: number
            - type: 'null'
          title: Exchange Rate
          description: Applied FX rate (base → payout).
          example: 94.8907
        apply_time:
          anyOf:
            - type: string
            - type: 'null'
          title: Apply Time
          description: When the rate applies.
          example: '2026-06-13T05:13:13'
        fixed:
          anyOf:
            - type: integer
            - type: 'null'
          title: Fixed
          description: Whether the rate is fixed.
          example: 1
      type: object
      title: UnitellerRateItem
      description: An exchange-rate row (getRates).
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````