emissao_de_divida

Emissão de dívida

Request

ENDPOINT
/debt
MÉTODO
POST
BODY
(antes de ser assinado):

YOUR REQUEST HISTORY

body.json

{
    "borrower": {
        "person_type": "natural",
        "name": "Qi Tech Ltda.",
        "mother_name": "Maria Mariane",
        "birth_date": "1990-05-06",
        "profession": "Deputada",
        "nationality": "nationality",
        "marital_status": "married",
        "wedding_certificate": "56ab7849-4d90-490b-b539-96ac3c5a619b",
        "spouse": {
            "person_type": "natural",
            "name": "Qi Tech Ltda.",
            "mother_name": "Maria Mariane",
            "birth_date": "1990-05-06",
            "profession": "Deputada",
            "nationality": "nationality",
            "marital_status": "married",
            "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"
            },
            "proof_of_residence": "780456bd-1eec-4e5f-82c0-d8c3921497ea",
            "address": {
                "street": "Av. Brigadeiro Faria Lima",
                "state": "SP",
                "city": "São Paulo",
                "neighborhood": "Jardim Paulistano",
                "number": "2391",
                "postal_code": "01452905",
                "complement": "1o. Andar"
            }
        },
        "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"
        },
        "proof_of_residence": "780456bd-1eec-4e5f-82c0-d8c3921497ea",
        "address": {
            "street": "Av. Brigadeiro Faria Lima",
            "state": "SP",
            "city": "São Paulo",
            "neighborhood": "Jardim Paulistano",
            "number": "2391",
            "postal_code": "01452905",
            "complement": "1o. Andar"
        }
    },
    "financial": {
        "interest_type": "pre_price_days",
        "disbursement_start_date": "2019-07-25",
        "disbursement_end_date": "2019-07-29",
        "fine_configuration": {
            "contract_fine_rate": 0.02,
            "interest_base": "workdays",
            "monthly_rate": 0.01
        },
        "annual_interest_rate": 0.02,
        "credit_operation_type": "ccb",
        "interest_grace_period": 0,
        "number_of_installments": 10,
        "principal_grace_period": 0
    }
}

BODY PARAMS

Campo	Descrição
`borrower` (obrigatório)	Dados do mutuário.
`guarantors`	Garantidores da operação (que pode ser uma lista de Objeto PF e/ou Objeto PJ e não é um campo obrigatório).
`collaterals` (obrigatório)	Informações das parcelas de pagamento.
`financial` (obrigatório)	O objeto financeiro descreve as informações financeiras da emissão. Aqui são definidas a taxa de juros, carência e valor da dívida entre outros.
`disbursement_bank_accounts`	Lista de informações bancárias para o desembolso (Objeto Conta Bancária).

BORROWER OBJECT

Campo	Descrição
`person_type` (obrigatório)	Identificador de que o objeto enviado é uma pessoa física ou jurídica.
`name` (obrigatório)	Nome da pessoa. Limitado a 100 caracteres.
`mother_name`	mother_name
`birth_date`	Data de nascimento da pessoa (formato "AAAA-MM-DD")
`profession`	Profissão da pessoa
`nationality`	Nacionalidade do cliente. Limitado a 50 caracteres.
`marital_status`	Estado civil do cliente.
`property_system`	Regime de separação de bens (obrigatório apenas para pessoas com marital_status "married").
`wedding_certificate`	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`	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`	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)

GUARANTORS OBJECT

Campo	Descrição
`person_type` (obrigatório)	Identificador de que o objeto enviado é uma pessoa física ou jurídica.
`name` (obrigatório)	Nome da pessoa. Limitado a 100 caracteres.
`mother_name` (obrigatório)	Nome da mãe do cliente em caso de PF. Limitado a 100 caracteres.
`birth_date` (obrigatório)	Data de nascimento da pessoa (formato "AAAA-MM-DD")
`profession` (obrigatório)	Profissão do cliente. Limitado a 64 caracteres.
`nationality` (obrigatório)	Nacionalidade do cliente. Limitado a 50 caracteres.
`marital_status` (obrigatório)	Estado civil do cliente.
`property_system`	Regime de separação de bens (obrigatório apenas para pessoas com marital_status "married").
`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).
`individual_document_number` (obrigatório)	CPF da pessoa (apenas números). Limitado a 11 caracteres.
`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 enviado.
`document_identification_number` (obrigatório)	Número do documento de identificação da pessoa enviado em "document_identification". Limitado a 16 caracteres.
`email`	Email da pessoa
`phone`	Telefone da pessoa
`proof_of_residence` (obrigatório)	DOCUMENT_KEY do PDF do comprovante de endereço do endereço enviado (enviado previamente)
`address`	Endereço da pessoa

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
`proof_of_residence` (obrigatório)	DOCUMENT_KEY do PDF do comprovante de endereço do endereço enviado (enviado previamente)
`address`	Endereço da pessoa

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
`collateral_data`	Lista de garantias da operação.
`percentage`
`collateral_type` (obrigatório)	Tipo de collateral. No caso do Auxílio Brasil, precisa ser "social_benefit"

