Skip to main content

PATCH Cancelar Movimentação

Cancela uma movimentação existente, alterando seu status para CANCELLED e registrando o motivo do cancelamento.

Autenticação necessária

Esta rota requer o header Authorization: Bearer {accessToken}

ID da movimentação

O id pode ser obtido na rota de Listar Movimentações, no campo data[].id de cada movimentação.

Caixa aberto

O cashManagementId informado deve pertencer à conta. Caso contrário o cancelamento não encontra a movimentação e retorna erro.

Endpoint​

PATCH https://api-dev.imagemais.com.br/api/movements/{id}/cancel

Path Parameter​

CampoTipoObrigatórioDescrição
idnumber✅ID da movimentação

Corpo da Requisição​

CampoTipoObrigatórioDescrição
cashManagementIdnumber✅ID do caixa (inteiro positivo)
cancellationReasonstring❌Motivo do cancelamento (máx. 500 caracteres)

Requisição​

curl -X 'PATCH' \
  'https://api-dev.imagemais.com.br/api/movements/44/cancel' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'Content-Type: application/json' \
  -d '{
  "cashManagementId": 12,
  "cancellationReason": "Pagamento duplicado"
}'

Respostas​

200 Sucesso​

{
  "data": {
    "id": 44,
    "cashManagementId": 12,
    "paymentMethodId": 2,
    "value": "150",
    "createdAt": "2025-12-22T11:44:19.893Z",
    "updatedAt": "2026-01-15T09:20:03.118Z",
    "statusId": 2,
    "protocolContaAzul": null,
    "movementsOptionsId": null,
    "cancellationReason": "Pagamento duplicado",
    "editReason": null
  }
}
statusId, paymentMethodId e movementsOptionsId não são fixos

Esses IDs são gerados via connectOrCreate na primeira vez que cada valor (nome do status, método de pagamento, etc.) é usado naquela conta. Não existe um mapeamento fixo — por exemplo, CANCELLED pode ser statusId: 2 em uma conta e statusId: 3 em outra, dependendo da ordem de criação. Não trate esses números como constantes entre ambientes.

500 Erro ao cancelar​

{
  "message": "Erro ao cancelar movimentação",
  "error": "Internal Server Error",
  "statusCode": 500
}