P
API Parcred BrasilDocumentação

Envio de Propostas

Envie propostas de empréstimo para análise e notificação do cliente final.

Visão Geral

Após autenticar, você pode enviar propostas de empréstimo contendo os dados do cliente e da simulação financeira. A API Parcred Brasil processará a proposta e enviará uma mensagem via WhatsApp para o cliente confirmar ou recusar.

Endpoint

POST/v1/propostas
Criar uma nova proposta de empréstimo

Request Body

Campos Principais
CampoTipoObrigatórioDescrição
id_proposta_parceiroStringSimID único da proposta no seu sistema
clienteObjectSimDados do cliente final
simulacaoObjectSimDados financeiros da simulação
webhook_urlStringSimURL para receber notificações de status
Objeto Cliente
CampoTipoFormatoDescrição
nomeString-Nome completo do cliente
cpfStringXXX.XXX.XXX-XXCPF do cliente
whatsappString55DDDNUMERONúmero do WhatsApp (com código do país)
Objeto Simulação

valores (Object)

CampoTipoDescrição
solicitadoNumberValor solicitado pelo cliente
iofNumberValor do IOF
principalNumberValor principal (solicitado + IOF)
parcelaNumberValor de cada parcela
liquidoNumberValor líquido a receber
brutoNumberValor bruto total

taxas (Object)

CampoTipoDescrição
cet_amNumberCET ao mês (%)
cet_aaNumberCET ao ano (%)

prazos (Object)

CampoTipoFormatoDescrição
total_parcelasNumber-Número total de parcelas
primeiro_vencimentoStringYYYY-MM-DDData do primeiro vencimento
ultimo_vencimentoStringYYYY-MM-DDData do último vencimento

Exemplo de Requisição

cURLbash
TOKEN="SEU_TOKEN_DE_ACESSO"

curl -X POST https://api-angar-homologacao.onrender.com/v1/propostas \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "id_proposta_parceiro": "PROP-XYZ-98765",
    "cliente": {
      "nome": "Maria Joaquina de Amaral Pereira",
      "cpf": "123.456.789-00",
      "whatsapp": "5511987654321"
    },
    "simulacao": {
      "valores": {
        "solicitado": 1492.63,
        "iof": 48.19,
        "principal": 1540.82,
        "parcela": 156.84,
        "liquido": 1492.63,
        "bruto": 3764.16
      },
      "taxas": {
        "cet_am": 8.40,
        "cet_aa": 163.11
      },
      "prazos": {
        "total_parcelas": 24,
        "primeiro_vencimento": "2026-01-15",
        "ultimo_vencimento": "2027-12-15"
      }
    },
    "webhook_url": "https://api.seu-sistema.com/webhook/parcred"
  }'

Resposta de Sucesso

200 OKjson
{
  "status": "proposta_recebida_e_notificacao_enviada",
  "id_proposta_angar": "ANG-d250f450-c920-44fc-ad2b-d4d17e94b5bc"
}

Guarde o id_proposta_angar retornado. Ele será usado na notificação do webhook quando o cliente responder.

O que Acontece Depois?

1
Mensagem Enviada

O cliente recebe uma mensagem via WhatsApp com os detalhes da proposta.

2
Cliente Responde

O cliente clica no link e aceita ou recusa a proposta.

3
Webhook Notificado

Você recebe uma notificação POST na sua webhook_url com o status.

Próximo Passo

Implementar Webhook

Agora você precisa implementar um endpoint para receber as notificações de status:

Ir para Webhooks