Criar operação de crédito

Request

ENDPOINT

/baas/debt_fgts

MÉTODO

POST

Request Body

{
    "borrower": {
        "person_type": "natural",
        "name": "Patrícia Tereza Bernardes",
        "mother_name": "Maria Mariane",
        "birth_date": "1990-05-06",
        "profession": "Deputada",
        "nationality": "nationality",
        "marital_status": "married",
        "property_system": "total_communion_of_goods",
        "wedding_certificate": "56ab7849-4d90-490b-b539-96ac3c5a619b",
        "spouse": {
            "person_type": "natural",
            "name": "Patrícia Tereza Bernardes",
            "mother_name": "Maria Mariane",
            "birth_date": "1990-05-06",
            "profession": "Deputada",
            "nationality": "nationality",
            "marital_status": "married",
            "property_system": "total_communion_of_goods",
            "wedding_certificate": "56ab7849-4d90-490b-b539-96ac3c5a619b",
            "is_pep": false,
            "individual_document_number": "34651104630",
            "document_identification": "3c24579b-9810-4fa6-9b08-fe67d237160a",
            "document_identification_back": "2f43456a-3664-4805-82b8-96a2ec72c04c",
            "document_identification_type": "cnh",
            "document_identification_number": "232479719",
            "email": "api@qitech.com.br",
            "Phone": {
                "country_code": "055",
                "area_code": "11",
                "number": "999999999"
            },
            "address": {
                "street": "Av. Brigadeiro Faria Lima",
                "state": "SP",
                "city": "São Paulo",
                "neighborhood": "Jardim Paulistano",
                "number": "2391",
                "postal_code": "01452905",
                "complement": "1o. Andar"
            },
            "proof_of_residence": "780456bd-1eec-4e5f-82c0-d8c3921497ea"
        },
        "is_pep": false,
        "individual_document_number": "34651104630",
        "document_identification": "3c24579b-9810-4fa6-9b08-fe67d237160a",
        "document_identification_back": "2f43456a-3664-4805-82b8-96a2ec72c04c",
        "document_identification_type": "cnh",
        "document_identification_number": "232479719",
        "email": "api@qitech.com.br",
        "Phone": {
            "country_code": "055",
            "area_code": "11",
            "number": "999999999"
        },
        "address": {
            "street": "Av. Brigadeiro Faria Lima",
            "state": "SP",
            "city": "São Paulo",
            "neighborhood": "Jardim Paulistano",
            "number": "2391",
            "postal_code": "01452905",
            "complement": "1o. Andar"
        },
        "proof_of_residence": "780456bd-1eec-4e5f-82c0-d8c3921497ea"
    },
    "financial": {
        "interest_type": "pre_price_days",
        "credit_operation_type": "ccb",
        "annual_interest_rate": 0.05,
        "disbursement_date": "2022-07-25",
        "disbursement_start_date": "2022-07-27",
        "disbursement_end_date": "2022-07-27",
        "issue_date": "2019-07-25",
        "interest_grace_period": 0,
        "principal_grace_period": 0,
        "number_of_installments": 2,
        "fine_configuration": {
            "contract_fine_rate": 0,
            "interest_base": "workdays",
            "monthly_rate": 0
        }
    },
    "disbursement_bank_accounts": {
        "bank_code": "329",
        "branch_number": "001",
        "account_number": "15570",
        "account_digit": "4",
        "document_number": "94632180173",
        "name": "Pedro Felipe Henrique Alves",
        "percentage_receivable": 100,
        "ispb_number": 92874270,
        "pix_key": "qitech@qitech.com.br",
        "qr_code_key": "00020126580014br.gov.bcb.pix01366214e102-494c-4cf7-a99c-fd903d9f4aab5204000053039865802BR5911QI SCD S.A.6009sao paulo610912345-78062070503***6304C32E",
        "digitable_line": "00190500954014481606906809350314337370000000100"
    }
}

A simulação da operação retornará uma série de informações, no entanto, a de maior importância é o disbursed_issue_amount, que representa o valor líquido presente possível de se desembolsar. A partir dele é possível realizar os cálculos e, por fim, montar a operação no formato desejado e enviar a requisição.

ATRIBUTOS DE UMA EMISSÃO DO SAQUE-ANIVERSÁRIO FGTS

A criação da operação consiste em 4 objetos:

borrower: tomador da dívida (objeto PF)
collaterals: informações das parcelas de pagamento (objeto Collateral FGTS)
financial: dados do fluxo financeiro da operação (Objeto Financeiro FGTS)
disbursement_bank_accounts: lista de informações bancárias para o desembolso (Objeto Conta Bancária)

BODY PARAMS

Campo	Descrição
`borrower` (obrigatório)	Identificador de que o objeto enviado é uma pessoa física. Deve conter SEMPRE o valor "natural" para Objeto PF
`collaterals` (obrigatório)	Informações das parcelas de pagamento.
`financial` (obrigatório)	Contém todas as informações de um objeto Financial, mas com a adição dos desired installments, que representam os valores de cada parcela simulada pelo cliente.
`disbursement_bank_accounts` (obrigatório)	Uma emissão de dívida deve conter as informações bancárias para desembolso, por padrão, uma conta do tomador. Este objeto deve ser uma lista com uma ou mais contas. O Objeto Conta Bancária deve conter:

