Solicitar bloqueio de cotas

Introdução

Este recurso tem como objetivo criar uma solicitação de bloqueio de cotas de um investidor.

Input / Output:

Deve ser enviado o tipo de bloqueio e a informação específica do tipo de bloqueio.

Como output será entregue a quota_lock_key que representa o bloqueio de cota.

Request

ENDPOINT

/quota_lock/investor/INVESTOR_KEY/quota_lock

MÉTODO

POST

STATUS

201

Bloqueio de cotas por garantia - pessoa física

{
    "type": "collateral",
    "collateral": {
        "recipient": {
            "name": "Sample Recipient Name",
            "document_number": "000.000.000-00",
            "person_type": "natural_person",
            "natural_person": {
               "birthdate": "YYYY-MM-DD",
               "mother_name": "Sample Recipient Mother Name",
            }
        },
        "borrower": {
            "name": "Sample Borrower Name",
            "document_number": "000.000.000-00",
            "person_type": "natural_person",
            "natural_person": {
               "birthdate": "YYYY-MM-DD",
               "mother_name": "Sample Borrower Mother Name",
            }
        },
        "assets": [
            {
                "asset_type": "cce",
                "credit_operation": {
                    "contract_number": "1000000001",
                    "principal_value": 0.0,
                    "interest_rate_type": "post_fixed",
                    "pre_fixed": {
                        "monthly_rate": 0.0,
                        "calendar_base": "calendar_360",
                    },
                    "post_fixed": {
                        "calendar_base": "workdays",
                        "indexer": "di",
                        "rate": 1,
                        "lag": {
                           "reference": "daily",
                           "amount": 1
                        },
                    },
                },
            },
        ],
        "issuance_series": [
            {
                "issuance_serie_key": "UUID",
                "number_of_quotas": 0.00,
                "financial_value": 0.00,
            },
            {
                "issuance_serie_key": "UUID",
                "number_of_quotas": 0.00,
                "financial_value": 0.00,
            },
        ],
    },
}

Bloqueio de cotas por garantia - pessoa jurídica

{
    "type": "collateral",
    "collateral": {
        "recipient": {
            "name": "Sample Recipient Name",
            "document_number": "000.000.000-00",
            "person_type": "legal_person",
            "legal_person": {
                "activity_code": "00.00-0-00",
                "representatives": [
                    {
                        "name": "Sample Recipient Representative Name",
                        "document_number": "000.000.000-00",
                    }
                ],
            }
        },
        "borrower": {
            "name": "Sample Borrower Name",
            "document_number": "000.000.000-00",
            "person_type": "legal_person",
            "legal_person": {
                "activity_code": "00.00-0-00",
                "representatives": [
                    {
                        "name": "Sample Borrower Representative Name",
                        "document_number": "000.000.000-00",
                    }
                ],
            }
        },
        "assets": [
            {
                "asset_type": "cce",
                "credit_operation": {
                    "contract_number": "1000000001",
                    "principal_value": 0.0,
                    "interest_rate_type": "post_fixed",
                    "pre_fixed": {
                        "monthly_rate": 0.0,
                        "calendar_base": "calendar_360",
                    },
                    "post_fixed": {
                        "calendar_base": "workdays",
                        "indexer": "di",
                        "rate": 1,
                        "lag": {
                           "reference": "daily",
                           "amount": 1
                        },
                    },
                },
            },
        ],
        "issuance_series": [
            {
                "issuance_serie_key": "UUID",
                "number_of_quotas": 0.00,
                "financial_value": 0.00,
            },
            {
                "issuance_serie_key": "UUID",
                "number_of_quotas": 0.00,
                "financial_value": 0.00,
            },
        ],
    },
}

Quota Lock

Campo	Tipo	Descrição	Caracteres
`type`	string	Enumerador de tipo de bloqueio de cotas	até 255
`collateral`	string	Objeto de Garantia	-

Quota Lock Type

Enumerador	Descrição
`collateral`	Garantia

Collateral

Campo	Tipo	Descrição	Caracteres
`recipient`	JSON	Objeto de Beneficiário	-
`borrower`	JSON	Objeto de Tomador	-
`assets`	Array	Lista de objetos de Ativo	-
`issuance_series`	Array	Lista de objetos de Série de emissão	-

Recipient

