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

# Get exchange rates

> Returns exchange rates for a given base currency. If symbols is omitted, all supported currencies are returned.



## OpenAPI

````yaml /openapi.json post /v1/exchange-rates/rates
openapi: 3.0.0
info:
  title: Jupico - OpenAPI 3.0
  description: >-
    The Jupico API lets Service Providers onboard merchants, process card and
    eCheck (ACH) payments, run hosted payment pages, manage recurring billing,
    send payouts, and query every resource. All endpoints use HTTPS with Basic
    authentication and accept and return JSON. Endpoints are grouped by
    workflow: onboard merchants first, then accept payments, then move funds and
    report.
  termsOfService: https://help.jupico.com/references-and-resources/legal
  contact:
    email: support@jupico.com
  license:
    name: Jupico License
    url: https://jupico.com
  version: 1.0.5
servers:
  - url: https://sandbox-platform.jupico.com
security:
  - basicAuth: []
tags:
  - name: Status
    description: Health check for the Jupico API.
  - name: Onboarding Invites
    description: >-
      Create and send invites that onboard merchants through the Jupico-hosted
      flow, with optional pre-filled identity, fees, and payout bank account
      data.
  - name: Provisioning
    description: >-
      Onboard merchants from your own UI. Collect onboarding data and submit it
      through the provisioning chain: applicant → application → submerchant.
  - name: Session
    description: >-
      Create browser authorization sessions for the Jupico web components, so
      card and bank account data is tokenized client-side and never touches your
      servers.
  - name: Tokenization
    description: >-
      Convert one-time tokens from the web components into permanent Jupico
      tokens, or tokenize raw card data if your systems are PCI DSS compliant.
  - name: Customer
    description: >-
      Create and manage customer records that payments, subscriptions,
      installments, and invoices link to.
  - name: Card Transactions
    description: >-
      Process credit and debit card transactions using tokenized card data:
      sale, authorization, capture, void, refund, and rollback.
  - name: eCheck Transactions
    description: >-
      Debit customer bank accounts via eCheck (ACH): sale, void, refund,
      rollback, and bank account tokenization.
  - name: Checkouts
    description: >-
      Hosted checkout sessions where customers complete payment on a
      Jupico-hosted page.
  - name: Payment Links
    description: >-
      Shareable links that open a Jupico-hosted payment page — no integration
      code needed at the point of sharing.
  - name: Invoices
    description: Create and email invoices that customers pay online.
  - name: Subscriptions
    description: >-
      Recurring billing. Plans define billing schedules and pricing models;
      subscriptions enroll customers against a stored payment token.
  - name: Installments
    description: Split a fixed total into scheduled payments with an optional deposit.
  - name: Payouts
    description: >-
      Send funds from a submerchant's available balance to a tokenized bank
      account with on-demand payout instructions.
  - name: Query
    description: >-
      Search and report across every resource: transactions, merchants,
      settlements, balances, disputes, fees, and more. All query endpoints
      accept the same filter, sort, and pagination envelope — see the Query
      Capabilities guide.
  - name: Currency Exchange API
    description: >-
      Query live exchange rates, convert amounts between currencies, and
      retrieve the list of supported currency codes.
paths:
  /v1/exchange-rates/rates:
    post:
      tags:
        - Currency Exchange API
      summary: Get exchange rates
      description: >-
        Returns exchange rates for a given base currency. If symbols is omitted,
        all supported currencies are returned.
      operationId: getExchangeRates
      requestBody:
        $ref: '#/components/requestBodies/getExchangeRates'
      responses:
        '200':
          $ref: '#/components/responses/getExchangeRates'
      security:
        - basicAuth: []
components:
  requestBodies:
    getExchangeRates:
      description: Requests exchange rates for a base currency.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/getExchangeRates'
          examples:
            getExchangeRates:
              $ref: '#/components/examples/getExchangeRates'
  responses:
    getExchangeRates:
      description: Exchange rates for the requested base currency.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                description: >-
                  Whether the request was processed successfully. Declines
                  return HTTP 200 with `success: false`.
              message:
                type: string
                description: Human-readable result message.
              code:
                type: string
                description: Machine-readable result code. See the Error Codes reference.
              data:
                type: object
                properties:
                  base:
                    type: string
                    description: Base currency the rates are quoted against.
                  rates:
                    type: object
                    additionalProperties:
                      type: number
                    description: >-
                      Rates keyed by 3-letter ISO 4217 currency code. Each value
                      is the amount of that currency equal to one unit of the
                      base currency.
                  fetchedAt:
                    type: string
                    format: date-time
                    description: >-
                      UTC timestamp of when the rates were retrieved from the
                      rate provider.
                description: The response payload.
          examples:
            getExchangeRatesResponse:
              $ref: '#/components/examples/getExchangeRatesResponse'
  schemas:
    getExchangeRates:
      type: object
      properties:
        base:
          type: string
          minLength: 3
          maxLength: 3
          description: >-
            Base currency the rates are quoted against. 3-letter ISO 4217 code,
            uppercase.
          example: USD
        symbols:
          type: array
          items:
            type: string
            minLength: 3
            maxLength: 3
            description: Target currency code. 3-letter ISO 4217 code, uppercase.
            example: GBP
          description: >-
            Target currency codes to return rates for. Omit to return every
            supported currency.
      required:
        - base
  examples:
    getExchangeRates:
      summary: Rates for a single target currency
      value:
        base: USD
        symbols:
          - GBP
    getExchangeRatesResponse:
      summary: Rates retrieved successfully
      value:
        success: true
        message: succeeded
        code: '0'
        data:
          base: USD
          rates:
            GBP: 0.7845
          fetchedAt: '2026-08-14T16:20:45.331Z'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````