cancelLimitOrder
PATCH/orders/limit/orders/:orderId/cancel
Disponibilidade: esta rota ainda nao esta ativa. O contrato abaixo esta publicado para voce preparar a integracao; a Liqi avisa quando a rota entrar em Sandbox e, depois, em Producao. Chamadas feitas antes disso respondem 404.
Pede o cancelamento de uma ordem a limite aberta.
A resposta e o aceite do pedido, nao a conclusao. A ordem passa para CANCELLING, o que ja garante que ela nao vai mais executar; o status final CANCELLED e gravado em seguida, de forma assincrona. Para acompanhar, consulte a ordem no GET /orders/fetchOrder, que le do registro e responde o estado atual, ou no GET /orders/limit/orders (lembrando que essa listagem e eventualmente consistente). O cancelamento nao gera evento no canal watchOrders: nesta entrega o canal nao publica as transicoes proprias da ordem a limite (abertura, disparo, re-arme, cancelamento e expiracao), so o desfecho do ciclo de execucao. O acompanhamento e por consulta REST.
cancelRequestedAt e o momento em que o cancelamento foi pedido. O momento da conclusao aparece depois, quando a ordem estiver em CANCELLED.
Somente ordem aberta (OPEN) e cancelada de imediato. Qualquer outra situacao responde 409 — mas o 409 tem dois significados, e eles pedem reacoes opostas. Ordem em execucao (TRIGGERED, PROCESSING): o pedido fica registrado e e honrado automaticamente se a ordem voltar para OPEN, entao nao reenvie — acompanhe a ordem. Ordem ja finalizada: o pedido nao e registrado, e nao ha mais o que cancelar. Ordem que ja teve o cancelamento pedido (CANCELLING) tambem responde 409.
profileId e obrigatorio: e ele que localiza a ordem dentro da conta. reason e opcional e fica registrado junto ao pedido; omitido, a Liqi grava um motivo padrao. Quem pediu o cancelamento e identificado pelo servidor a partir da chave de API — nao existe campo para isso na requisicao.
Request
Responses
- 200
- 400
- 404
- 409
- 500
Cancelamento aceito. A ordem esta em CANCELLING e nao executa mais; o CANCELLED e gravado em seguida.
Requisicao invalida: orderId ausente no caminho, corpo que nao e JSON valido, ou profileId ausente.
Ordem a limite nao encontrada para a conta e o profileId informados, ou conta nao identificada pela chave de API.
A ordem nao esta aberta: pode estar em execucao (TRIGGERED, PROCESSING), ja finalizada, ou com cancelamento ja pedido (CANCELLING). Em execucao, o pedido fica registrado e e honrado se a ordem voltar para OPEN; ja finalizada, nao fica registrado. A mensagem da resposta distingue os dois casos. Consulte a ordem para ver a situacao atual, em vez de reenviar o cancelamento.
Falha interna. O cancelamento pode nao ter sido registrado; consulte a ordem antes de reenviar.