Class OrderCancelParams
-
- All Implemented Interfaces:
-
com.dinari.api.core.Params
public final class OrderCancelParams implements Params
Cancel an
Orderby its ID. Note that this requires theOrderID, not theOrderRequestID. Once you submit a cancellation request, it cannot be undone. Be advised that orders with a status of PENDING_FILL, PENDING_ESCROW, FILLED, REJECTED, or CANCELLED cannot be cancelled.Ordercancellation is not guaranteed nor is it immediate. TheOrdermay still be executed if the cancellation request is not received in time.Check the status using the "Get Order by ID" endpoint to confirm whether the
Orderhas been cancelled.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classOrderCancelParams.BuilderA builder for OrderCancelParams.
-
Method Summary
Modifier and Type Method Description final StringaccountId()final Optional<String>orderId()final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final OrderCancelParams.BuildertoBuilder()final Optional<Map<String, JsonValue>>_body()final String_pathParam(Integer index)Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static OrderCancelParams.Builderbuilder()Returns a mutable builder for constructing an instance of OrderCancelParams. -
-
Method Detail
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final OrderCancelParams.Builder toBuilder()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static OrderCancelParams.Builder builder()
Returns a mutable builder for constructing an instance of OrderCancelParams.
The following fields are required:
.accountId()
-
-
-
-