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

# Get my FX rates and fees

> Returns the exchange rates that apply to the calling account for each country — the same rates used when operations execute (`local_amount / rate = USDT`) — plus the account's **effective** fee configuration — org defaults already resolved against your account's overrides — so clients can compute the exact cost of an operation before creating it. `rate` is the payout (dispersal) side and `payin_rate` the payin (deposit) side. `asset_prices` carries the USD reference price of each virtual balance asset (BTC per unit, GOLD per gram; stablecoins are 1 by convention) for display/valuation. The `settlement` block shows, per enabled asset, the **effective settlement price** your account would get right now if it paid an operation from that balance (`settlement_rate`, spread included) and whether the asset is currently `available` — use it to estimate before sending `settlement_asset` in a payout.



## OpenAPI

````yaml /openapi.yaml get /v1/rates
openapi: 3.1.0
info:
  title: CBPay API
  version: '1.89'
  description: |
    CBPay is a multi-currency payment platform: fiat payouts and collections
    across Latin America, internal transfers, on-chain funding and
    withdrawals, and KYC screening. Every account holds four independent
    virtual balances — USDT (the operating currency), USDC, BTC and GOLD
    (grams of fine gold) — that never mix or convert automatically.
    Payouts and service fees can be paid from any of the four balances:
    set a default with `PUT /v1/settlement` or override per payout with
    `settlement_asset`.

    All amounts are decimal strings in each currency's precision (6 decimals
    for USDT/USDC/GOLD, 8 for BTC). Errors always return
    `{"error": "<code>", "message": "<detail>"}`.
servers:
  - url: https://api.qbank.cl/platform
    description: Live (production, real money)
  - url: https://cryptobank.qbank.cl/platform
    description: Test (sandbox, simulated money — pk_test_ keys)
security:
  - bearerAuth: []
tags:
  - name: Receipts
    description: >-
      Branded PDF receipt per operation, with a public signed-QR authenticity
      check, receipt_url on every response/webhook and automatic email delivery
      on final states.
  - name: Authentication
    description: Register and log in account members. Sessions last 24 hours.
  - name: Account
    description: Profile, members and API keys of the calling account.
  - name: Balances
    description: Balances, movement history and FX rates.
  - name: Payouts
    description: >-
      Fiat dispersals debited from the settlement balance of your choice (USDT
      by default).
  - name: Payins
    description: Fiat top-ups credited to the USDT balance.
  - name: Transfers
  - name: Contacts
  - name: Swaps
    description: >-
      Free internal transfers between CBPay accounts (person or company, any
      combination).
  - name: Crypto
    description: On-chain funding and withdrawals (TRON, Ethereum and Bitcoin).
  - name: Segregated wallets
    description: >-
      On-chain wallets with their own balance (companies unlimited; persons 1
      per network+asset pair) — create, import, send, export the private key and
      auto-forward. The balance lives on-chain, never in the ledger.
  - name: QR Crypto POS
    description: >-
      Amount-bearing crypto QR charges for processors with physical POS
      terminals (company accounts): verified merchants, exclusive address + QR
      per charge, early payment detection, per-merchant reconciliation and
      refunds over the crypto withdrawal rail.
  - name: KYC / KYB
  - name: AML screening
    description: >-
      Identity verification: KYC for persons, KYB for companies, with AML
      screening, rescreening and continuous monitoring.
  - name: Wallet screening
    description: >-
      AML risk assessment of blockchain addresses (sanctions, illicit-fund
      exposure) with a per-scan fee, plus free automatic protection on
      withdrawals and deposits.
  - name: Analytics
  - name: Webhooks
    description: Subscriptions to receive signed event notifications.
  - name: Status
    description: Service availability.
  - name: Banking
    description: >-
      Real bank accounts: receive, hold and send money over international
      banking rails.
  - name: Cards
    description: >-
      Virtual and physical cards that spend Just-In-Time from the account's USDT
      balance, with per-card spending limits.
  - name: Security (OTP)
    description: >-
      One-time verification codes over SMS/WhatsApp/email protecting sensitive
      actions, plus self-service 2FA preferences. Applies to user sessions only
      — API keys are exempt.
  - name: Passkeys
    description: >-
      Passwordless sign-in with the device's biometrics (Face ID, Touch ID,
      Windows Hello, security keys) via WebAuthn, authenticator apps (TOTP) with
      backup codes, and session/device management.
  - name: Social login
    description: >-
      Passwordless sign up and sign in with Google, Apple, Microsoft and
      Facebook via token exchange. The front end obtains the provider
      credential; the API verifies it and issues the CBPay session.
