Introdução

Esta documentação foi criado afim de disponibilizar aos parceiros da H Cred um canal de comunição entre os sistemas de gestão de propostas, facilitando a digitação e inserção direta do web site ou sistema do parceiro.

Toda a troca de informações entre os sistemas é realizada através de requisões JSON, é necessário conhecimentos avançados em programação para a conclusão desta integração.

A integração pode ser realizada em qualquer linguagem de programação dísponivel no mercado, ficando a cargo do parceiro optar por qual linguagem deseja utilizar, desde que esta permita envio e recebimento de requisões JSON.

Versão	Data	Alteração	Produto
V2.0	01/09/2021	Foi implementado a busca de bancos, depósito por PIX e tambêm alguns dados adicionais para o cliente.	N.A.

Credencial	Tipo	Tamanho
tokenId	Alfanumérico	32 caracteres
senhaHash	Hash	16 caracteres

Simulação

Deverá ser enviada uma chamada do tipo POST a API com os dados em formato JSON, conforme o exemplo abaixo.

Ambiente	URL	Tipo
Produção	https://api.hcred.com.br/simular/	POST

Parâmetros

Parâmetro	Formato	Descrição	Obrigatório
tokenId	Alfanumérico	Sua credencial "tokenId" fornecida pela H Cred.	SIM
senhaHash	Hash	Sua credencial "senhaHash" fornecida pela H Cred.	SIM
valorSolicitado	00.000,00	Formato de moeda brasileiro, não deverá conter o R$, apenas números.	SIM

Exemplo JSON de envio

JSON
{ "tokenId": "00000000000000000000000000000000", "senhaHash": "0000000000000000", "valorSolicitado": "1.000,00" }

Resposta

A API receberá em sua resposta os parâmetros indicados abaixo.

Parâmetro	Formato	Descrição
estatus	sucesso / erro	Estatus da requisição.
resultado	Array JSON	Esse parêmetro é enviado em caso de sucesso na requisição.
mensagem	Mensagem de erro	Esse parêmetro é enviado em caso de erro na requisição.

Caso a API receba o parâmtro "sucesso" significa que a requisição foi concluida e a simulação do financimento foi realizada, e assim recebido no parâmetro "resultado" um "array" JSON com as opcções de prazo e os valores das parcelas.

resultado (Array JSON)

Parâmetro	Formato	Descrição
prazo	Número	Quantidade de parcelas.
parcela	00000.00	Valor da parcela (formato moeda americano).
limite	00000.00	Limite necessário para realização do financiamento (formato moeda americano).

Exemplo de resposta

AVISO: Valores apresentados nesse quadro NÃO correspondem a uma simulação real, apenas valores em caráter ilustrativo.

JSON

{
"estatus": "sucesso",
"resultado": "[
{
"prazo": "1",
"parcela":"1170.00",
"limite": "1170.00"
},
{
"prazo": "2",
"parcela":"665.45",
"limite": "1330.90"
},
{
"prazo": "3",
"parcela":"445.00",
"limite\": "1335.00"
},
{
"prazo": "4",
"parcela":"333.88",
"limite": "1335.50"
},
{
"prazo": "5",
"parcela":"268.00",
"limite": "1340.00"
},
{
"prazo": "6",
"parcela":"223.42",
"limite": "1340.50"
},
{
"prazo": "7",
"parcela":"192.14",
"limite": "1345.00"
},
{
"prazo": "8",
"parcela":"168.19",
"limite": "1345.50"
},
{
"prazo": "9",
"parcela":"149.89",
"limite": "1349.00"
},
{
"prazo": "10",
"parcela":"135.00",
"limite": "1350.00"
}
]"
}

Listar Bancos

Deverá ser enviada uma chamada do tipo POST a API com os dados em formato JSON, conforme o exemplo abaixo.

Ambiente	URL	Tipo
Produção	https://api.hcred.com.br/bancos/lista	POST

Parâmetros

Parâmetro	Formato	Descrição	Obrigatório
tokenId	Alfanumérico	Sua credencial "tokenId" fornecida pela H Cred.	SIM
senhaHash	Hash	Sua credencial "senhaHash" fornecida pela H Cred.	SIM

Exemplo JSON de envio

JSON
{ "tokenId": "00000000000000000000000000000000", "senhaHash": "0000000000000000" }

Resposta

