WireBloomDevelopers

    Exchange

    Schema #/components/schemas/Exchange of contract 1.0.0-draft.14.

    • id Uuidrequiredread-only

      Fields of id

      Uuid

    • customerId Uuidrequiredread-only

      Fields of customerId

      Uuid

    • kind ExchangeKindrequired

    • status ExchangeStatusrequiredread-only

      Fields of status

      ExchangeStatus

    • sellBalanceId Uuidrequired

    • buyBalanceId Uuidrequired

    • sellAmount Moneyrequired

    • buyAmount Moneyrequired

    • rate Raterequired

    • fixedSide FixedSiderequired

    • quoteId Uuidrequired

    • fee Money | null

    • settlementDate Date | null

    • deposit Money | null

    • remaining Money | null

    • orderId stringrequiredread-only

      Human order id shown on confirmations.

    • providerRef string | nullread-only

    • createdBy Uuid | null

    • createdAt Timestamprequiredread-only

      Fields of createdAt

      Timestamp

    • completedAt Timestamp | null

    • purpose stringread-only

      What the conversion is for: a direct exchange, an add-money conversion order or the funding of a cross-currency payment.

      One of: "exchange", "add_money", "payment"

    • statusReason string | nullread-only

      Why the exchange failed or was cancelled.

    • marginCall object | nullread-only

      Open margin call on a forward: deposit top-up required (POST /forward-contracts/{exchangeId}/deposit).

      Fields of marginCall

    • drawdownCount integerread-only

      Drawdowns requested on a forward or held-rate contract.

      min 0