Bem vindo a API OFICIAL do Ceape Brasil!
A API Ceape Brasil foi desenvolvida de acordo com os melhores padrões REST.
As operações são feitas por requisições aos endpoints, de acordo com os verbos HTTP, com corpos de mensagem em JSON. As respostas podem ser interpretadas através do código de status HTTP. Isso permite que quaisquer aplicações consumam a API de forma simples e clara, independente da linguagem utilizada.
Confira a baixo a documentação
Introdução
Esta é a API de solicitações ou pedidos de clientes do Ceape Brasil. Neste guia você encontrará a documentação dos principais serviços oferecidos pela API Ceape Brasil, bem como: simulação de crédito, solicitação de crédito, obtenção de boletos entre outros serviços
Para realizar as requisições neste Enpoint você deverá ter previamente o seu tokenApi, criptKey e costumer_id do cliente.
Em caso de dúvida para obter ambos os parâmetros acima, sugerimos que você dê uma olhada na documentação de Autenticação, para obter o tokenApí, ou Clientes, para obter o cryptKey e costumer_id do seu cliente.
| Nome do Parâmetro |
Tipo |
Obrigatório |
| tokenApi |
String |
SIM |
| cryptKey |
String |
SIM |
| costumer_id |
Int |
SIM |
Este Endpoint será responsável pela criação de uma simulação de crédito, de acordo com as normas do Ceape Brasil (juros, taxas, descontos). Está requisição retornará um objeto JSON contendo informações sobre o resultado da simulação enviado ao Ceape Brasil
Para isso, os campos são abaixo devem ser obrigatoriamente enviados no corpo da requisição.
Detalhamento dos campos a serem enviados no body da requisição:
| Nome |
Tipo |
Obrigatório |
| Produto | Int | SIM |
| Categoria | Int | SIM |
| Carencia | Int | SIM |
| ValorCredito | Numeric | SIM |
| Parcelas | Int | SIM |
| CheckSeguroAp1 | Int | NÃO |
| CheckSeguroAp2 | Int | NÃO |
| CheckSeguroAp3 | Int | NÃO |
| CheckSeguroAp4 | Int | NÃO |
| CheckSeguroAp5 | Int | NÃO |
| CheckSeguroLar1 | Int | NÃO |
| CheckSeguroLar2 | Int | NÃO |
| CheckSeguroLar3 | Int | NÃO |
| CheckSeguroTele1 | Int | NÃO |
| CheckSeguroTele2 | Int | NÃO |
Segue abaixo um exemplo do JSON a ser enviado na requisição
{
"Produto":51,
"Categoria":1,
"Carencia":30,
"ValorCredito":5000,
"Parcelas":3,
"CheckSeguroAp1":1
}
Após simular um crédito, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"ValorCredito":5000.00
"ValorOperacaoTotal":5718.15,
"ValorDescontado":0.00,
"Parcelas":3,
"Carencia":30,
"Intervalo":30,
"Vencimento":"2022-06-10T00:00:00-03:00",
"TaxaJuros":4.6,
"ValorParcela": 1906.05,
"ValorParcelaDesc":1889.38,
"ValorJuros": 474.15,
"ValorTac": 150.0,
"ValorIof":19.0,
"Produto":51,
"CheckSeguroAp1":1,
"CheckSeguroAp2":0,
"CheckSeguroAp3":0,
"CheckSeguroAp4":0,
"CheckSeguroAp5":0,
"CheckSeguroLar1":0,
"CheckSeguroLar2":0,
"CheckSeguroLar3":0,
"CheckSeguroTele1":0,
"CheckSeguroTele2":0
}
Código HTTP da Requisição: 200
Caso não seja possivel realizar a simulação de crédito, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"Message":"Não foi possível realizar a simulação, verifique se todos o campos obrigatórios foram enviados!"
}
Código HTTP da Requisição: 400
Este Endpoint retornará uma confirmação de que a sua solicitação de crédito foi realizada com sucesso.
A sua solicitação de crédito está baseada em uma simulação de crédito. Por tanto, para solicitar um crédito será necessário realizar previamente uma simulação de crédito
Ao fazer a chamada deste método, você deve se certificar de inserir no corpo desta chamada o retorno da simulação feita no método anterior.
O campo Canal não é obrigatório, quando não informado assumirá o valor 4. Para ter acesso aos códigos de canais acesse o endpoint Obter Lista de Canais presente na aba Resources desta documentação.
Atenção Para o parâmetro SolicitacaoId, pois ele será necessário para Obter a lista de parcelas do crédito sendo informado como parâmtro installment_id na URL
Segue abaixo um exemplo do JSON a ser enviado na requisição
{
"ValorCredito":5000.00
"ValorOperacaoTotal":5718.15,
"ValorDescontado":0.00,
"Parcelas":3,
"Carencia":30,
"Intervalo":30,
"Vencimento":"2022-06-10T00:00:00-03:00",
"TaxaJuros":4.6,
"ValorParcela": 1906.05,
"ValorParcelaDesc":1889.38,
"ValorJuros": 474.15,
"ValorTac": 150.0,
"ValorIof":19.0,
"Produto":51,
"CheckSeguroAp1":1,
"CheckSeguroAp2":0,
"CheckSeguroAp3":0,
"CheckSeguroAp4":0,
"CheckSeguroAp5":0,
"CheckSeguroLar1":0,
"CheckSeguroLar2":0,
"CheckSeguroLar3":0,
"CheckSeguroTele1":0,
"CheckSeguroTele2":0,
"Canal":4
}
Após o aceite da prospota, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"CRM":999999,
"SolicitacaoId":14,
"Codigo":258878,
"Atendente":"NOME DO OPERADOR DO CEAPE BRASIL",
"Data":"2021-09-28T11:29:19.083",
"StatusAtual":"Em Atendimento",
"Canal":"Call Center",
"TipoServico":"RENOVAÇÃO AUTOMÁTICA",
"ProcessoAtual":"Supervisão Cadastral",
"Setor":"RENOVAÇÃO AUTOMÁTICA",
"MotivoPendencia":"",
"Resumo":""
}
Caso não seja possivel realizar a solicitação de crédito, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"Message":"Não conseguimos fazer o registro do seu pedido. Erro: [121]"
}
Código HTTP da Requisição: 400
Este método retornará a lista de Solicitações de crédito de um determinado cliente.
Descrição dos campos no retorno da requisição
| Nome |
Descrição |
| Id | Código da Solicitação de crédito na base de dados do Ceape Brasil |
| Data | Data da solicitação |
| ValorOperacao | Valor que será emprestado ao cliente |
| Produto | Código do produto de microcrédito solicitado |
| LkpProduto | Descrição do produto da Solicitação de crédito |
| Status | Código do status da Solicitação de crédito |
| LkpStatus | Descrição da situação da Solicitação de crédito |
| ValorOperacaoTotal | Valor que será pago pelo cliente, com os devidos incrementos |
| ValorLiquido | Valor líquido |
| Parcelas | Quantidade de parcelas solcitiadas |
| ValorDesconto | Valor líquido da parcela, levando em consideração os devidos descontos |
| Carencia | Intervalo de dias para o primeiro pagamento |
| Taxa | Taxa do produto aplicada a Solicitação de crédito |
| ValorTac | Valor bruto referente a Taxa de Abertura de Crédito |
| ValorIOF | Valor bruto referente ao Imposto sobre Operações Financeiras |
| PendenciaStatus | Código caso haja alguma pendência na Solicitação de crédito |
| PendenciaDescricao | Descrição caso haja alguma pendência na Solicitação de crédito |
| UrlContrato | Contém a URL para a assinatura do contrato. Esse campo só será preenchido quando o pedido estiver no estágio: Aguardando Assinatura |
| LkpAsssessor | Nome do Assessor de Crédito do Ceape Brasil |
| ListaSeguros | Lista de Coberturas Adicionadas ao Crédito |
| UrlWhatsApp | Contém a URL para contato com o assessor de crédito. |
Caso sejam localizadas Solicitações de crédito, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
[
{
"Id":20,
"Data":"2022-02-18T00:00:00",
"ValorOperacao":8000,
"Produto":51,
"Status":1,
"LkpStatus":"Em Análise",
"LkpProduto":"GIRO GRUPO",
"ValorOperacaoTotal":10608.00,
"ValorLiquido":8000.00,
"Parcelas":10,
"ValorParcela":1060.8,
"ValorDesconto":0.00,
"Carencia":30,
"Taxa":0.00,
"ValorTac":0.00,
"ValorIof":0.00,
"PendenciaStatus":0,
"PendenciaDescricao":"",
"UrlContrato":"https://api.ceapebrasil.org.br/orders/{costumer_id}/websign/{contrato}/view?cryptKey={cryptKey}&tokenApi={tokenApí}",
"LkpAssessor":"NOME DO ASSESSOR DE CRÉDITO",
"ListaSeguros": [
{
"Seguro":46,
"LkpSeguro":"SEGURO DE VIDA EM GRUPO - P4",
"Qtde":1,
"Valor":139.99,
}
}],
{
"Id":20,
"Data":"2022-02-18T00:00:00",
"ValorOperacao":8000,
"Produto":51,
"Status":1,
"LkpStatus":"Em Análise",
"LkpProduto":"GIRO GRUPO",
"ValorOperacaoTotal":10608.00,
"ValorLiquido":8000.00,
"Parcelas":10,
"ValorParcela":1060.8,
"ValorDesconto":0.00,
"Carencia":30,
"Taxa":0.00,
"ValorTac":0.00,
"ValorIof":0.00,
"PendenciaStatus":0,
"PendenciaDescricao":"",
"UrlContrato":"https://api.ceapebrasil.org.br/orders/{costumer_id}/websign/{contrato}/view?cryptKey={cryptKey}&tokenApi={tokenApí}",
"LkpAssessor":"NOME DO ASSESSOR DE CRÉDITO",
"ListaSeguros": [
{
"Seguro":46,
"LkpSeguro":"SEGURO DE VIDA EM GRUPO - P4",
"Qtde":1,
"Valor":139.99,
}
}],
]
Código HTTP da Requisição: 200
Caso não seja possivel localizar as Solicitações de crédito, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Não foi possível localizar a lista de Solicitações de crédito da para o cliente informado!"
}
Código HTTP da Requisição: 400
GET Assinatura Eletrônica
O contrato solicitado nesta URL corresponde ao Id do pedido retornado no ENDPOINT de Meus Pedidos.
A Assinatura Eletrônica de documentos do Ceape Brasil é intermediada pela plataforma de assinatura de documentos D4Sign. A exibição dos documentos é feita via componente Embeded (num browser ou webview, por exemplo).
Utilize este endpoint para obter os dados do signatário que vai assinar o contrato. A API retornará um JSON semelhante ao que é mostrado a seguir:
[
{
"Uid":"2e3efde9-c28c-4ee4-9a6b-07f0e296d3bd",
"SignerUid":"NDAxODI3MjQ=",
"SignerDocument":"461.378.340-26",
"SignerName":"RACHEL GREEN",
"SignerEmail":"[email protected]",
"SignerBirthday":"1753-01-01T00:00:00",
"SignerStatus":"0",
},
]
O SignerStatus que é exibido na estrutura acima refere-se ao estado atual da assinatura:
| Nome |
Descrição |
| 0 | Não Assinado |
| 1 | Assinado |
Para renderizar o contrato em uma página HTML, você pode acessar o EndPoint: api.ceapebrasil.org.br/orders/{costumer_id}/websign/{contrato}/view?tokenApi={tokenApi}&cryptKey={crptKey}
Atenção no parâmetro contrato da URL, nele você deverá informar o campo Id obtido no EndPoint Meus Pedidos
Caso o contrato não esteja assinado a API do Ceape Brasil retornará uma página semelhante a figura abaixo
Caso o contrato já esteja assinado a API do Ceape Brasil retornará uma página semelhante a figura abaixo
GET Baixar Certificado de Assinatura Eletrônica
Este endpoint retornará um documento PDF contendo as seguintes informações: contratos assinados pelos clientes, signatários envolvidos na assinatura e status de cada um dos signatários.
A API do Ceape Brasil retornará o código HTTP 200 para confirmar que o download do documento ocorreu com sucesso.
Porém, caso não seja possivel localizar o contrato do cliente, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo:
Código do Status HTTP: 400
{
"Message":"Identificador da operação inválida. O id de uma operação de crédito no Ceape é composto de 18 dígitos"
}
Código do Status HTTP: 400
{
"Message":"Operação de crédito não localizada!"
}
Caso o contrato esteja correto mas a assinatura ainda não esteja esteja disponível, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo:
Código do Status HTTP: 400
{
"Message":"A assinatura de documentos só é permitida na etapa de preparação e liberação de créditos."
}
Código do Status HTTP: 400
{
"Message":"O envelope não foi encontrado."
}
GET Obter lista de parcelas
Este método retornará a lista de parcelas vinculadas a uma operação de crédito. Para é importante que a sua solicitação de crédito já esteja no Estágio de Aprovação
Atenção para parâmetro order_id da URL, você deverá informar o campo (SolicitacaoId), que lhe foi retornado após o envio e a confirmação da sua Solicitação de crédito.
Caso sejam localizados as parcelas ligados a Solicitação de crédito, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
[
{
"Uid":000138020078000000000001,
"Parcela":2,
"DtVencimento":"2016-02-30 00:00:00.000",
"DtEmissao":"2016-01-30 00:00:00.000",
"DtQuitacao":"0001-01-01 00:00:00.000",
"Status":Em Dia,
"Valor":810.00,
"Saldo":810.00,
"Desconto":30.00,
"Multa":0.00,
"Juros":0.00,
},
{
"Uid":000138020078000000000001,
"Parcela":3,
"DtVencimento":"2016-03-30 00:00:00.000",
"DtEmissao":"2016-02-30 00:00:00.000",
"DtQuitacao":"0001-01-01 00:00:00.000",
"Status":Em Dia,
"Valor":810.00,
"Saldo":810.00,
"Desconto":30.00,
"Multa":0.00,
"Juros":0.00,
},
{
"Uid":000138020078000000000001,
"Parcela":4,
"DtVencimento":"2016-04-30 00:00:00.000",
"DtEmissao":"2016-03-30 00:00:00.000",
"DtQuitacao":"0001-01-01 00:00:00.000",
"Status":Em Dia,
"Valor":810.00,
"Saldo":810.00,
"Desconto":30.00,
"Multa":0.00,
"Juros":0.00,
},
]
Código HTTP da Requisição: 200
Caso não seja possivel localizar as parcelas referentes aquele crédito, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"Message":"Não foi possível localizar a lista de parcelas da para o crédito informado!"
}
Código HTTP da Requisição: 400
{
"Message":"Desculpe mas não há parcelas para a sua Solicitação de crédito, pois ela ainda não etapa de Aprovação!"
}
Código HTTP da Requisição: 400
GET Obter Segunda via de boleto
Este método retornará um JSON contendo informações da segunda via de um boleto referente a uma parcela do crédito. Por tanto será necessário informar os parâmetros: costumer_id e uidParcela na URL da requisição.
O valor informado no campo uidParcela deverá ser o valor do campo Uid retornado no objeto JSON da requisição Obter lista de parcelas.
Caso não saiba como obter o parâmetro costumer_id, recomendamos que você dê uma lida na documentação do Endpoint Clientes no tópico Obter cadastro
Após a requisição, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"UidParcela":"00000000000000000000000222222222",
"Boleto":"0225454880884456456486545645645465465465465",
"LinhaDigitavel":"00190000090280029838800055268171189560000024640",
"DataEmissao":"2022-01-20 00:00:00.000",
"DataVencimento":"2022-02-20 00:00:00.000",
"Valor":"500.00",
}
Código HTTP da Requisição: 200
Caso não seja possivel localizar a parcela, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"Message":"Identificador da parcela inválida. O id de uma parcela de crédito no Ceape é composto de 24 dígitos."
}
Código HTTP da Requisição: 400
GET Obter Boleto atualizado
Este método retornará um JSON com os valores atualizados de uma determinada parcela. Por tanto será necessário informar os parâmetros: costumer_id e uidParcela na URL da requisição.
O valor informado no campo uidParcela deverá ser o valor do campo Uid retornado no objeto JSON da requisição Obter lista de parcelas.
Caso não saiba como obter o parâmetro costumer_id, recomendamos que você dê uma lida na documentação do Endpoint Clientes no tópico Obter cadastro
Após a requisição, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"UidParcela":"00000000000000000000000222222222",
"Boleto":"0225454880884456456486545645645465465465465",
"LinhaDigitavel":"00190000090280029838800055268171189560000024640",
"DataEmissao":"2022-01-20 00:00:00.000",
"DataVencimento":"2022-02-20 00:00:00.000",
"Valor":"500.00",
}
Código HTTP da Requisição: 200
Caso não seja possivel localizar os produtos para o cliente, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"Message":"Identificador da parcela inválida. O id de uma parcela de crédito no Ceape é composto de 24 dígitos."
}
Código HTTP da Requisição: 400
Este Endpoint retorna o arquivo relacionado ao boleto de uma determinada parcela. Para isso é necessário que você já possua os campos: costumer_id, uidParcela e Boleto.
O valor informado no campo uidParcela deverá ser o valor do campo Uid retornado no objeto JSON da requisição Obter lista de parcelas.
O valor informado no campo Boleto deverá ser o valor do campo Boleto retornado no objeto JSON da requisição Obter Boleto atualizado ou Obter Segunda via de boleto.
Caso não saiba como obter o parâmetro costumer_id, recomendamos que você dê uma lida na documentação do Endpoint Clientes no tópico Obter cadastro
Caso seja localizado o documento informado, a API Ceape Brasil retornará o documento no cabeçalho da Requisição (Header), semelhante aos exemplos abaixo
Content-Disposition: attachment; filename="Boleto Ceape 0110101010101010101010101010.pdf"
Código HTTP da Requisição: 200
Caso não seja possivel localizar o documento informado, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Identificador da parcela inválida. O id de uma parcela de crédito no Ceape é composto de 24 dígitos."
}
Código HTTP da Requisição: 400
