POST/api/appointments/{appointmentId}/receive-payment

Recebimento de pagamento

Recebimento de pagamento

Access Token

Para realizar requisições GET, POST, PUT, DELETE e PATCH nos endpoints da API você precisa de uma chave de autorização. Chamamos essa chave de accessToken.

Para ter acesso ao accessToken, é necessário que o usuário master da licença efetue a liberação deste pela interface do ImageMais Clinic. O accessToken tem validade de 1 hora.

Headers

AuthorizationOBRIGATÓRIO
Tipo:string
Token de autenticação no formato Bearer {accessToken}
Content-TypeOBRIGATÓRIO
Tipo:application/json
Tipo de conteúdo (application/json)

Parâmetros

appointmentIdOBRIGATÓRIO
Tipo:number
ID do agendamento

Este parâmetro representa o identificador único do agendamento. O ID do agendamento deve ser um número inteiro que identifica um agendamento específico no sistema.

Observação: Para encontrar o ID do agendamento, para acessar a página de listar agendamentos.

actionOBRIGATÓRIO
Tipo:string
Ação a ser executada. Valores possíveis: agendado, confirmado, cancelado, check-in, em atendimento, faltou, finalizados
doctorIdOPCIONAL
Tipo:number
ID do médico

Este parâmetro representa o identificador único do médico. O ID do médico deve ser um número inteiro que identifica um médico específico no sistema.

Observação: Para encontrar o ID do médico, para acessar a página de listar médicos.

paymentMethodOBRIGATÓRIO
Tipo:string
Método de pagamento (ex: CARTAO_CREDITO, CARTAO_DEBITO, DINHEIRO, PIX_PAGAMENTO_INSTANTANEO)
valueOBRIGATÓRIO
Tipo:number
Valor do pagamento
flagOPCIONAL
Tipo:string
Bandeira do cartão
installmentsOPCIONAL
Tipo:number
Número de parcelas
protocolOPCIONAL
Tipo:string
Protocolo da transação

Request URL

https://api-dev.imagemais.com/api/appointments/88/receive-payment
curl -X 'POST' \
  'https://api-dev.imagemais.com/api/appointments/88/receive-payment' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjMyLCJhY2NvdW50SWQiOjEsImlhdCI6MTc2NjQ4NTMyNSwiZXhwIjoxNzY2NDg4OTI1LCJhdWQiOiJodHRwczovL2FwaS1kZXYuaW1hZ2VtYWlzLmNvbSIsImlzcyI6Imh0dHBzOi8vYXBwLWRldi5pbWFnZW1haXMuY29tIn0.wdrLP0x6q4FiZvchRWofEy8q-8HwyJn-SH-1VskoFCQ' \
  -H 'Content-Type: application/json' \
  -d '{
  "action": "Confirmado",
  "paymentMethod": "CARTAO_CREDITO",
  "value": 100
}'
{
  "action": "Finalizado",
  "doctorId": 1,
  ...
{
  "action": "Finalizado",
  "doctorId": 1,
  "paymentMethod": "CARTAO_CREDITO",
  "value": 100,
  "flag": "Visa",
  "installments": 1,
  "protocol": "1234567890"
}

Respostas

{
  "message": [
    "erro ao receber pagamento"
  ...
{
  "message": [
    "erro ao receber pagamento"
  ],
  "error": "Bad Request"
}
{
  "message": [
    "action should not be empty",
  ...
{
  "message": [
    "action should not be empty",
    "action must be one of the following values: Agendado, Confirmado, Check-in, Em atendimento, Cancelado, Finalizado, Faltou"
  ],
  "error": "Bad Request",
  "statusCode": 400
}
{
  "message": [
    "paymentMethod should not be empty",
  ...
{
  "message": [
    "paymentMethod should not be empty",
    "Método de pagamento inválido"
  ],
  "error": "Bad Request",
  "statusCode": 400
}
{
  "message": [
    "Valor deve ser maior que 0",
  ...
{
  "message": [
    "Valor deve ser maior que 0",
    "Valor deve ser um número"
  ],
  "error": "Bad Request",
  "statusCode": 400
}
{
  "message": [
    "agendamento nao encontrado"
  ...
{
  "message": [
    "agendamento nao encontrado"
  ],
  "error": "Bad Request"
}
{
  "statusCode": 401,
  "message": "invalid token"
  ...
{
  "statusCode": 401,
  "message": "invalid token"
}
{
  "statusCode": 401,
  "message": "jwt expired"
  ...
{
  "statusCode": 401,
  "message": "jwt expired"
}
{
  "statusCode": 500,
  "message": "Internal server error"
  ...
{
  "statusCode": 500,
  "message": "Internal server error"
}