Sumário
Descrição #
Apresenta as informações e os parâmetros necessários para consultar os dados do contrato vinculados à proposta de crédito consignado do trabalhador CLT.
Essa chamada será realizada após o contrato assinado pelo cliente.
Endpoints #
Produção: https://api2.bancosemear.com.br/caas-credito-trabalhador-clt/v1/leiloes/dados-contrato
Homologação: https://hmlapi2.bancosemear.com.br/caas-credito-trabalhador-clt/v1/leiloes/dados-contrato
Requisição (POST) #
Segue exemplo de requisição:
curl --request POST "https://hmlapi2.bancosemear.com.br/<contexto>/v1/leiloes/dados-contrato" \
--header "Content-Type: application/json" \
--header "client_id: <CLIENT_ID>" \
--header "access_token: <ACCESS_TOKEN>" \
--header "X-Parceiro-Id: <IDENTIFICADOR_DO_PARCEIRO>" \
--data '[
"leilao": {
"idSolicitacaoProposta": null,
"numeroProposta": null
},
"cliente": {
"cpf": null,
"nome": null,
"dataNascimento": null,
"telefone": null,
"email": null
},
"contrato": {
"numeroContrato": null,
"dataContratacao": null,
"valorLiberado": null,
"valorParcela": null,
"quantidadeParcelas": null,
"taxaJurosMensal": null,
"taxaJurosAnual": null
},
"instituicaoFinanceira": {
"codigoIF": null,
"nome": null,
"cnpj": null
},
"comissaoCorban": {
"percentualComissao": null,
"valorComissao": null
},
"informacaoAdicional": {
"informacao1": null,
"informacao2": null
}
]
}
]'
Parâmetros de Requisição #
Cabeçalho # #
| Cabeçalho | Descrição | Obrigatório |
| Content-Type | Indica o tipo do corpo da requisição. Sempre application/json | Sim |
| client_id | ID de cliente usado para controle de acesso do gateway de APIs | Sim |
| access_token | Token recebido após executar o método oAuth | Sim |
| X-Parceiro-Id | Identificador do parceiro. Usado para segregar os dados e registrar a trilha de auditoria | Sim |
| X-Correlacao-Id | Identificador de correlação para rastreio ponta a ponta. Se omitido, a API gera um | Não |
Corpo (JSON) #
LEILÃO (leilao) #
| Propriedade | Descrição | Tipo |
|---|---|---|
| idSolicitacaoProposta | Identificador da solicitação da proposta, obtido na consulta. | int64 |
| numeroProposta | Identificador da proposta no parceiro. Chave de idempotência. | String |
CLIENTE (cliente) #
| Propriedade | Descrição | Tipo |
|---|---|---|
| cpf | CPF do cliente, contendo 11 dígitos. | String |
| nome | Nome completo do cliente. | String |
| dataNascimento | Data de nascimento do cliente. | String |
| telefone | Número de telefone de contato do cliente, incluindo DDD. | String |
| Endereço de e-mail do cliente. | String |
CONTRATO (contrato) #
| Propriedade | Descrição | Tipo |
|---|---|---|
| numeroContrato | Identificador único do contrato de empréstimo na instituição financeira. | String |
| dataContratacao | Data de formalização do contrato de empréstimo. | String |
| valorLiberado | Valor efetivamente liberado ao cliente. | decimal |
| valorParcela | Valor de cada parcela do contrato. | decimal |
| quantidadeParcelas | Quantidade total de parcelas do contrato. | int32 |
| taxaJurosMensal | Taxa de juros mensal aplicada ao contrato. | decimal |
| taxaJurosAnual | Taxa de juros anual aplicada ao contrato. | decimal |
INSTITUIÇÃO FINANCEIRA (instituicaoFinanceira) #
| Propriedade | Descrição | Tipo |
|---|---|---|
| codigoIF | Código identificador da instituição financeira responsável pelo contrato. | String |
| nome | Nome da instituição financeira responsável pela operação. | String |
| cnpj | CNPJ da instituição financeira, contendo 14 dígitos. | String |
COMISSÃO CORBAN (comissaoCorban) #
| Propriedade | Descrição | Tipo |
|---|---|---|
| percentualComissao | Percentual de comissão destinado ao correspondente bancário pela operação. | decimal |
| valorComissao | Valor monetário da comissão destinada ao correspondente bancário. | decimal |
INFORMAÇÃO ADICIONAL (informacaoAdicional) #
| Propriedade | Descrição | Tipo |
|---|---|---|
| informacao1 | Campo destinado ao envio de informações complementares da operação. | String |
| informacao2 | Campo destinado ao envio de informações adicionais da operação. | String |