Pular para o conteúdo principal

Consultar bloqueio de cotas

Introdução​

Este recurso tem como objetivo detalhar as informações de uma solicitação de bloqueio de cotas de um investidor.

Request​

ENDPOINT
/quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY
MÉTODO
GET
STATUS
200

Response​

{
  "quota_lock_key": "UUID",
  "status": "pending_documents",
  "original_locked_quotas": 0.0,
  "current_locked_quotas": 0.0,
  "original_locked_value": 0.0,
  "current_locked_value": 0.0,
  "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_key": "UUID",
        "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
            }
          }
        },
        "documents": [
          {
            "document_key": "UUID",
            "document_type": "asset_document"
          }
        ]
      }
    ],
    "issuance_series": [
      {
        "issuance_serie_key": "UUID",
        "number_of_quotas": 0.0,
        "financial_value": 0.0
      },
      {
        "issuance_serie_key": "UUID",
        "number_of_quotas": 0.0,
        "financial_value": 0.0
      }
    ],
    "documents": [
      {
        "document_key": "UUID",
        "document_type": "collateral_contract"
      }
    ]
  },
  "investor_positions_locks": [
    {
      "investor_position_lock_key": "UUID",
      "investor_position_key": "UUID",
      "original_locked_quotas": 0.0,
      "current_locked_quotas": 0.0,
      "original_locked_value": 0.0,
      "current_locked_value": 0.0
    }
  ]
}

Quota Lock​

CampoTipoDescriçãoCaracteres
quota_lock_keystringIdentificador único do bloqueio de cotas36
statusstringEnumerador de tipo de bloqueio de cotasaté 255
typestringEnumerador de tipo de bloqueio de cotasaté 255
original_locked_quotasfloatQuantidade original de cotas bloqueadas-
current_locked_quotasfloatQuantidade atual de cotas bloqueadas-
original_locked_valuefloatValor original do bloqueio-
current_locked_valuefloatValor atual do bloqueio-
collateralJSONObjeto de Garantia-
investor_positions_locksArrayLista de objetos de Bloqueio de posição do investidor-

Quota Lock Status​

EnumeradorDescrição
pending_documentsPendente documentos
pending_approvalPendente aprovação
deniedNegado
approvedAprovado

Quota Lock Type​

EnumeradorDescrição
collateralGarantia

Collateral​

CampoTipoDescriçãoCaracteres
recipientJSONObjeto de Beneficiário-
borrowerJSONObjeto de Tomador-
assetsArrayLista de objetos de Ativo-
issuance_seriesArrayLista de objetos de Série de emissão-
documentsArrayLista de objetos de Documento da garantia-

Recipient​

CampoTipoDescriçãoCaracteres
namestringNome do beneficiárioaté 255
document_numberstringCPF / CNPJ do beneficiário14 ou 18
person_typestringEnumerador de pessoa física ou jurídicaaté 255
natural_personJSONObjeto de Pessoa Física-
legal_personJSONObjeto de Pessoa Jurídica-

Borrower​

CampoTipoDescriçãoCaracteres
namestringNome do tomadoraté 255
document_numberstringCPF / CNPJ do tomador14 ou 18
person_typestringEnumerador de pessoa física ou jurídicaaté 255
natural_personJSONObjeto de Pessoa Física-
legal_personJSONObjeto de Pessoa Jurídica-

Person Type​

EnumeradorDescrição
natural_personPessoa física
legal_personPessoa jurídica

Natural Person​

CampoTipoDescriçãoCaracteres
birthdatestringData de nascimento10
mother_namestringNome da mãeaté 255
CampoTipoDescriçãoCaracteres
activity_codestringClassificação Nacional das Atividades Econômicas (CNAE)10
representativesarrayLista de objetos de Representative-

Representative​

CampoTipoDescriçãoCaracteres
namestringNome do representanteaté 255
document_numberstringCPF do representante14

Asset​

CampoTipoDescriçãoCaracteres
asset_keystringIdentificador único do ativoaté 255
asset_typestringEnumerador de tipo de ativoaté 255
statusstringEnumerador de status de ativoaté 255
credit_operationJSONObjeto de Operação de Crédito-
documentsArrayLista de objetos de Documento do ativo-

Asset Status​

EnumeradorDescrição
pending_approvalPendente aprovação
doneconcluído

Document​

CampoTipoDescriçãoCaracteres
document_keystringIdentificador único do ativoaté 255
document_typestringEnumerador de tipo de ativoaté 255

Asset Type​

EnumeradorDescrição
ccbCCB
cceCCE

Credit Operation​

CampoTipoDescriçãoCaracteres
contract_numberstringN° do contratoaté 255
principal_valuestringValor de principal da operação-
interest_rate_typestringEnumerador de pós-fixada / pré-fixadaaté 255
pre_fixedJSONObjeto de Pré-fixada-
post_fixedJSONObjeto de Pós-fixada-

Interest Rate Type​

EnumeradorDescrição
pre_fixedPré-fixada
post_fixedPós-fixada

Pre fixed​

CampoTipoDescriçãoCaracteres
calendar_basestringEnumerador de Dias úteis / calendário 360 / calendário 365até 255
monthly_ratefloatTaxa mensal-

Post fixed​

CampoTipoDescriçãoCaracteres
calendar_basestringEnumerador de Dias úteis / calendário 360 / calendário 365até 255
indexerstringEnumerador de DI / IPCAaté 255
ratefloatTaxa-
lagJSONObjeto de Lag-

calendar_base​

EnumeradorDescrição
workdaysDias úteis
calendar_360Calendário 360 dias
calendar_365Calendário 365 dias

Indexer​

EnumeradorDescrição
diDI
ipcaIPCA

Lag​

CampoTipoDescriçãoCaracteres
referencestringEnumerador de Diário / Mensalaté 255
amountintegerQuantidade de lag-

Reference​

EnumeradorDescrição
dailyDiário
monthlyMensal

Locked Investor Positions​

CampoTipoDescriçãoCaracteres
investor_position_lock_keystringIdentificador único do bloqueio da posição do investor36
investor_position_keystringIdentificador único da posição do investidor36
original_locked_quotasfloatQuantidade original de cotas bloqueadas-
current_locked_quotasfloatQuantidade atual de cotas bloqueadas-
original_locked_valuefloatValor original do bloqueio-
current_locked_valuefloatValor atual do bloqueio-

Responses​

Response Body
{
    "quota_lock_key": "UUID"
}