Class OrderBatchCancelParams
-
- All Implemented Interfaces:
-
com.dinari.api.core.Params
public final class OrderBatchCancelParams implements Params
Cancel multiple
Ordersby their IDs in a single request. Note that this requires theOrderIDs, not theOrderRequestIDs. 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. TheOrdersmay still be executed if the cancellation request is not received in time.The response will indicate which orders were successfully queued to cancel and which failed to queue. Check the status using the "Get Order by ID" endpoint to confirm whether individual
Ordershave been cancelled.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classOrderBatchCancelParams.BuilderA builder for OrderBatchCancelParams.
public final classOrderBatchCancelParams.BodyInput parameters for requesting
Ordercancellations from a list ofOrderIDs.
-
Method Summary
Modifier and Type Method Description final Optional<String>accountId()final List<String>orderIds()List of OrderIDs to cancelfinal JsonField<List<String>>_orderIds()Returns the raw JSON value of orderIds. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final OrderBatchCancelParams.BuildertoBuilder()final OrderBatchCancelParams.Body_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 OrderBatchCancelParams.Builderbuilder()Returns a mutable builder for constructing an instance of OrderBatchCancelParams. -
-
Method Detail
-
_orderIds
final JsonField<List<String>> _orderIds()
Returns the raw JSON value of orderIds.
Unlike orderIds, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final OrderBatchCancelParams.Builder toBuilder()
-
_body
final OrderBatchCancelParams.Body _body()
-
_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 OrderBatchCancelParams.Builder builder()
Returns a mutable builder for constructing an instance of OrderBatchCancelParams.
The following fields are required:
.orderIds()
-
-
-
-