paths:
  /v1/rates:
    get:
      tags:
        - Balances
      summary: Get my FX rates and fees
      description: >-
        Returns the exchange rates that apply to the calling account for each
        country — the same rates used when operations execute (`local_amount /
        rate = USDT`) — plus the account's **effective** fee configuration — org
        defaults already resolved against your account's overrides — so clients
        can compute the exact cost of an operation before creating it. `rate` is
        the payout (dispersal) side and `payin_rate` the payin (deposit) side.
        `asset_prices` carries the USD reference price of each virtual balance
        asset (BTC per unit, GOLD per gram; stablecoins are 1 by convention) for
        display/valuation. The `settlement` block shows, per enabled asset, the
        **effective settlement price** your account would get right now if it
        paid an operation from that balance (`settlement_rate`, spread included)
        and whether the asset is currently `available` — use it to estimate
        before sending `settlement_asset` in a payout.
      operationId: getRates
      responses:
        '200':
          description: Rates, reference asset prices and fees.
          content:
            application/json:
              schema:
                type: object
                properties:
                  base:
                    type: string
                    example: USD
                  rates:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        currency:
                          type: string
                          example: CLP
                        rate:
                          type: string
                          description: Rate applied to payouts (dispersals).
                          example: '950.123456'
                        payin_rate:
                          type: string
                          description: Rate applied to payins (fiat deposits/collections).
                          example: '955.10'
                  asset_prices:
                    type: object
                    description: >-
                      USD reference price per virtual balance asset
                      (display/valuation).
                    additionalProperties:
                      type: object
                      properties:
                        currency:
                          type: string
                          example: USD
                        unit:
                          type: string
                          description: >-
                            Unit the price refers to (`btc`, `gram`, `usdt`,
                            `usdc`).
                          example: gram
                        price:
                          type: string
                          example: '107.5341'
                        updated_at:
                          type: string
                          description: When this price was last updated.
                        settlement_grade:
                          type: boolean
                          description: >-
                            True when the price is fresh enough to execute
                            settlements (operations paid from that balance).
                  settlement:
                    type: object
                    description: Effective settlement pricing for the calling account.
                    properties:
                      default_asset:
                        type: string
                        description: >-
                          The balance operations debit from when no
                          `settlement_asset` override is sent.
                        example: USDT
                      assets:
                        type: array
                        items:
                          type: object
                          properties:
                            asset:
                              type: string
                              example: BTC
                            available:
                              type: boolean
                              description: >-
                                False when the asset cannot be used right now
                                (disabled or execution price unavailable).
                            settlement_rate:
                              type: string
                              description: >-
                                Effective USD price per unit at which your
                                balance would be valued (spread included); empty
                                when unavailable.
                              example: '109029.34'
                  updated_at:
                    type: string
                  fees:
                    type: array
                    items:
                      $ref: '#/components/schemas/FeeConfig'
              example:
                base: USD
                rates:
                  chile:
                    currency: CLP
                    rate: '950.25'
                    payin_rate: '955.10'
                  mexico:
                    currency: MXN
                    rate: '17.50'
                    payin_rate: '17.62'
                  peru:
                    currency: PEN
                    rate: '3.72'
                    payin_rate: '3.75'
                asset_prices:
                  USDT:
                    currency: USD
                    unit: usdt
                    price: '1'
                  USDC:
                    currency: USD
                    unit: usdc
                    price: '1'
                  BTC:
                    currency: USD
                    unit: btc
                    price: '109853.24'
                    updated_at: '2026-07-07T11:59:41Z'
                    settlement_grade: true
                  GOLD:
                    currency: USD
                    unit: gram
                    price: '107.5341'
                    updated_at: '2026-07-07T09:12:05Z'
                    settlement_grade: true
                settlement:
                  default_asset: USDT
                  assets:
                    - asset: USDT
                      available: true
                      settlement_rate: '1'
                    - asset: USDC
                      available: true
                      settlement_rate: '0.99900000'
                    - asset: BTC
                      available: true
                      settlement_rate: '109029.34070000'
                    - asset: GOLD
                      available: true
                      settlement_rate: '106.99642950'
                updated_at: '2026-07-07T12:00:00Z'
                fees:
                  - id: 3c2b1a09-8d7e-6f5a-4b3c-2d1e0f9a8b7c
                    org_id: 1c9e7a2b-5f6d-4e3a-8c1b-2a9d8e7f6a5b
                    account_id: ''
                    service: payout
                    country: CL
                    asset: USDT
                    percent: '0'
                    fixed_amount: '0.30'
                    status: active
                    updated_at: '2026-07-07T12:00:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AccountRequired'
        '502':
          description: FX rates temporarily unavailable (`rates_unavailable`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: rates_unavailable
                message: could not fetch fx rates
components:
  schemas:
    FeeConfig:
      type: object
      properties:
        id:
          type: string
          format: uuid
        org_id:
          type: string
          format: uuid
        account_id:
          type: string
          description: Empty when the fee is a CBPay default (not an account override).
        service:
          type: string
          enum:
            - payout
            - payin
            - funding
            - withdrawal
            - compliance_person
            - compliance_company
            - compliance_rescreen
            - compliance_transaction
            - compliance_monitoring
        country:
          type: string
        asset:
          type: string
          example: USDT
        percent:
          type: string
          example: '1.5'
        fixed_amount:
          type: string
          example: '0.30'
        status:
          type: string
          example: active
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
          description: Machine-readable error code (snake_case).
          example: insufficient_funds
        message:
          type: string
          description: Human-readable explanation.
  responses:
    Unauthorized:
      description: Missing or invalid credential (`unauthorized`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
            message: invalid or missing credentials
    AccountRequired:
      description: This endpoint requires an account credential (`account_required`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: account_required
            message: this endpoint requires an account credential
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Session JWT (from register/login) or API key (`pk_...`).
        `X-API-Key: <token>` is accepted as an alternative header.

````