Campo	Tipo	Descrição	Caracteres	Obrigatório
`name`	string	Nome do beneficiário	até 255	Sim
`document_number`	string	CPF / CNPJ do beneficiário	14 ou 18	Sim
`person_type`	string	Enumerador de pessoa física ou jurídica	até 255	Sim
`natural_person`	JSON	Objeto de Pessoa Física	-	Não
`legal_person`	JSON	Objeto de Pessoa Jurídica	-	Não

Borrower

Campo	Tipo	Descrição	Caracteres	Obrigatório
`name`	string	Nome do tomador	até 255	Sim
`document_number`	string	CPF / CNPJ do tomador	14 ou 18	Sim
`person_type`	string	Enumerador de pessoa física ou jurídica	até 255	Sim
`natural_person`	JSON	Objeto de Pessoa Física	-	Não
`legal_person`	JSON	Objeto de Pessoa Jurídica	-	Não

Person Type

Enumerador	Descrição
`natural_person`	Pessoa física
`legal_person`	Pessoa jurídica

Natural Person

Campo	Tipo	Descrição	Caracteres	Obrigatório
`birthdate`	string	Data de nascimento	10	Sim
`mother_name`	string	Nome da mãe	até 255	Sim

Legal Person

Campo	Tipo	Descrição	Caracteres	Obrigatório
`activity_code`	string	Classificação Nacional das Atividades Econômicas (CNAE)	10	Sim
`representatives`	array	Lista de objetos de Representative	-	Sim

Representative

Campo	Tipo	Descrição	Caracteres	Obrigatório
`name`	string	Nome do representante	até 255	Sim
`document_number`	string	CPF do representante	14	Sim

Asset

Campo	Tipo	Descrição	Caracteres	Obrigatório
`asset_type`	string	Enumerador de tipo de ativo	até 255	Sim
`credit_operation`	JSON	Objeto de Operação de Crédito	-	Não

Asset Type

Enumerador	Descrição
`ccb`	CCB
`cce`	CCE

Credit Operation

Campo	Tipo	Descrição	Caracteres	Obrigatório
`contract_number`	string	N° do contrato	até 255	Sim
`principal_value`	string	Valor de principal da operação	-	Sim
`interest_rate_type`	string	Enumerador de Pós-fixada / pré-fixada	até 255	Sim
`pre_fixed`	JSON	Objeto de Pré-fixada	-	Não
`post_fixed`	JSON	Objeto de Pós-fixada	-	Não

Interest Rate Type

Enumerador	Descrição
`pre_fixed`	Pré-fixada
`post_fixed`	Pós-fixada

Pre fixed

Campo	Tipo	Descrição	Caracteres
`calendar_base`	string	Enumerador de Dias úteis / calendário 360 / calendário 365	até 255
`monthly_rate`	float	Taxa mensal	-

Post fixed

Campo	Tipo	Descrição	Caracteres
`calendar_base`	string	Enumerador de Dias úteis / calendário 360 / calendário 365	até 255
`indexer`	string	Enumerador de DI / IPCA	até 255
`rate`	float	Taxa	-
`lag`	JSON	Objeto de Lag	-

calendar_base

Enumerador	Descrição
`workdays`	Dias úteis
`calendar_360`	Calendário 360 dias
`calendar_365`	Calendário 365 dias

Indexer

Enumerador	Descrição
`di`	DI
`ipca`	IPCA

Lag

Campo	Tipo	Descrição	Caracteres
`reference`	string	Enumerador de Diário / Mensal	até 255
`amount`	integer	Quantidade de lag	-

Reference

Enumerador	Descrição
`daily`	Diário
`monthly`	Mensal

Issuance Serie

Campo	Tipo	Descrição	Caracteres	Obrigatório
`issuance_serie_key`	string	Chave da série de emissão	36	Sim
`number_of_quotas`	float	Número de cotas a serem bloqueadas	-	Não
`financial_value`	float	Valor financeiro a ser bloqueador	-	Não

Responses

Response Body
{
    "quota_lock_key": "UUID"
}

Solicitar bloqueio de cotas

Introdução​

Input / Output:​

Request​

Quota Lock​

Quota Lock Type​

Collateral​

Recipient​

Borrower​

Person Type​

Natural Person​

Legal Person​

Representative​

Asset​

Asset Type​

Credit Operation​

Interest Rate Type​

Pre fixed​

Post fixed​

calendar_base​

Indexer​

Lag​

Reference​

Issuance Serie​

Responses​