Obter boletos

🌐 URLs dos Ambientes

🔹 Homologação

https://integracao.hml.cloud.medsenior.com.br/api/v1/beneficiario/integracao/buscar/{{cpf_beneficiario}}/segunda-via/boletos

🔹 Produção

https://integracao.medsenior.com.br/api/v1/beneficiario/integracao/buscar/{{cpf_beneficiario}}/segunda-via/boletos

📌 Endpoint

GET /api/v1/beneficiario/integracao/buscar/{{cpf_beneficiario}}/segunda-via/boletos

🔐 Autenticação

Este endpoint requer um token de autorização.

Authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO

🔽 Cabeçalhos

Nome	Valor
accept	application/json
content-type	application/json

🔽 Parâmetros de Entrada

Nome	Tipo	Obrigatório	Descrição
cpfBenficiario	string	Sim	Parametro a ser enviado junto à url

🔄 Exemplo de Requisição

🔹 Ambiente de homologação

curl -X 'GET' \
'https://integracao.hml.cloud.medsenior.com.br/api/v1/beneficiario/integracao/buscar/{{cpf_beneficiario}}/segunda-via/boletos' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json' 

🔹 Ambiente de produção

curl -X 'GET' \
'https://integracao.medsenior.com.br/api/v1/beneficiario/integracao/buscar/{{cpf_beneficiario}}/segunda-via/boletos' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json'

✅ Resposta de Sucesso

• Status Code: 200 OK
• Exemplo de Resposta:

{
  "data": [
    {
      "matricula": "MATRICULA_DO_BENEFICIARIO",
      "nome": "NOME_COMPLETO_DO_BENEFICIARIO",
      "cpf": "CPF_DO_BENEFICIARIO",
      "dataVencimento": "DATA_DE_VENCIMENTO_DO_BOLETO",
      "dataVencimentoProrrogado": "DATA_PRORROGADA_SE_HOUVER",
      "agencia": "NUMERO_DA_AGENCIA_BANCARIA",
      "agenciaDigitoVerificador": "DIGITO_VERIFICADOR_DA_AGENCIA",
      "codigoBeneficiario": "CODIGO_INTERNO_DO_BENEFICIARIO_NO_BANCO",
      "nossoNumero": "IDENTIFICADOR_UNICO_DO_TITULO_NO_BANCO",
      "valorDocumento": "VALOR_TOTAL_DO_DOCUMENTO",
      "numeroDocumento": "NUMERO_INTERNO_DO_DOCUMENTO",
      "nomePagador": "NOME_DE_QUEM_VAI_PAGAR_O_BOLETO",
      "nomeBeneficiario": "NOME_DE_QUEM_RECEBERA_O_PAGAMENTO",
      "linhaDigitavel": "LINHA_DIGITAVEL_PARA_PAGAMENTO",
      "codigoBarras": "CODIGO_DE_BARRAS_PARA_PAGAMENTO",
      "localPagamento": "LOCAIS_ONDE_O_BOLETO_PODE_SER_PAGO",
      "beneficiario": "RAZAO_SOCIAL_COMPLETA_DO_BENEFICIARIO",
      "dataDocumento": "DATA_DE_CRIACAO_DO_DOCUMENTO",
      "especieDocumento": "TIPO_DE_DOCUMENTO_BANCARIO",
      "aceite": "INDICA_SE_O_DOCUMENTO_FOI_ACEITO_PELO_SACADO",
      "dataEmissao": "DATA_DE_EMISSAO_DO_BOLETO",
      "carteira": "CODIGO_DA_CARTEIRA_DE_COBRANCA",
      "especie": "MOEDA_DO_DOCUMENTO",
      "valor": "VALOR_PAGO_EFETIVAMENTE_PELO_PAGADOR",
      "instrucoes1": "INSTRUCAO_DE_PAGAMENTO_1",
      "instrucoes2": "INSTRUCAO_DE_PAGAMENTO_2",
      "valorTaxaPermanencia": "VALOR_DIARIO_DA_TAXA_DE_PERMANENCIA_APOS_VENCIMENTO",
      "valorMulta": "VALOR_DA_MULTA_APOS_O_VENCIMENTO",
      "instrucoes3": "INSTRUCAO_DE_PAGAMENTO_3_COM_PLANO_E_ANS",
      "nomePlano": "NOME_DO_PLANO_DE_SAUDE",
      "codigoRegistroAns": "REGISTRO_DA_OPERADORA_NA_ANS",
      "textoDescricao": "DESCRICAO_RESUMIDA_DO_BOLETO",
      "logradouroEnderecoPagador": "RUA_DO_PAGADOR",
      "bairroEnderecoPagador": "BAIRRO_DO_PAGADOR",
      "cidadeEnderecoPagador": "CIDADE_DO_PAGADOR",
      "ufEnderecoPagador": "UF_DO_PAGADOR",
      "cepEnderecoPagador": "CEP_DO_PAGADOR",
      "razaoSocialOperadora": "RAZAO_SOCIAL_DA_OPERADORA",
      "cnpjOperadora": "CNPJ_DA_OPERADORA",
      "logradouroEnderecoOperadora": "RUA_DA_OPERADORA",
      "numeroEnderecoOperadora": "NUMERO_DA_OPERADORA",
      "bairroEnderecoOperadora": "BAIRRO_DA_OPERADORA",
      "cidadeEnderecoOperadora": "CIDADE_DA_OPERADORA",
      "ufEnderecoOperadora": "UF_DA_OPERADORA",
      "cepEnderecoOperadora": "CEP_DA_OPERADORA",
      "status": "STATUS_DO_BOLETO_COM_CODIGO",
      "necessarioReprocessamento": "BOOLEANO_SE_PRECISA_REPROCESSAR",
      "pago": "BOOLEANO_SE_ESTA_PAGO",
      "registrado": "BOOLEANO_SE_ESTA_REGISTRADO_NO_BANCO",
      "vencido": "BOOLEANO_SE_ESTA_VENCIDO",
      "numeroContrato": "NUMERO_DO_CONTRATO_ASSOCIADO",
      "categoria": "TIPO_DE_VINCULO_DO_BENEFICIARIO_EX: TITULAR_OU_DEPENDENTE",
      "tipoPlano": "TIPO_DE_PLANO_EX: SAUDE_ODONTOLOGICO",
      "estabelecimento": "NOME_DO_ESTABELECIMENTO_OU_PLANO",
      "statusBoleto": "STATUS_RESUMIDO_DO_BOLETO",
      "statusContrato": "STATUS_DO_CONTRATO_DO_BENEFICIARIO",
      "numeroDiasParaVencimento": "QUANTOS_DIAS_RESTAM_PARA_O_VENCIMENTO",
      "dataPagamento": "DATA_EM_QUE_O_BOLETO_FOI_PAGO",
      "diasVencido": "QUANTIDADE_DE_DIAS_EM_ATRASO",
      "renegociado": "BOOLEANO_SE_O_TITULO_FOI_RENEGOCIADO"
    }
  ],
  "success": true,
  "failure": false,
  "messages": []
}

❌ Códigos de Erro

Status Code	Significado	Descrição
400	Bad Request	Parâmetros inválidos ou ausentes.
401	Unauthorized	Falha na autenticação do token.
500	Server Error	Erro interno ao obter o beneficiário