A API receberá em sua resposta os parâmetros indicados abaixo.

Parâmetro	Formato	Descrição
estatus	sucesso / erro	Estatus da requisição.
resultado	Array JSON	Esse parêmetro é enviado em caso de sucesso na requisição.
mensagem	Mensagem de erro	Esse parêmetro é enviado em caso de erro na requisição.

Caso a API receba o parâmtro "sucesso" significa que a requisição foi concluida e a listagem dos bancos foi realizada, e assim recebido no parâmetro "resultado" um "array" JSON com as opcções de bancos.

resultado (Array JSON)

Parâmetro	Formato	Descrição
idBanco	Número	Id do banco.
nome	Alfanumérico	Nome do banco no BACEN.
codigo	Número	Código do banco no BACEN.
ispb	Número	Código ISPB do banco no BACEN.

Exemplo de resposta

AVISO: Valores apresentados nesse quadro NÃO correspondem a uma simulação real, apenas valores em caráter ilustrativo.

JSON
{ "estatus": "sucesso", "resultado": "[ { "idBanco": "1", "nome": "Itaú Unibanco", "codigo":"341", "ispb": "60701190" }, { "idBanco": "2", "nome": "Bradesco", "codigo":"237", "ispb": "60746948" }, { "idBanco": "3", "nome": "NuBank", "codigo":"260", "ispb": "18236120" }, { "idBanco": "4", "nome": "Santander", "codigo":"033", "ispb": "90400888" } ]" }

Envio Proposta

Deverá ser enviada uma chamada do tipo POST a API com os dados em formato JSON, conforme o exemplo abaixo.

Ambiente	URL	Tipo
Produção	https://api.hcred.com.br/enviar/	POST

Parâmetros

Parâmetro	Formato	Descrição	Obrigatório
tokenId	Alfanumérico	Sua credencial "tokenId" fornecida pela H Cred.	SIM
senhaHash	Hash	Sua credencial "senhaHash" fornecida pela H Cred.	SIM
prazo	Número	Quantidade de parcelas, somente número.	SIM
valorSolicitado	00.000,00	Formato de moeda brasileiro, não deverá conter o R$, apenas números.	SIM
numeroCartao	Número	Últimos 4 digitos do cartão.	SIM
nomeCartao	Alfanumérico	Nome como escrito no cartão de crédito.	SIM
mesValidade	00	Mês de validade do cartão de crédito. Apenas 2 caracteres números.	NÃO
anoValidade	0000	Ano de validade do cartão de crédito. Apenas 4 caracteres números.	NÃO
cvv	0000	Código CVV do cartão de crédito. Máximo 4 caracteres números.	NÃO
nome	Alfanumérico	Nome completo	SIM
cpf	000.000.000-00	Somente números de CPF válidos.	SIM
email	Alfanumérico	Somente e-mails válidos.	SIM
telefoneCelular	Alfanumérico	Telefone celular de preferência WhatsApp.	SIM
rg	Alfanumérico	Número do RG.	NÃO
orgaoEmissor	Alfanumérico	Orgão Emissor do RG.	NÃO
orgaoEmissorUf	Alfanumérico	UF do Orgão Emissor do RG.	NÃO
dataExpedicaoRG	Data 00/00/0000	Data da emissão do RG.	NÃO
dataNascimento	Data 00/00/0000	Data de nascimento do titular.	SIM
estadoCivil	Alfanumérico	Estado civil do titular.	NÃO
sexo	Alfanumérico	Sexo do titular.	NÃO
tipoResidencia	Alfanumérico	Tipo de residência: própria/alugada.	NÃO
tempoResidencia	Alfanumérico	Tempo em que o titular mora na residência.	NÃO
naturalidade	Alfanumérico	Naturalidade do titular.	NÃO
nomePai	Alfanumérico	Nome do pai do titular.	NÃO
nomeMae	Alfanumérico	Nome da mãe do titular.	NÃO
endereco	Alfanumérico	Logradouro ou nome da rua, av e etc.	SIM
numero	Número	Número do local de residência.	SIM
complemento	Alfanumérico	Complemento do local de residência.	NÃO
bairro	Alfanumérico	Bairro do local de residência.	SIM
cep	00000-000	CEP do local de residência.	SIM
cidade	Alfanumérico	Cidade do local de residência.	SIM
estado	Alfanumérico	UF do local de residência. Somente 2 caracteres.	SIM
tipoPix	Alfanumérico	Tipo de chave PIX para receber o crédito, podendo ser: CPF CNPJ TELEFONE EMAIL CHAVE_ALEATORIA Caso esse campo esteja em branco será necessário enviar os campos de dados bancários.	Não.
chavePix	Alfanumérico	Chave Pix para receber o crédito.	Não.
bancoConta	Número	Id do banco que receberá o crédito, esse código deverá ser requisitado pela função "Lista Bancos" da API (consulte aqui).	SIM, caso PIX não seja selecionado.
agenciaConta	Número	Agência do banco que receberá o crédito.	SIM, caso PIX não seja selecionado.
contaNumero	Número	Conta do banco que receberá o crédito, sem dígito.	SIM, caso PIX não seja selecionado.
contaDigito	Número	Digito da conta no banco que receberá o crédito.	SIM, caso PIX não seja selecionado.
tipoConta	Conta Corrente/Conta Poupança	Tipo de conta no banco que receberá o crédito. Somente duas opções: Conta Corrente ou Conta Poupança.	SIM, caso PIX não seja selecionado.
idGerente	Número	Campo para vinculação ao gerente dentro da Hcred, caso vazio será vinculado ao usuário padrão da loja.	NÃO
idColaborador	Número	Campo para vinculação ao colaborador dentro da Hcred, caso vazio será vinculado ao usuário padrão da loja.	NÃO

