Criar solicitação de proposta no sandbox

Cria, no sandbox, uma solicitação de proposta do leilão interno com os dados do trabalhador que você definir: CPF, valor pedido, prazo, margem, empregador e garantia. Use para testar a integração com o leilão em cenários específicos, sem depender das solicitações aleatórias que o sandbox gera sozinho.

caution

Disponível só no sandbox. Em produção o gateway recusa a requisição com GDF000025. Não use dados pessoais reais (CPF, CNPJ, nome) nos exemplos.

Endpoint

ENDPOINT

/mock/private_payroll_auction/issuer_proposal_request

MÉTODO

POST

STATUS

201

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição	Tamanho
document_number	string	Sim	CPF do trabalhador, só dígitos.	11
name	string	Sim	Nome do trabalhador.	1 a 100
birth_date	string	Sim	Data de nascimento, no formato AAAA-MM-DD.	10
admission_date	string	Sim	Data de admissão no empregador, no formato AAAA-MM-DD.	10
issuer_registration_number	string	Sim	Matrícula do trabalhador no empregador.	1 a 30
employer_document_type	string	Sim	Tipo de documento do empregador: cnpj ou cpf (empregador doméstico).	—
employer_document_number	string	Sim	Documento do empregador, só dígitos. Para cnpj, a raiz de 8 dígitos; para cpf, os 11 dígitos.	8 ou 11
disbursed_issue_amount	number	Sim	Valor liberado pedido pelo trabalhador, em reais. Maior que zero.	—
number_of_installments	integer	Sim	Número de parcelas pedido pelo trabalhador, de 1 a 96.	—
consigned_credit_balance	number	Sim	Margem consignável disponível, em reais. Zero ou maior.	—
political_exposition	string	Não	Exposição política: not_exposed, level_1 ou level_2. Padrão: not_exposed.	—
eligible	boolean	Não	Se o trabalhador está elegível ao empréstimo. Padrão: true.	—
warranty	object	Não	Garantia de FGTS. Quando enviada, a solicitação nasce do tipo warranted; sem ela, do tipo standard.	—
warranty.severance_pay_rate	number	Sim	Percentual das verbas rescisórias dado em garantia, como fração de 0 a 1. 0.1 = 10%. Obrigatório quando warranty é enviado.	—
warranty.severance_fine	number	Sim	Valor da multa rescisória do FGTS dado em garantia, em reais. Obrigatório quando warranty é enviado.	—
warranty.fgts_balance	number	Sim	Saldo disponível do FGTS dado em garantia, em reais. Obrigatório quando warranty é enviado.	—

Campos fora desta tabela são recusados com QIT000001. Alertas de afastamento e de desligamento não são aceitos por este endpoint: a solicitação é criada sem alertas.

{
    "document_number": "12345678909",
    "name": "Maria da Silva",
    "birth_date": "1985-03-12",
    "admission_date": "2020-01-15",
    "issuer_registration_number": "000123456",
    "employer_document_type": "cnpj",
    "employer_document_number": "12345678",
    "disbursed_issue_amount": 15000.5,
    "number_of_installments": 48,
    "consigned_credit_balance": 750.25,
    "political_exposition": "not_exposed",
    "warranty": {
        "severance_pay_rate": 0.1,
        "severance_fine": 1200.0,
        "fgts_balance": 8000.0
    }
}

Resposta

Campo	Tipo	Descrição
external_request_id	string	Identificador da solicitação, no papel do identificador que a Dataprev atribuiria. Diferente a cada requisição.

{
    "external_request_id": "4821937465012"
}

A resposta confirma que a solicitação foi enviada ao leilão; a criação dela acontece em seguida, de forma assíncrona. O external_request_id não vem no webhook de início de leilão: para reconhecer a solicitação que você criou, use o document_number.

Erros

Código	HTTP	Quando
QIT000001	400	O corpo não segue o contrato: campo obrigatório ausente, campo desconhecido, tipo errado ou documento do empregador com tamanho diferente do tipo informado.
GDF000014	401	O endpoint não está liberado para a sua integração, ou a assinatura da requisição não confere.
GDF000025	403	Requisição feita fora do sandbox.

Webhooks relacionados

A solicitação criada segue o mesmo caminho de uma solicitação vinda da Dataprev e dispara o webhook laas.private_payroll_auction.new_issuer_proposal_request, descrito em Leilão interno. Os campos de issuer_proposal_request_data trazem os valores enviados no corpo da requisição.

O webhook só chega à sua integração se a solicitação passar nos seus filtros de recebimento: idade, tempo de empresa, valor, prazo, margem, tipo de empregador, exposição política e, quando configurada, a lista de CNPJs. Monte o corpo dentro das regras configuradas em Configuração dos filtros, ou o webhook não é enviado.

info

Como no fluxo real, a janela para enviar proposta a uma solicitação é curta. Deixe a sua integração pronta para responder ao webhook antes de chamar este endpoint.

Próximo passo

Envie a proposta de crédito para a solicitação recebida, como descrito em Leilão interno.