Pular para o conteúdo principal

Criação de Proposta

info

Descrição​

  • Refere-se ao processo de formalização de uma solicitação de saque ou operação financeira do FGTS. Após uma simulação, a proposta pode ser gerada e enviada para análise.
  • Permite a criação de uma proposta de saque baseada nos dados fornecidos pelo usuário e na simulação realizada previamente.

Endpoint​

POST /nossa/v1/proposal

Headers​

{
  "Authorization": "Bearer {TOKEN_DO_LOGIN}",
  "Content-Type": "application/json"
}

Payload (Body)​

{
  "service_type": "string",
  "simulation_key": "0a8cf4cc-b4d3-471c-a609-e6a8aa9f0054",
  "client": {
    "person_name": "José da Silva",
    "mother_name": "Maria da Silva",
    "birth_date": "1999-05-22",
    "profession": "",
    "nationality": "Brasileiro",
    "marital_status": "single",
    "email": "jose@gmail.com",
    "country_code": "55",
    "area_code": "73",
    "phone_number": "999920123",
    "street": "Street API",
    "state": "BA",
    "city": "Itabuna",
    "neighborhood": "Neighborhood API",
    "number": "0",
    "postal_code": "45603103",
    "complement": "",
    "bank_account": [
      {
        "ispb_number": "32402502",
        "account_type": "checking_account",
        "branch_number": "0001",
        "account_number": "123456",
        "account_digit": "8",
        "pix_transfer_type": "manual"
      }
    ]
  }
}

Observações:​

É necessário definir dentro de "service_type": "qi" ou "bmp".

Exemplo :​

	{
	...
	   "service_type": "bmp"
	...
	}

​

{
  "id": 27,
  "debt_key": "ec312551-5043-4efa-8251-f15667b30d65",
  "link_form": null,
  "ccb_pdf":
  "https://storage.googleapis.com/sandbox-doc-api/documents/9533
  d0df-0d9b-4ad7-96e8-c674d6b0b814/ALCIRFREITASNETOLTDA-teste_te
  ste-CCB-0000119190-20250131155738.pdf",
  "ispb_number": "32402502",
  "branch_number": "001",
  "account_type": "checking_account",
  "account_number": "6947216",
  "account_digit": "4",
  "pix_transfer_type": "manual",
  "pix_key": null,
  "num_proposta": null,
  "num_contrato": "0000119190/SDL",
  "dsc_tipo_proposta_emprestimo": "Novo",
  "cod_produto": "100",
  "cod_tabela": "100001",
  "dsc_produto": "BOTA PRA VENDER",
  "dsc_situacao_emprestimo": "waiting_signature",
  "dat_emprestimo": "2025-01-31T12:57:42",
  "nic_ctr_usuario": "vendedor@gmail.com",
  “DADOS DO CLIENTE”: “DADOS COMPLETOS DO CLIENTE”,
  "qtd_parcela": "10",
  "val_liquido": 10978.2,
  "dat_credito": null,
  "promot_id": 1,
  "email_master": null,
  "link_cmp_pgmt": null,
  "has_insurance": false,
  "val_seguro": null,
  "val_emissao": 11330.3,
  "marital_status": "single",
  "created_at": "2025-01-31T12:57:42",
  "modified_at": "2025-01-31T12:57:42"
}
info

Comentários​

  • A simulation_key deve corresponder a uma simulação válida previamente criada. (A simulation_key pode ser encontrada na resposta da simulação dentro da variavel: "key".)
  • O objeto client deve conter todas as informações necessárias para a criação da proposta.
  • A debt_key do retorno da resposta, é essencial para acompanhar o status dessa proposta.
  • O link_form do retorno da resposta, é o link para o formulário de assinatura da proposta, caso exista.
  • O service_type tem como objetivo aprimorar o direcionamento das operações conforme a instituição responsável.

Alternativa com PIX​

"bank_account": [
  {
    "pix_transfer_type": "key",
    "pix_key": "+5511999999999"
  }

]
  • Escolha entre transferência manual ou via PIX conforme a necessidade do cliente.

Enumeradores “marital_status” :

[
  'single', 'married', 'divorced', 'widowed', 'separated'
]