Exemplo JSON de envio

JSON

{
"tokenId": "00000000000000000000000000000000",
"senhaHash": "0000000000000000",
"prazo": "10",
"valorSolicitado":"1.000,00",
"numeroCartao":"0000000000000000",
"nomeCartao":"XXXXXXXXX X X XXXXXXX",
"mesValidade":"00",
"anoValidade":"0000",
"cvv":"000",
"nome":"XXXXXXXXX X X XXXXXXX",
"cpf":"000.000.000-00",
"email":"xxxxxxxx@xxxxx.xxxx",
"telefoneCelular":"00 0 0000 0000",
"rg":"00000000-0",
"orgaoEmissor":"XXX",
"orgaoEmissorUf":"XX",
"dataExpedicaoRG":"00/00/0000",
"dataNascimento":"00/00/0000",
"estadoCivil":"XXXXXX",
"sexo":"XXXXXXXX",
"tipoResidencia":"XXXXXXX",
"tempoResidencia":"XX anos",
"naturalidade":"XXXXXXXXXX",
"nomePai":"XXXXXXXXXX",
"nomeMae":"XXXXXXXXXX",
"endereco":"xxxxxxxx xxxx xxxxxx",
"numero":"000",
"bairro":"xxxxxxxxx",
"cep":"00000-0000",
"cidade":"xxxxxxxxx",
"estado":"xx",
"tipoPix":"CPF",
"chavePix":"000.000.000-00",
"bancoConta":"000",
"agenciaConta":"0000",
"contaNumero":"0000",
"contaDigito":"0",
"tipoConta":"Conta Corrente"
"idGerente":"0000"
"idColaborador":"0000"
}

Resposta

A API receberá em sua resposta os parâmetros indicados abaixo.

Parâmetro	Formato	Descrição
estatus	sucesso / erro	Estatus da requisição.
resultado	Número	Esse parêmetro é enviado em caso de sucesso na requisição com o ID da proposta no sistema H Cred.
mensagem	Mensagem de erro	Esse parêmetro é enviado em caso de erro na requisição.

Consulta Proposta

Deverá ser enviada uma chamada do tipo POST a API com os dados em formato JSON, conforme o exemplo abaixo.

Ambiente	URL	Tipo
Produção	https://api.hcred.com.br/consulta/	POST

Parâmetros

Para realizar uma consulta de ESTATUS da proposta é necessário enviar as credencias juntamente com o id da proposta recebido na etapa final do envio.

Parâmetro	Formato	Descrição	Obrigatório
tokenId	Alfanumérico	Sua credencial "tokenId" fornecida pela H Cred.	SIM
senhaHash	Hash	Sua credencial "senhaHash" fornecida pela H Cred.	SIM
idProposta	Númerico	Id da proposta recebido na última etapa do envio.	SIM

Exemplo JSON de envio

JSON
{ "tokenId": "00000000000000000000000000000000", "senhaHash": "0000000000000000", "idProposta": "000000", }