COLLATERAL DATA OBJECT

Campo	Descrição
`reservation_period`	Período do beneficio bloqueado como garantia.
`reservation_amount`	Valor do beneficio bloqueado como garantia.
`family_code`	Código da Família do beneficio.
`state`	UF da família do beneficio.
`financial_education_term`	Respostas do Termo de Educação Financeira exigido pelo Ministério da Cidadania

FINANCIAL EDUCATION TERM OBJECT

Campo	Descrição
`questions`

QUESTIONS OBJECT

Campo	Descrição
`answer`

FINANCIAL OBJECT

Campo	Descrição
`desired_installments`	Lista de parcelas.
`interest_type` (obrigatório)	Tipo de juros da operação.
`disbursement_start_date`	Data início do período de desembolso (formato "AAAA-MM-DD").
`disbursement_end_date`	Data final do período de desembolso (formato "AAAA-MM-DD").
`annual_interest_rate` (obrigatório)	Valor porcentual da parcela prefixada de juros (atenção: 1 = 100%)
`credit_operation_type` (obrigatório)	Tipo de operação de crédito.
`interest_grace_period`	Carência de juros (em meses)
`number_of_installments`	Número de parcelas (mensais)
`principal_grace_period`	Carência do principal (em meses)

DESIRED INSTALLMENTS OBJECT

Campo	Descrição
`due_date`	Data da parcela.
`total_amount`	Valor total da parcela

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
`name`	Nome do dono da conta para desembolso - Obrigatório apenas se o método de transferência for ted ou pix. e caso haja mais de uma conta para desembolso (Limite de 80 caracteres).
`bank_code`	Código COMPE da instituição financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf) com 3 dígitos - Obrigatório apenas se o método de transferência for ted ou pix e se "ispb_number" não for enviado.
`branch_number`	Número da agência - Obrigatório apenas se o método de transferência for ted ou pix.
`account_number`	Número da conta - Obrigatório apenas se o método de transferência for ted ou pix - Obrigatório apenas se o método de transferência for ted ou pix.
`document_number`	CPF ou CNPJ do dono da conta para desembolso - Obrigatório apenas se o método de transferência for ted ou pix. e 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 - Obrigatório apenas se o método de transferência for ted ou pix.
`ispb_number`	Identificador da instituição no Sistema de Pagamentos Brasileiro - Obrigatório apenas se o método de transferência for ted ou pix e se o "bank_code" não for enviado.
`qr_code_key`	Chave fornecida no momento da criação de um QR Code PIX - Pode ser enviado como o único parâmetro deste objeto, assim o desembolso acontece como pagamento desse QR code PIX.
`digitable_line`	Representação numérica de um código de barras de um boleto - Pode ser enviado como o único parâmetro deste objeto, assim o desembolso acontece como pagamento desse boleto.
`transfer_method`	Por padrão as operações são desembolsadas via PIX, então quando existr a necessidade de que uma operação seja desembolsada via TED este campo pode ser enviado.

Emissão de dívida​

Request​

BODY PARAMS​

BORROWER OBJECT​

GUARANTORS OBJECT​

SPOUSE OBJECT​

PHONE OBJECT​

ADDRESS OBJECT​

OCR OBJECT​

COLLATERALS OBJECT​

COLLATERAL DATA OBJECT​

FINANCIAL EDUCATION TERM OBJECT​

QUESTIONS OBJECT​

FINANCIAL OBJECT​

DESIRED INSTALLMENTS OBJECT​

REBATES OBJECT​

FINE CONFIGURATION OBJECT​

DISBURSEMENT BANK ACCOUNT OBJECT​

Emissão de dívida

Request

BODY PARAMS

BORROWER OBJECT

GUARANTORS OBJECT

SPOUSE OBJECT

PHONE OBJECT

ADDRESS OBJECT

OCR OBJECT

COLLATERALS OBJECT

COLLATERAL DATA OBJECT

FINANCIAL EDUCATION TERM OBJECT

QUESTIONS OBJECT

FINANCIAL OBJECT

DESIRED INSTALLMENTS OBJECT

REBATES OBJECT

FINE CONFIGURATION OBJECT

DISBURSEMENT BANK ACCOUNT OBJECT