BORROWER OBJECT

Campo	Descrição
`person_type` (obrigatório)	Identificador de que o objeto enviado é uma pessoa física. Deve conter SEMPRE o valor "natural" para Objeto PF
`name` (obrigatório)	Nome da pessoa
`mother_name` (obrigatório)	mother_name
`birth_date` (obrigatório)	Data de nascimento da pessoa (formato "AAAA-MM-DD")
`profession` (obrigatório)	Profissão da pessoa
`nationality` (obrigatório)	Nacionalidade da pessoa
`marital_status` (obrigatório)	Estado civil da pessoa: "single", "married", "widower" ou "divorced"
`property_system`	Regime de separação de bens (obrigatório apenas para pessoas com marital_status "married"): "total_communion_of_goods", "partial_communion_of_goods", "total_separation_of_goods", "final_participation_of_acquisitions" ou "compulsory_separation_of_goods"
`wedding_certificate` (obrigatório)	DOCUMENT_KEY do PDF do certificado de casamento da pessoa (enviado previamente). No caso de marital_status ser "single", o valor deste campo deve ser null
`spouse` (obrigatório)	Objeto PF do esposo/esposa da pessoa (obrigatório apenas quando "compulsory_separation_of_goods" for "total_communion_of_goods", "partial_communion_of_goods", "final_participation_of_acquisitions" ou "compulsory_separation_of_goods"). No caso de marital_status ser "single", o valor deste campo deve ser null
`is_pep` (obrigatório)	Declaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep) valor booleano
`individual_document_number` (obrigatório)	CPF da pessoa (apenas números)
`document_identification` (obrigatório)	DOCUMENT_KEY do PDF do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente)
`document_identification_back`	DOCUMENT_KEY do PDF da parte de trás do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente)
`document_identification_type`	Qual o tipo do documento de identificação. Um enumerador que aceita "rg" ou "cnh"
`document_identification_number` (obrigatório)	Número do documento de identificação da pessoa enviado em document_identification
`email`	Email da pessoa
`phone`	Telefone da pessoa
`address`	Endereço da pessoa
`proof_of_residence` (obrigatório)	DOCUMENT_KEY do PDF do comprovante de endereço do endereço enviado (enviado previamente)
`ocr`	Objeto para entrega das chaves geradas pela SDK de OCR

SPOUSE OBJECT

Campo	Descrição
`person_type` (obrigatório)	Identificador de que o objeto enviado é uma pessoa física. Deve conter SEMPRE o valor "natural" para Objeto PF
`name` (obrigatório)	Nome da pessoa
`mother_name` (obrigatório)	mother_name
`birth_date` (obrigatório)	Data de nascimento da pessoa (formato "AAAA-MM-DD")
`profession` (obrigatório)	Profissão da pessoa
`nationality` (obrigatório)	Nacionalidade da pessoa
`marital_status` (obrigatório)	Estado civil da pessoa: "single", "married", "widower" ou "divorced"
`property_system`	Regime de separação de bens (obrigatório apenas para pessoas com marital_status "married"): "total_communion_of_goods", "partial_communion_of_goods", "total_separation_of_goods", "final_participation_of_acquisitions" ou "compulsory_separation_of_goods"
`wedding_certificate` (obrigatório)	DOCUMENT_KEY do PDF do certificado de casamento da pessoa (enviado previamente). No caso de marital_status ser "single", o valor deste campo deve ser null
`spouse` (obrigatório)	Objeto PF do esposo/esposa da pessoa (obrigatório apenas quando "compulsory_separation_of_goods" for "total_communion_of_goods", "partial_communion_of_goods", "final_participation_of_acquisitions" ou "compulsory_separation_of_goods"). No caso de marital_status ser "single", o valor deste campo deve ser null
`is_pep` (obrigatório)	Declaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep) valor booleano
`individual_document_number` (obrigatório)	CPF da pessoa (apenas números)
`document_identification` (obrigatório)	DOCUMENT_KEY do PDF do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente)
`document_identification_back`	DOCUMENT_KEY do PDF da parte de trás do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente)
`document_identification_type`	Qual o tipo do documento de identificação. Um enumerador que aceita "rg" ou "cnh"
`document_identification_number` (obrigatório)	Número do documento de identificação da pessoa enviado em document_identification
`email`	Email da pessoa
`phone`	Telefone da pessoa
`address`	Endereço da pessoa
`proof_of_residence` (obrigatório)	DOCUMENT_KEY do PDF do comprovante de endereço do endereço enviado (enviado previamente)
`ocr`	Objeto para entrega das chaves geradas pela SDK de OCR

PHONE OBJECT

