Criação da Proposta FGTS

Descrição da Rota da API /fgts/proposal - Proposta de FGTS

Esta rota é utilizada para criar propostas de saque aniversário FGTS. Abaixo estão listadas as propriedades que precisam ser enviadas no corpo da solicitação para criar uma proposta de FGTS:

POST /fgts/proposal

Segue descrição dos campos necessários para criação de uma proposta FGTS

ATENÇÃO: Todos os campos que começam com * são obrigatórios.

key	value	description
*simulationFeesId	(ID da Taxa de Simulação	O ID da tabela de simulação associada à proposta.
*name	Nome	O nome do beneficiário da proposta.
*individualDocumentNumber	Número do CPF	O número de documento individual do beneficiário.
*documentIdentificationNumber	Número RG ou CNH	O número de identificação do documento do beneficiário.
*motherName	Nome da Mãe	O nome da mãe do beneficiário.
*nationality	Nacionalidade	A nacionalidade do beneficiário.
*isPEP	Politicamente exposta	Um valor booleano indicando se o usuário é uma Pessoa Exposta Politicamente (PEP).
*email	E-mail	O endereço de e-mail do beneficiário.
*birthDate	Data de Nascimento	A data de nascimento do beneficiário.
*maritalStatus	Estado Civil	“single”, “married”, “widower”, “divorced”
*personType	Tipo de Pessoa	O tipo de pessoa, geralmente "natural" para pessoa física.
*phone	Número telefone	O número de telefone do beneficiário.
*phoneCountryCode	Código do País do Telefone	O código do país do telefone do beneficiário.
*phoneRegionCode	Código de Região do Telefone	O código de região do telefone do beneficiário.
*postalCode	CEP	O CEP do endereço do beneficiário.
*state	Estado	O estado do endereço do beneficiário.
*neighborhood	Bairro	O bairro do endereço do beneficiário.
*addressNumber	Número do Endereço	O número do endereço do beneficiário.
*city	Cidade	A cidade do endereço do beneficiário.
*street	Rua	A rua do endereço do beneficiário.
complement	Complemento	Qualquer complemento adicional para o endereço do beneficiário.
documentImage	Não disponivel	Em desenvolvimento.
*payment	Pagamento	Um objeto contendo detalhes sobre o método de pagamento, como tipo e dados específicos.
*fgtsSimulationId	ID da Simulação do FGTS	O ID da simulação do FGTS associada à proposta.
*fgtsProposalsPeriods	Períodos das Propostas do FGTS	Uma lista de objetos contendo informações sobre os períodos das propostas do FGTS, como o valor e a data de vencimento.

Estas propriedades devem ser incluídas no corpo da solicitação em formato JSON para criar uma proposta de FGTS. Certifique-se de seguir as especificações da API da V8 Digital para garantir o sucesso da solicitação.

Ao enviar o valor do campo nationality enviar como Brasileiro ou Outros.

Ao enviar os valores payment o mesmo deve seguir a seguinte estrutura para que não ocorra erros durante a criação da operação

payload exemplo{
  "fgtsSimulationId": "",
  "simulationFeesId": "",
  "name": "",
  "individualDocumentNumber": "",
  "documentIdentificationNumber": "",
  "motherName": "",
  "nationality": "Brasileiro(a)",
  "isPEP": false,
  "email": "teste@teste.com",
  "birthDate": "2000-01-01",
  "maritalStatus": "widower",
  "personType": "natural",
  "phone": "",
  "phoneCountryCode": "",
  "phoneRegionCode": "",
  "postalCode": "",
  "state": "",
  "neighborhood": "",
  "addressNumber": "",
  "city": "",
  "street": "",
  "complement": "",
  "formalizationLink": "",
  "payment": {
    "type": "transfer",
    "data": {
      "bankId": "f6d47fc1-31b1-4d19-b2c4-ae7c39733de5",
      "accountType": "checking_account",
      "agency": "1234",
      "account": "123456",
      "digit": "1"
    }
  },
  "fgtsProposalsPeriods": [
    {
      "amount": 0,
      "dueDate": "2024-01-01"
    }
  ]
  
}

Pagamento por chave PIX

"payment": {
    "type": "pix",
    "data": {
      "pix": "string"
    }
  },

Atenção: São aceitos como chave pix, CPF, email, telefone, chave aleatória.Ao informar pagamento por chave pix deve-se respeitar algumas regras

CPF não pode conter pontuação ;

Telefone informar +55 e o codigo de aréa do telefone;

Chave aleatória tem que ser no formato UUID;

Para chave aleatória é recomendado sempre solicitar para o cliente a gerar uma nova chave.

Pagamento PIX por dados bancários

"payment": {
    "type": "transfer",
    "data": {
      "bankId": "5fa17fcd-8afd-47bc-9711-f3a4c736bac5",
      "agency":"0001",
      "account":"174582",
      "digit":"2",
      "accountType": "checking_account"
    }
  },

“accountType“ aceita como resposta [ checking_account,saving_account],

checking_account: Conta Corrente ;

saving_account: Conta Poupança ;

Após a criação da proposta vocês irá receber a seguinte response

200 Successful response

{
  "formalizationLink": "string",
  "id": "string",
  "contractNumber": "string"
}

key	description
formalizationLink	Link de formalização da proposta
id	id da proposta no sistema
contractNumber	número do contrato do benefíciario

Link de formalização do ambiente de produção deve ser feito pelo titular do contrato.