PlatformCurrencyConfig.yaml

type: object
properties:
  currencyCode:
    type: string
    description: Three-letter currency code (ISO 4217)
    example: USD
  minAmount:
    type: integer
    format: int64
    description: >-
      Minimum amount that can be sent in the smallest unit of this currency.
      Note that the effective minimum for transactions may be higher than this
      value if the underlying UMA provider enforces a higher minimum (see
      umaProviderMinAmount). The effective minimum used in receiver lookups is
      max(minAmount, umaProviderMinAmount).
    minimum: 0
    example: 100
  maxAmount:
    type: integer
    format: int64
    description: >-
      Maximum amount that can be sent in the smallest unit of this currency.
      Note that the effective maximum for transactions may be lower than this
      value if the underlying UMA provider enforces a lower maximum (see
      umaProviderMaxAmount). The effective maximum used in receiver lookups is
      min(maxAmount, umaProviderMaxAmount).
    minimum: 0
    example: 1000000
  umaProviderMinAmount:
    type: integer
    format: int64
    description: >-
      The minimum transaction amount enforced by the underlying UMA provider
      for this currency, in the smallest unit of the currency. This is a
      read-only value that reflects provider-level constraints such as minimum
      trade values on the underlying exchange (which may be denominated in BTC
      and converted to this currency at current rates). The effective minimum
      for transactions is max(minAmount, umaProviderMinAmount).
    readOnly: true
    minimum: 0
    example: 500
  umaProviderMaxAmount:
    type: integer
    format: int64
    description: >-
      The maximum transaction amount enforced by the underlying UMA provider
      for this currency, in the smallest unit of the currency. This is a
      read-only value that reflects provider-level constraints. The effective
      maximum for transactions is min(maxAmount, umaProviderMaxAmount).
    readOnly: true
    minimum: 0
    example: 1000000
  requiredCounterpartyFields:
    type: array
    items:
      $ref: ../common/CounterpartyFieldDefinition.yaml
    description: >-
      List of fields which the platform requires from the counterparty
      institutions about counterparty users. Platforms can set mandatory to
      false if the platform does not require the field, but would like to have
      it available. Some fields may be required by the underlying UMA provider.
    example:
      - name: FULL_NAME
        mandatory: true
      - name: BIRTH_DATE
        mandatory: true
      - name: NATIONALITY
        mandatory: true
  umaProviderRequiredUserFields:
    type: array
    items:
      $ref: ../users/UserInfoFieldName.yaml
    description: >-
      List of user info field names that are required by the underlying UMA
      provider when creating a user for this currency. These fields must be
      supplied when creating or updating a user if this currency is intended to
      be used by that user. If no fields are required, this field is omitted.
    readOnly: true
    example:
      - NATIONALITY
      - BIRTH_DATE
  umaProviderRequiredCounterpartyUserFields:
    type: array
    items:
      $ref: ../users/UserInfoFieldName.yaml
    description: >-
      List of fields that are required by the underlying UMA provider for this
      currency. If the counterparty does not provide these fields, quote
      requests will fail.
    readOnly: true
    example:
      - FULL_NAME
      - COUNTRY_OF_RESIDENCE
  enabledTransactionTypes:
    type: array
    items:
      $ref: ../transactions/TransactionType.yaml
    description: List of transaction types that are enabled for this currency.
    example: 
      - OUTGOING
      - INCOMING
required:
  - currencyCode
  - minAmount
  - maxAmount
  - requiredCounterpartyFields
  - enabledTransactionTypes