Constructor Detail

Method Detail

• id

   final OrderRequest.Builder id(String id)

  ID of OrderRequest. This is the primary identifier for the /order_requests routes.

• id

   final OrderRequest.Builder id(JsonField<String> id)

  Sets Builder.id to an arbitrary JSON value.

  You should usually call Builder.id with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• accountId

   final OrderRequest.Builder accountId(String accountId)

  ID of Account placing the OrderRequest.

• accountId

   final OrderRequest.Builder accountId(JsonField<String> accountId)

  Sets Builder.accountId to an arbitrary JSON value.

  You should usually call Builder.accountId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• createdDt

   final OrderRequest.Builder createdDt(OffsetDateTime createdDt)

  Datetime at which the OrderRequest was created. ISO 8601 timestamp.

• createdDt

   final OrderRequest.Builder createdDt(JsonField<OffsetDateTime> createdDt)

  Sets Builder.createdDt to an arbitrary JSON value.

  You should usually call Builder.createdDt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• orderSide

   final OrderRequest.Builder orderSide(OrderSide orderSide)

  Indicates whether Order is a buy or sell.

• orderSide

   final OrderRequest.Builder orderSide(JsonField<OrderSide> orderSide)

  Sets Builder.orderSide to an arbitrary JSON value.

  You should usually call Builder.orderSide with a well-typed OrderSide value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• orderTif

   final OrderRequest.Builder orderTif(OrderTif orderTif)

  Indicates how long Order is valid for.

• orderTif

   final OrderRequest.Builder orderTif(JsonField<OrderTif> orderTif)

  Sets Builder.orderTif to an arbitrary JSON value.

  You should usually call Builder.orderTif with a well-typed OrderTif value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• orderType

   final OrderRequest.Builder orderType(OrderType orderType)

  Type of Order.

• orderType

   final OrderRequest.Builder orderType(JsonField<OrderType> orderType)

  Sets Builder.orderType to an arbitrary JSON value.

  You should usually call Builder.orderType with a well-typed OrderType value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• status

   final OrderRequest.Builder status(OrderRequestStatus status)

  Status of OrderRequest. Possible values:

  • QUOTED: Order request created with fee quote provided, ready for processing

  • PENDING: Order request is being prepared for submission

  • PENDING_BRIDGE: Order is waiting for bridge transaction to complete

  • SUBMITTED: Order has been successfully submitted to the order book

  • ERROR: An error occurred during order processing

  • CANCELLED: Order request was cancelled

  • EXPIRED: Order request expired due to deadline passing

• status

   final OrderRequest.Builder status(JsonField<OrderRequestStatus> status)

  Sets Builder.status to an arbitrary JSON value.

  You should usually call Builder.status with a well-typed OrderRequestStatus value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• cancelMessage

   final OrderRequest.Builder cancelMessage(String cancelMessage)

  Reason for the order cancellation if the order status is CANCELLED

• cancelMessage

   final OrderRequest.Builder cancelMessage(Optional<String> cancelMessage)

  Alias for calling Builder.cancelMessage with cancelMessage.orElse(null).

• cancelMessage

   final OrderRequest.Builder cancelMessage(JsonField<String> cancelMessage)

  Sets Builder.cancelMessage to an arbitrary JSON value.

  You should usually call Builder.cancelMessage with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• clientOrderId

   final OrderRequest.Builder clientOrderId(String clientOrderId)

  Customer-supplied ID to map this OrderRequest to an order in their own systems.

• clientOrderId

   final OrderRequest.Builder clientOrderId(Optional<String> clientOrderId)

  Alias for calling Builder.clientOrderId with clientOrderId.orElse(null).

• clientOrderId

   final OrderRequest.Builder clientOrderId(JsonField<String> clientOrderId)

  Sets Builder.clientOrderId to an arbitrary JSON value.

  You should usually call Builder.clientOrderId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• orderId

   final OrderRequest.Builder orderId(String orderId)

  ID of Order created from the OrderRequest. This is the primary identifier for the /orders routes.

• orderId

   final OrderRequest.Builder orderId(Optional<String> orderId)

  Alias for calling Builder.orderId with orderId.orElse(null).

• orderId

   final OrderRequest.Builder orderId(JsonField<String> orderId)

  Sets Builder.orderId to an arbitrary JSON value.

  You should usually call Builder.orderId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• recipientAccountId

   final OrderRequest.Builder recipientAccountId(String recipientAccountId)

  ID of recipient Account.

• recipientAccountId

   final OrderRequest.Builder recipientAccountId(Optional<String> recipientAccountId)

  Alias for calling Builder.recipientAccountId with recipientAccountId.orElse(null).

• recipientAccountId

   final OrderRequest.Builder recipientAccountId(JsonField<String> recipientAccountId)

  Sets Builder.recipientAccountId to an arbitrary JSON value.

  You should usually call Builder.recipientAccountId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final OrderRequest.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final OrderRequest.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final OrderRequest.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final OrderRequest.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final OrderRequest.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final OrderRequest build()

  Returns an immutable instance of OrderRequest.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .id()
  .accountId()
  .createdDt()
  .orderSide()
  .orderTif()
  .orderType()
  .status()