Skip to main content

Request quota lock

Introduction​

This resource aims to create a quota lock request for an investor.

Input / Output:​

The lock type and specific information for the lock type must be sent.

As output, the quota_lock_key will be delivered, representing the quota lock.

Request​

ENDPOINT
/quota_lock/investor/INVESTOR_KEY/quota_lock
METHOD
POST
STATUS
201
Quota lock by collateral - natural person 
{
    "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,
            },
        ],
        "bank_account_key": "UUID"
    },
}
Quota lock by collateral - legal person 
{
    "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,
            },
        ],
        "bank_account_key": "UUID"
    },
}

Quota Lock​

FieldTypeDescriptionCharacters
typestringQuota lock type enumeratorup to 255
collateralstringCollateral object-

Quota Lock Type​

EnumeratorDescription
collateralCollateral

Collateral​

FieldTypeDescriptionCharactersRequired
recipientJSONRecipient object-Yes
borrowerJSONBorrower object-Yes
assetsArrayList of Asset objects-Yes
issuance_seriesArrayList of Issuance Series objects-Yes
bank_account_keystringBank account UUID associated with the collateral-No

Recipient​

FieldTypeDescriptionCharactersRequired
namestringRecipient nameup to 255Yes
document_numberstringRecipient's CPF / CNPJ14 or 18Yes
person_typestringNatural person or legal person enumeratorup to 255Yes
natural_personJSONNatural Person object-No
legal_personJSONLegal Person object-No

Borrower​

FieldTypeDescriptionCharactersRequired
namestringBorrower nameup to 255Yes
document_numberstringBorrower's CPF / CNPJ14 or 18Yes
person_typestringNatural person or legal person enumeratorup to 255Yes
natural_personJSONNatural Person object-No
legal_personJSONLegal Person object-No

Person Type​

EnumeratorDescription
natural_personNatural person
legal_personLegal person

Natural Person​

FieldTypeDescriptionCharactersRequired
birthdatestringBirth date10Yes
mother_namestringMother's nameup to 255Yes
FieldTypeDescriptionCharactersRequired
activity_codestringNational Classification of Economic Activities (CNAE)10Yes
representativesarrayList of Representative objects-Yes

Representative​

FieldTypeDescriptionCharactersRequired
namestringRepresentative nameup to 255Yes
document_numberstringRepresentative's CPF14Yes

Asset​

FieldTypeDescriptionCharactersRequired
asset_typestringAsset type enumeratorup to 255Yes
credit_operationJSONCredit Operation object-No

Asset Type​

EnumeratorDescription
ccbCCB
cceCCE

Credit Operation​

FieldTypeDescriptionCharactersRequired
contract_numberstringContract numberup to 255Yes
principal_valuestringPrincipal value of the operation-Yes
interest_rate_typestringPost-fixed / pre-fixed enumeratorup to 255Yes
pre_fixedJSONPre-fixed object-No
post_fixedJSONPost-fixed object-No

Interest Rate Type​

EnumeratorDescription
pre_fixedPre-fixed
post_fixedPost-fixed

Pre fixed​

FieldTypeDescriptionCharacters
calendar_basestringWorking days / 360-day calendar / 365-day calendar enumeratorup to 255
monthly_ratefloatMonthly rate-

Post fixed​

FieldTypeDescriptionCharacters
calendar_basestringWorking days / 360-day calendar / 365-day calendar enumeratorup to 255
indexerstringDI / IPCA enumeratorup to 255
ratefloatRate-
lagJSONLag object-

calendar_base​

EnumeratorDescription
workdaysWorking days
calendar_360360-day calendar
calendar_365365-day calendar

Indexer​

EnumeratorDescription
diDI
ipcaIPCA

Lag​

FieldTypeDescriptionCharacters
referencestringDaily / Monthly enumeratorup to 255
amountintegerLag amount-

Reference​

EnumeratorDescription
dailyDaily
monthlyMonthly

Issuance Serie​

FieldTypeDescriptionCharactersRequired
issuance_serie_keystringIssuance series key36Yes
number_of_quotasfloatNumber of quotas to be locked-No
financial_valuefloatFinancial value to be locked-No

Responses​

Response Body
{
    "quota_lock_key": "UUID"
}