openapi: 3.2.0
info:
  version: 1.3.0
  title: Xe.Api.Payments Tradeable Currency API
tags:
- name: TradeableCurrency
paths:
  /tradeablecurrencies:
    get:
      tags:
      - TradeableCurrency
      summary: Get tradeable currencies.
      description: "Sample request:\n\n    Get /tradeablecurrencies"
      operationId: Get
      responses:
        '200':
          description: Returns list of Tradeable currencies.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TradeableCurrencyListResponse'
              example:
                content:
                - amountPrecision: 2
                  isoCode: AED
                  name: UAE Dirham
                  canBuy: true
                  canSell: true
        '404':
          description: Tradeable currencies not found for this user
        '500':
          description: Error getting Tradeable currencies.
components:
  schemas:
    StringStringKeyValuePair:
      type: object
      properties:
        key:
          type: string
          readOnly: true
        value:
          type: string
          readOnly: true
    Message:
      description: "Details for an error or warning that occured during the request or general information from it.\n            \n\"code\" - Code that can be used to find full details for the message.\n\"data\" - Any relevant data that caused the message, if applicable."
      type: object
      properties:
        code:
          type: string
        data:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/StringStringKeyValuePair'
    TradeableCurrency:
      type: object
      properties:
        amountPrecision:
          format: int32
          type: integer
        isoCode:
          type: string
        name:
          type: string
        canBuy:
          type: boolean
        canSell:
          type: boolean
    TradeableCurrencyListResponse:
      description: "Generic response returned for each request.\n            \n\"message\" - Result from the request.\n\"content\" - Data returned in the response.\n\"errors\" - Issues while processing the request.\n\"warnings\" - Potential issues while processing the request or with the response data.\n\"information\" - Extra details relating to the response data.\n<typeparam name=\"T\">The type of the content.</typeparam>"
      type: object
      properties:
        content:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/TradeableCurrency'
        message:
          type: string
        errors:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/Message'
        warnings:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/Message'
        information:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/Message'