Resposta

A API receberá em sua resposta os parâmetros indicados abaixo.

Parâmetro	Formato	Descrição
estatus	sucesso / erro	Estatus da requisição.
resultado	JSON	Esse parêmetro é enviado em caso de sucesso na requisição com o ESTATUS da proposta no sistema H Cred seguido da data em que a proposta foi inserida no sistema. Exemplo de resposta: { "estatus": "Aprovada", "dataProposta": "00/00/0000", }
mensagem	Mensagem de erro	Esse parêmetro é enviado em caso de erro na requisição.

Envio de Anexos

Deverá ser enviada uma chamada do tipo POST/HTML a API com os dados em formato multipart/form-data, conforme o exemplo abaixo.

Ambiente	URL	Tipo
Produção	https://api.hcred.com.br/anexos/	POST

Parâmetros

Para realizar o ENVIO de anexos para uma proposta é necessário enviar as credencias juntamente com o id da proposta recebido na etapa final do envio.

Parâmetro	Formato	Descrição	Obrigatório
tokenId	Alfanumérico	Sua credencial "tokenId" fornecida pela H Cred.	SIM
senhaHash	Hash	Sua credencial "senhaHash" fornecida pela H Cred.	SIM
idProposta	Númerico	Id da proposta recebido na última etapa do envio.	SIM
descricaoAnexo	Alfanumérico	Descrição do arquivo que esta sendo enviado. EXEMPLO: Foto frontal do cartão de crédito. ou Foto SELFIE segurando o cartão de crédito.	SIM

Exemplo POST/HTML de envio

Resposta

A API receberá em sua resposta os parâmetros indicados abaixo.

Parâmetro	Formato	Descrição
resultado	Alfanumérico	Uma mensagem será enviada com o estatus/erro do envio do arquivo, quando sucesso é enviada: Envio de anexo realizado com sucesso.

Envio de Anexos - Base 64

Deverá ser enviada uma chamada do tipo POST a API com os dados em formato JSON, conforme o exemplo abaixo.

Ambiente	URL	Tipo
Produção	https://api.hcred.com.br/anexos/base64/	POST

Parâmetros

Para realizar o ENVIO de anexos (via base 64) para uma proposta é necessário enviar as credencias juntamente com o id da proposta recebido na etapa final do envio.

Parâmetro	Formato	Descrição	Obrigatório
tokenId	Alfanumérico	Sua credencial "tokenId" fornecida pela H Cred.	SIM
senhaHash	Hash	Sua credencial "senhaHash" fornecida pela H Cred.	SIM
idProposta	Númerico	Id da proposta recebido na última etapa do envio.	SIM
descricaoAnexo	Alfanumérico	Descrição do arquivo que esta sendo enviado. EXEMPLO: Foto frontal do cartão de crédito. ou Foto SELFIE segurando o cartão de crédito.	SIM
image	base64	Código em formato base64 completo.. EXEMPLO: data:image/png;base64,iVBORw0KGgoAAAANS	SIM

Exemplo JSON de envio

JSON
{ "tokenId": "00000000000000000000000000000000", "senhaHash": "0000000000000000", "idProposta": "000000", "descricaoAnexo": "Foto frontal do cartão de crédito.", "image": "data:image/png;base64,iVBORw0KGgoAAAANS", }

Resposta

A API receberá em sua resposta os parâmetros indicados abaixo.

Parâmetro	Formato	Descrição
estatus	sucesso / erro	Estatus da requisição.
mensagem	JSON	Esse parêmetro é enviado em caso de sucesso na requisição. Exemplo de resposta: { "estatus": "sucesso", "mensagem": "Envio de anexo realizado com sucesso.", }

Introdução

Credenciais

Simulação

Parâmetros

Exemplo JSON de envio

Resposta

resultado (Array JSON)

Exemplo de resposta

Listar Bancos

Parâmetros

Exemplo JSON de envio

Resposta

resultado (Array JSON)

Exemplo de resposta

Envio Proposta

Parâmetros

Exemplo JSON de envio

Resposta

Consulta Proposta

Parâmetros

Exemplo JSON de envio

Resposta

Envio de Anexos

Parâmetros

Exemplo POST/HTML de envio

Resposta

Envio de Anexos - Base 64

Parâmetros

Exemplo JSON de envio

Resposta