Skip to main content

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.

Autenticação necessária

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

Efeitos colaterais

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.

Pré-requisitos do paciente

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​

CampoTipoObrigatórioDescrição
budgetIdnumber✅ID do orçamento (inteiro positivo)
cashManagementIdnumber✅ID do caixa aberto do usuário (inteiro positivo)
paymentMethodenum✅Método de pagamento (ver valores válidos abaixo)
valuenumber (>= 0)✅Valor pago. A soma dos pagamentos não pode ultrapassar o total do orçamento
cpfRequiredboolean❌Exige CPF do paciente antes de enviar
flagenum❌Bandeira do cartão: Visa, Mastercard, Elo, American Express, Hipercard
installmentsnumber❌Número de parcelas (só gravado junto com flag)
skipPaymentboolean❌true cria uma movimentação pendente pelo saldo restante (ignora value). Requer a permissão skip_payment
skipQueueboolean❌Aceito pela validação; repassado ao envio para a fila
requestingDoctorIdnumber❌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_BANCARIODEBITO_AUTOMATICOPROGRAMA_FIDELIDADE
CARTAO_CREDITOCARTAO_CREDITO_VIA_LINKSEM_PAGAMENTO
CARTAO_DEBITOPIX_PAGAMENTO_INSTANTANEOTRANSFERENCIA_BANCARIA
CARTEIRA_DIGITALPIX_COBRANCAVALE_ALIMENTACAO
CASHBACKCREDITO_LOJAVALE_COMBUSTIVEL
CHEQUECREDITO_VIRTUALVALE_PRESENTE
DEPOSITO_BANCARIODINHEIROVALE_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​

MensagemQuando
CPF do paciente não foi preenchidocpfRequired: 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 preenchidoCadastro do paciente incompleto
Orçamento já foi enviado para a filaO orçamento já tem pedido não cancelado
Valor do movimento não pode ser maior que o orçamentoA soma dos pagamentos ultrapassaria o total
Orçamento já está totalmente cobertoskipPayment: 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
}