Pular para o conteúdo principal

Manual Consignado Privado - Leilão Interno

1. Início de Leilão​

Após as configurações dos filtros de pedidos de empréstimo, o parceiro irá começar a receber webhooks notificando estas solicitações.

WEBHOOK_TYPE
laas.private_payroll_auction.new_issuer_proposal_request

Webhook Body: Nova solicitação de empréstimo
{
    "status": "ongoing",
    "event_datetime": "2025-03-20T14:47:43Z",
    "key": "88b0203d-31ad-48c6-a795-b6d45ab4898a",
    "webhook_type": "laas.private_payroll_auction.new_issuer_proposal_request",
    "data": {
        "issuer_proposal_request_key": "88b0203d-31ad-48c6-a795-b6d45ab4898a",
        "status": "ongoing",
        "expiration_datetime": "2025-03-21T11:47:12Z",
        "inclusion_limit_datetime": "2025-03-20T11:49:43Z",
        "issuer_proposal_request_data": {
            "issuer_registration_number": "TESTE123",
            "birth_date": "1973-03-14",
            "disbursed_issue_amount": 2100,
            "admission_date": "2020-03-10",
            "consigned_credit_balance": 10000,
            "eligible": true,
            "employer_document_type": "cnpj",
            "document_number": "00737823780",
            "employer_document_number": "29113956000181",
            "number_of_installments": 10,
            "political_exposition": "not_exposed",
            "name": "VALENTINA SANTOS",
            "alerts": [
                {
                    "alert_type": "leave",
                    "description": "Afastamento",
                    "reference_date": "2025-02-11",
                    "event_id": "123456",
                    "leave_reason_code": 3,
                    "leave_start_date": "2025-02-11",
                    "leave_end_date": "2025-03-11"
                },
                {
                    "alert_type": "termination",
                    "description": "Desligamento",
                    "reference_date": "2025-02-11", 
                    "event_id": "789012",
                    "termination_reason_code": 1,
                    "termination_date": "2025-02-11",
                    "notice_period_start_date": "2025-01-11",
                    "notice_period_end_date": "2025-02-11"
                }
            ],
            "type" : "standard",
            "warranty" : null
        }
    }
}

Cada pedido de empréstimo passa por duas etapas, o leilão interno e o leilão no app da CTPS. O leilão interno se inicia assim que o webhook é recebido e se encerra no timestamp indicado no campo inclusion_limit_datetime, durante este período as propostas de todos os parceiros são recebidas e ranqueadas com base na taxa, assim que o leilão interno se encerra a proposta com as melhores condições é enviada à CTPS do tomador onde as propostas de todas as IFs são apresentadas. Caso nenhuma proposta seja enviada até o fim do leilão interno, a primeira proposta enviada depois do inclusion_limit_datetime ganhará automaticamente e será enviada à CTPS.

2. Proposta de Crédito​

Request​

POST
- /private_payroll_auction/issuer_proposal_request/{issuer_proposal_request_key}/auction_proposals
Testar no Playground
Request Body: Incluindo AuctionProposal(s) no leilão
{
    "standard_proposal":{
        "request_control_key" : "111e7ed3-4080-4cae-a853-8e12812817ea",
        "disbursed_issue_amount": 15000,
        "monthly_interest_rate": 0.045,
        "number_of_installments": 48,
        "purchaser_document_number": "01272247000120",
        "days_to_expiration": 10,
        "rebates": [
            {
                "fee_type": "spread",
                "amount_type": "percentage",
                "amount": 4.17
            }
        ]
    }
}

Response​

