POST Registrar Pagamento e Enviar para a Fila
Registra o pagamento (movimentação) de um orçamento no caixa aberto do usuário. Quando o orçamento fica totalmente coberto — pago, ou pendente via skipPayment — o pedido é enfileirado para envio ao laboratório (Diagnóstico Brasil) e o agendamento entra na fila de atendimento.
Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.
Esta rota grava uma movimentação financeira e, com o orçamento coberto, dispara o envio real do pedido ao laboratório. Não use para testes em produção.
O paciente do orçamento precisa ter nome, data de nascimento, telefone, gênero e CEP preenchidos (e CPF, se cpfRequired for true). O orçamento não pode ter pedido já enviado (não cancelado).
Endpoint
POST https://api-dev.imagemais.com.br/api/integrations/diagnostics-brazil/send
Body
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
budgetId | number | ✅ | ID do orçamento (inteiro positivo) |
cashManagementId | number | ✅ | ID do caixa aberto do usuário (inteiro positivo) |
paymentMethod | enum | ✅ | Método de pagamento (ver valores válidos abaixo) |
value | number (>= 0) | ✅ | Valor pago. A soma dos pagamentos não pode ultrapassar o total do orçamento |
cpfRequired | boolean | ❌ | Exige CPF do paciente antes de enviar |
flag | enum | ❌ | Bandeira do cartão: Visa, Mastercard, Elo, American Express, Hipercard |
installments | number | ❌ | Número de parcelas (só gravado junto com flag) |
skipPayment | boolean | ❌ | true cria uma movimentação pendente pelo saldo restante (ignora value). Requer a permissão skip_payment |
skipQueue | boolean | ❌ | Aceito pela validação; repassado ao envio para a fila |
requestingDoctorId | number | ❌ | ID do médico solicitante |
orderId, patientId, procedureIds | — | ❌ | Aceitos pela validação (herdados), não usados por esta rota |
Valores válidos para paymentMethod
BOLETO_BANCARIO | DEBITO_AUTOMATICO | PROGRAMA_FIDELIDADE |
CARTAO_CREDITO | CARTAO_CREDITO_VIA_LINK | SEM_PAGAMENTO |
CARTAO_DEBITO | PIX_PAGAMENTO_INSTANTANEO | TRANSFERENCIA_BANCARIA |
CARTEIRA_DIGITAL | PIX_COBRANCA | VALE_ALIMENTACAO |
CASHBACK | CREDITO_LOJA | VALE_COMBUSTIVEL |
CHEQUE | CREDITO_VIRTUAL | VALE_PRESENTE |
DEPOSITO_BANCARIO | DINHEIRO | VALE_REFEICAO |
OUTRO |
Requisição
curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/integrations/diagnostics-brazil/send' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"budgetId": 21167,
"cashManagementId": 12,
"paymentMethod": "DINHEIRO",
"value": 120
}'
Respostas
200 Sucesso
accepted indica se o orçamento ficou coberto com este pagamento — e, portanto, se o envio para a fila foi disparado. Com false, o pagamento foi registrado mas ainda há saldo em aberto.
{
"accepted": true
}
400 Bad Request
| Mensagem | Quando |
|---|---|
CPF do paciente não foi preenchido | cpfRequired: true e o paciente não tem CPF |
Algum dos campos do paciente: nome, data de nascimento, telefone, gênero e CEP não foi preenchido | Cadastro do paciente incompleto |
Orçamento já foi enviado para a fila | O orçamento já tem pedido não cancelado |
Valor do movimento não pode ser maior que o orçamento | A soma dos pagamentos ultrapassaria o total |
Orçamento já está totalmente coberto | skipPayment: true sem saldo restante |
Método de pagamento inválido (array de validação) | paymentMethod fora da lista |
403 Sem permissão para pular o pagamento
{
"message": "Permissões insuficientes para pular o pagamento",
"error": "Forbidden",
"statusCode": 403
}
404 Não Encontrado
Retornado quando o orçamento não existe ("Orçamento não encontrado"), quando o orçamento não tem paciente ("Paciente não encontrado ou não existe") ou quando o cashManagementId não é um caixa aberto ("Caixa aberto não encontrado").
{
"message": "Caixa aberto não encontrado",
"error": "Not Found",
"statusCode": 404
}