Campo	Descrição
`country_code` (obrigatório)	Código DDI do telefone (https://ddi.guiamais.com.br/)(deve ter obrigatoriamente 3 dígitos).
`area_code` (obrigatório)	Código DDD do telefone (https://ddd.guiamais.com.br/).)
`number` (obrigatório)	Número de telefone (apenas números).
`document_number` (obrigatório)	Numero de documento do signatário.

ADDRESS OBJECT

Campo	Descrição
`street` (obrigatório)	Rua do endereço.
`state` (obrigatório)	Estado do endereço (com dois caracteres maiúsculos).
`city` (obrigatório)	Cidade do endereço.
`neighborhood` (obrigatório)	Bairro do endereço.
`number` (obrigatório)	Número da rua.
`postal_code` (obrigatório)	CEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/) (apenas números).
`complement` (obrigatório)	Complemento do endereço (texto livre).

OCR OBJECT

Campo	Descrição
`ocr`	Objeto para entrega das chaves geradas pela SDK de OCR

COLLATERALS OBJECT

Campo	Descrição
`percentage`	Porcentagem da garantia (vai de 0 a 1)
`collateral_type` (obrigatório)	Tipo de collateral. No caso do FGTS, precisa ser "fgts_balance"
`collateral_data`

COLLATERAL DATA OBJECT

Campo	Descrição
`total_amount` (obrigatório)	Valor amortizado em determinada data
`due_date`	Data Hora do Pedido (formato "AAAA-MM-DD")

FINANCIAL OBJECT

Campo	Descrição
`desired_installments`	Valor de desembolso para o cliente
`interest_type` (obrigatório)	Tipo de juros aplicado na dívida.
`credit_operation_type` (obrigatório)	Tipo de operação de crédito: "ccb", "cce", "cci", "nce"
`annual_interest_rate` (obrigatório)	Valor porcentual da parcela prefixada de juros (atenção: 1 = 100%)
`disbursement_date`	Data de desembolso (formato "AAAA-MM-DD") (excludente de disbursement_date)
`disbursement_start_date`	Data inicial do período de desembolso (formato "AAAA-MM-DD") (excludente de disbursement_date)
`disbursement_end_date`	Data final do período de desembolso (formato "AAAA-MM-DD") (excludente de disbursement_date)
`issue_date`	Data de emissão da CCB (formato "AAAA-MM-DD")
`interest_grace_period`	Carência de juros (em meses)
`principal_grace_period`	Carência do principal (em meses)
`number_of_installments`	Número de parcelas (anuais)
`fine_configuration`	configuração das multas
`rebates`	Lista de objetos de rebates.

REBATES OBJECT

Campo	Descrição
`amount`	Valor do rebate.
`fee_type`	Tipo de fee
`amount_type`	Tipo do valor inserido (valor absoluto, valor em porcentagem)
`rebate_bank_account`	Objeto conta bancária de rebate.

FINE CONFIGURATION OBJECT

Campo	Descrição
`contract_fine_rate` (obrigatório)	Valor porcentual fixo da multa
`interest_base`	Contagem do tempo para multa ("calendar_days" para dias corridos, "workdays" para dias úteis)
`monthly_rate`	Valor porcentual mensal da multa

DISBURSEMENT BANK ACCOUNT OBJECT

Campo	Descrição
`bank_code` (obrigatório)	Identificador da instituição no Sistema de Pagamentos Brasileiro - Obrigatório apenas se o COMPE não for enviado.
`branch_number` (obrigatório)	Número da agência
`account_number` (obrigatório)	Número da conta
`account_digit`	Dígito verificador da conta (obrigatório caso haja)
`document_number`	CPF ou CNPJ do dono da conta para desembolso (obrigatório caso haja mais de uma conta para desembolso)
`name`	Nome do dono da conta para desembolso (obrigatório caso haja mais de uma conta para desembolso)
`percentage_receivable`	Valor em porcentagem que a conta receberá no desembolso. Este campo é utilizado para definir a quantidade a ser dividida caso haja mais de uma conta para desembolso (no caso de ser somente uma conta, o valor integral será transferido). Caso a porcentagem não seja enviada (de uma, ou de todas as contas), a porcentagem restante será dividida igualmente entre as contas sem porcentagem definida. Caso todas as porcentagens sejam enviadas, a soma delas não pode passar de 100
`ispb_number`	Identificador de Sistema de Pagamentos Brasileiro
`pix_key`	Chave Pix
`qr_code_key`	Chave fornecida no momento da criação de um QR Code
`digitable_line`	Representação numérica do código de barras do boleto

Criar operação de crédito

Request​

BODY PARAMS​

BORROWER OBJECT​

SPOUSE OBJECT​

PHONE OBJECT​

ADDRESS OBJECT​

OCR OBJECT​

COLLATERALS OBJECT​

COLLATERAL DATA OBJECT​

FINANCIAL OBJECT​

REBATES OBJECT​

FINE CONFIGURATION OBJECT​

DISBURSEMENT BANK ACCOUNT OBJECT​