STATUS
- 200 (Accepted)
Response Body: AuctionProposal(s) incluída(s) com sucesso no leilão
{
    "standard_proposal":{
        "auction_proposal_key": "814e7ed3-4080-4cae-a853-8e12812817ea",
        "issuer_proposal_request_key" : "100e7ed3-4080-4cae-a853-8e12812817ea",
        "request_control_key" : "111e7ed3-4080-4cae-a853-8e12812817ea",
        "status": "bid",
        "proposal_score" : 0.4,
        "inclusion_date" : "2025-03-18T14:52:07.123456",
        "rank_position" : null,
        "proposal_data": {
                "simulation": {
                    "total_iof": 523.3,
                    "annual_cet": 0.735,
                    "monthly_cet": 0.047,
                    "issue_amount": 15523.3,
                    "annual_interest_rate": 0.6958814328,
                    "monthly_interest_rate": 0.045,
                    "disbursed_issue_amount": 15000,
                    "installment_face_value": 851.33,
                    "number_of_installments" : 48
                },
                "monthly_interest_rate": 0.045,
                "disbursed_issue_amount": 15000,
                "installment_face_value": null,
                "number_of_installments": 48
        },
    }
}
STATUS
- 400 (Rejected)
Response Body: Bad Request
{
  "title": "Bad Request",
  "description": "Calculated installment face value is greater than consigned credit balance",
  "translation": "Schema Invalido",
  "extra_fields": {},
  "code": "QIT000001"
}

3. Encerramento do Leilão​

Quando o leilão interno se encerra, um webhook é enviado atualizando o parceiro se o mesmo venceu ou perdeu o leilão, no caso de vitória, a operação de crédito é criada e o link de formalização do QI Sign é enviado ao app da CTPS do tomador, a partir deste momento o acompanhamento da operação deve ser realizado através da chave credit_operation_key.

Leilão com garantia!

Ao entrar no leilão de um pedido de empréstimo com garantia, são geradas duas propostas e o leilão interno é segregado em dois, um para as propostas com garantia e um para as propostas sem garantia, então dois webhooks são enviados informando a vitória ou derrota em cada um dos leilões.

WEBHOOK_TYPE
laas.private_payroll_auction.end_of_auction

Webhook Body: Resultado do leilão interno
{
    "key": "250cfea5-99dc-4c80-be3e-2231350cf9a2", // esta chave é igual à auction_proposal_key
    "data": {
        "auction_proposal_key": "250cfea5-99dc-4c80-be3e-2231350cf9a2",
        "status": "won",
        "type": "auction",
        "rank_position": 1,
        "signature_url": "https://sandbox.sign.qitech.com.br/r/3D1s523",
        "credit_operation_key": "9e06ca79-3610-4794-8312-9663e0343f6b",
        "issuer_proposal_request_key": "262d0584-9827-4652-9b27-6a46c9832f38",
        "proposal_number": "QITECH_6853045512774",
        "contract_number": "0340932936/VHD",
        "type":"standard"
    },
    "status": "won",
    "event_datetime": "2025-03-20T14:48:43Z",
    "webhook_type": "laas.private_payroll_auction.end_of_auction"
}

A chave da operação de crédito será enviada com valor null para as propostas perdedoras.

Atenção

O link de assinatura não será enviado no ambiente de produção, apenas em sandbox para que seja possível simular a assinatura do tomador.

Anexos​

Definição do Objeto IssuerProposalRequest​

NomeTipoDescrição
issuer_proposal_request_keystringIdentificador único da Solicitação de Proposta
issuer_proposal_request_dataobjectObjeto que descreve os dados da Solicitação de Proposta
statusstringStatus da Solicitação de Proposta (ongoing, finished, expired)

Definição do Objeto IssuerProposalRequestData​

NomeTipoDescrição
namestringNome completo do Tomador
document_numberstringCPF do Tomador
birth_datestringData de nascimento do Tomador no formato YYYY-MM-DD
disbursed_amountfloatValor de desembolso solicitado pelo tomador
number_of_installmentsintegerNúmero de parcelas solicitados pelo tomador
consigned_credit_balancefloatMargem consignável disponível de saldo do tomador
admission_datestringData de admissão do trabalhador no cargo atual no formato YYYY-MM-DD
issuer_registration_codestringMatricula eSocial do empregado
employer_document_numberstringCNPJ do empregador
eligiblebooleanTrue se elegivel, False se não elegivel
employer_document_typestringCNPJ ou CPF
alertsobjetoLista com histórico de afastamentos e avisos de desligamento do vínculo, para detalhamento dos campos consulte a tabela Detalhamento do objeto alerts
typestringTipo de solicitação, para detalhamento dos campos consulte a tabela Tipos de solicitação de empréstimo
severance_pay_ratefloatPercentual de verbas rescisórias disponíveis para garantia
severance_finefloatValor de multa rescisória disponível para garantia
fgts_balancefloatValor de saldo do fgts disponível para garantia

