POST Receber Pagamento

Registra o pagamento de um agendamento, atualizando seu status e método de pagamento.

Autenticação necessária

Esta rota requer o header Authorization: Bearer {accessToken}

ID do agendamento

O id pode ser obtido na rota de Listar Agendamentos, no campo data[].id de cada agendamento.

---

Endpoint

POST https://api-dev.imagemais.com.br/api/appointments/{id}/receive-payment

---

Path Parameter

Campo	Tipo	Obrigatório	Descrição
id	number	✅	ID do agendamento

---

Corpo da Requisição

Campo	Tipo	Obrigatório	Valores aceitos
action	string	✅	"Agendado", "Confirmado", "Na fila", "Em atendimento", "Cancelado", "Finalizado", "Faltou"
paymentMethod	string	✅	"CARTAO_CREDITO", "CARTAO_DEBITO", "PIX_PAGAMENTO_INSTANTANEO", "DINHEIRO", "BOLETO_BANCARIO", "TRANSFERENCIA_BANCARIA", e outros
value	number	✅	>= 0 — deve ser igual ao total do procedimento para quitar
flag	string	❌	"Visa", "Mastercard", "Elo", "American Express", "Hipercard"
installments	number	❌	Inteiro positivo (número de parcelas)
protocol	string	❌	Qualquer texto
doctorId	number	❌	ID numérico do médico

---

Requisição

curl -X 'POST' \
  'https://api-dev.imagemais.com.br/api/appointments/5285/receive-payment' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'Content-Type: application/json' \
  -d '{
  "action": "Finalizado",
  "paymentMethod": "CARTAO_CREDITO",
  "value": 252,
  "flag": "Visa",
  "installments": 1,
  "protocol": "1234567890"
}'

---

Respostas

200 Sucesso

Retorna resposta vazia. O pagamento foi registrado com sucesso.

400 Bad Request

Retornado quando o valor informado é maior que o orçamento do procedimento.

{
  "message": "Valor do movimento não pode ser maior que o orçamento",
  "error": "Bad Request",
  "statusCode": 400
}

Retornado quando ocorre um erro ao processar o pagamento.

{
  "message": ["erro ao receber pagamento"],
  "error": "Bad Request"
}

Retornado quando o método de pagamento não é informado ou é inválido.

{
  "message": [
    "paymentMethod should not be empty",
    "Método de pagamento inválido"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

Retornado quando a ação não é informada.

{
  "message": [
    "action should not be empty"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

Retornado quando o valor informado é menor ou igual a zero.

{
  "message": [
    "Valor deve ser maior que 0"
  ],
  "error": "Bad Request",
  "statusCode": 400
}