Skip to main content

PATCH Dar Baixa em Movimentação

Dar baixa em uma movimentação pendente.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão settle_movements.


Endpoint​

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

Parâmetros de Rota​

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

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
paymentMethodstring✅BOLETO_BANCARIO, CARTAO_CREDITO, CARTAO_DEBITO, CARTEIRA_DIGITAL, CASHBACK, CHEQUE, CREDITO_LOJA, CREDITO_VIRTUAL, DEPOSITO_BANCARIO, DINHEIRO, OUTRO, DEBITO_AUTOMATICO, CARTAO_CREDITO_VIA_LINK, PIX_PAGAMENTO_INSTANTANEO, PIX_COBRANCA, PROGRAMA_FIDELIDADE, SEM_PAGAMENTO, TRANSFERENCIA_BANCARIA, VALE_ALIMENTACAO, VALE_COMBUSTIVEL, VALE_PRESENTE, VALE_REFEICAO; não vazioMétodo de pagamento usado para quitar a pendência
flagstring❌Visa, Mastercard, Elo, American Express, HipercardBandeira da movimentação
installmentsnumber❌mín. 1; máx. 12Quantidade de parcelas

Requisição​

curl -X 'PATCH' \
'https://api-dev.imagemais.com.br/api/movements/1/settle' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"paymentMethod": "BOLETO_BANCARIO",
"flag": "Visa",
"installments": 1
}'

Respostas​

200 Sucesso​

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}

404 Não encontrado​

Mensagens possíveis:

  • Movimentação pendente não encontrada
  • Nenhum caixa aberto encontrado
{
"message": "Movimentação pendente não encontrada",
"error": "Not Found",
"statusCode": 404
}

500 Erro interno​

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