Detalhamento do objeto alerts​

CampoDescrição
alert_typeTipo de alerta, consulte os possíveis enumeradores na tabela Tipos de alerta
reference_dateData de referência do evento
event_idIdentificador do evento
leave_reason_codeMotivo do afastamento em conformidade com o site do eSocial
leave_start_dateData de início do afastamento
leave_end_dateData de término do afastamento
termination_reason_codeMotivo do desligamento em conformidade com o site do eSocial
termination_dateData de desligamento do vínculo
notice_period_start_dateData de início do período de aviso prévio
notice_period_end_dateData de término do período de aviso prévio

Tipos de alerta​

ENUMERADOR
alert_type
EnumeradorDescrição
leaveAfastamento
terminationAviso prévio de desligamento

Tipos de solicitação de empréstimo​

ENUMERADOR
type
EnumeradorDescrição
warrantedSolicitação com garantia
standardSolicitação sem garantia

Detalhamento dos Status da solicitação de proposta​

StatusDescrição
ongoingSolicitação de Proposta em andamento, o leilão continua ativo.
finishedSolicitação de Proposta finalizada, o leilão foi encerrado e uma Proposta enviada foi aceita e incluída.
expiredSolicitação de Proposta expirada, o leilão foi encerrado sem a inclusão de nenhuma Proposta em tempo hábil.

Detalhamento da Requisição de Proposta de Leilão​

CampoTipoDescriçãoObrigatório
issuer_proposal_request_keystringChave única de identificação da IssuerProposalRequest incluída no formato uuid v4.Sim
auction_proposal_keystringChave única de identificação da AuctionProposal incluída no formato uuid v4.Sim
disbursed_issue_amountfloatValor de desembolso pretendido pela Proposta.Sim
purchaser_document_numberintegerCNPJ do comprador da dívidaSim
monthly_interest_ratefloatTaxa de juros mensal da Proposta no intervalo de 0 a 1 (0% a 100%, respectivamente).Não
installment_face_valuefloatValor da parcela pretendida pela Proposta.Não
number_of_installmentsintegerNúmero de parcelas da proposta.Sim
days_to_expirationintegerNúmero de dias até que a proposta expire. Caso a chave não seja incluida, a validade da proposta será de 7 diasNão
rebateslistLista de rebates da operação de crédito. Utiliza o mesmo padrão da emissão ativa (/debt)Não

Detalhamento do webhook de finalização de leilão​

CampoTipoDescrição
auction_proposal_keystringChave única de identificação da AuctionProposal incluída no formato uuid v4.
statusstringIndicador de vitória ou derrota no leilão interno.
typestringEnumerador de tipo de proposta de leilão (demais tipos foram deprecados o valor sempre será "auction").
rank_positionintegerPosição da proposta no leilão interno.
signature_urlstringLink de formalização da dívida, enviado somente em ambiente de sandbox para fins de homologação.
credit_operation_keystringIdentificador único da operação de crédito, caso a proposta não tenha vencido o leilão, é retornado vazio.
issuer_proposal_request_keystringIdentificador único do pedido de empréstimo.
proposal_numberstringNúmero da proposta QI Tech no app da CTPS.
contract_numberstringNúmero de contrato da CCB

Detalhamento do webhook de finalização de leilão​

CampoTipoDescrição
auction_proposal_keystringChave única de identificação da AuctionProposal incluída no formato uuid v4.
statusstringIndicador de vitória ou derrota no leilão interno.
typestringEnumerador de tipo de proposta de leilão (demais tipos foram deprecados o valor sempre será "auction").
rank_positionintegerPosição da proposta no leilão interno.
signature_urlstringLink de formalização da dívida, enviado somente em ambiente de sandbox para fins de homologação.
credit_operation_keystringIdentificador único da operação de crédito, caso a proposta não tenha vencido o leilão, é retornado vazio.
issuer_proposal_request_keystringIdentificador único do pedido de empréstimo.
proposal_numberstringNúmero da proposta QI Tech no app da CTPS.
contract_numberstringNúmero de contrato da CCB