79 lines
3.0 KiB
YAML
79 lines
3.0 KiB
YAML
components:
|
|
schemas:
|
|
FXCurrency:
|
|
description: Display-facing currency metadata sourced from the Treasury Currency Catalog startup snapshot cached by the BFF.
|
|
type: object
|
|
additionalProperties: false
|
|
required:
|
|
- code
|
|
- kind
|
|
properties:
|
|
code:
|
|
description: Treasury canonical asset code.
|
|
type: string
|
|
kind:
|
|
description: Compatibility asset kind projection. Use `assetKind` for the Treasury-owned exact asset kind.
|
|
type: string
|
|
enum:
|
|
- fiat
|
|
- crypto
|
|
- internal
|
|
assetKind:
|
|
description: Treasury-owned asset kind. Network-specific support, provider asset codes, token contracts, and provider rails are not represented here.
|
|
type: string
|
|
enum:
|
|
- fiat
|
|
- crypto_token
|
|
- crypto_native
|
|
- internal_platform
|
|
decimals:
|
|
description: Display-facing compatibility field backed by Treasury `displayScale`. Backend services and clients must not use it as accounting, quote, or payout execution precision authority.
|
|
type: integer
|
|
format: int32
|
|
minimum: 0
|
|
scale:
|
|
description: Display-facing compatibility field backed by Treasury `displayScale`; always equal to `decimals` in this response.
|
|
type: integer
|
|
format: int32
|
|
minimum: 0
|
|
displayScale:
|
|
description: Treasury UI/display precision.
|
|
type: integer
|
|
format: int32
|
|
minimum: 0
|
|
accountingScaleCandidate:
|
|
description: Informational Treasury accounting scale candidate. This is not provider execution precision, not FX rate precision, and not guaranteed executable payout precision or provider support.
|
|
type: integer
|
|
format: int32
|
|
minimum: 0
|
|
rounding:
|
|
description: Preferred rounding mode for the currency, when supplied by the oracle.
|
|
type: string
|
|
enum:
|
|
- round_half_even
|
|
- round_half_up
|
|
- round_down
|
|
|
|
FXDirection:
|
|
description: Direction-level FX availability for an organization.
|
|
type: object
|
|
additionalProperties: false
|
|
required:
|
|
- fromCurrency
|
|
- toCurrency
|
|
- pair
|
|
- side
|
|
properties:
|
|
fromCurrency:
|
|
description: Source currency of the directed conversion.
|
|
type: string
|
|
toCurrency:
|
|
description: Target currency of the directed conversion.
|
|
type: string
|
|
pair:
|
|
description: Oracle canonical base/quote pair from which the direction was derived. This pair does not follow display from/to order.
|
|
$ref: ./payment.yaml#/components/schemas/CurrencyPair
|
|
side:
|
|
description: FX side interpreted against the canonical pair. `sell_base_buy_quote` means the customer sells base and receives quote; `buy_base_sell_quote` means the customer buys base and pays quote.
|
|
$ref: ../../external/fx_side.yaml#/components/schemas/FxSide
|