Skip to main content

Ativos - Operações de Crédito

Criação - CCB​

Request​

ENDPOINT
/trade_receivables/BASE_URL/assignment/EXTERNAL_ID/asset
METHOD
POST
Request Body
{
    "asset_type": "ccb",
    "total_purchase_value": 1351.66,
    "premiums": [
      {
        "premium_type": "spread",
        "total_value": 13.38
      }
    ],
    "credit_operation": {
      "contract": {
        "number": "0008309052/NBF",
        "disbursement_date": "2023-07-06",
        "issue_date": "2023-07-06",
        "signature_date": "2023-07-06",
        "issue_value": 1338.28
      },
      "amortization_type": "sac",
      "borrower": {
        "name": "QI DTVM",
        "document_number": "19.845.976/0001-93",
        "person_type": "legal_person",
        "email": "qidtvm@qitech.com.br",
        "address": {
          "street": "Pátio de Teixeira",
          "number": "1",
          "neighborhood": "Estrela do Oriente",
          "city": "Rondônia",
          "postal_code": "01012-030",
          "uf": "RO",
          "country": "BRA"
        },
        "phone": {
          "area_code": "11",
          "number": "936360268"
        },
        "legal_person": {
          "activity_code": "11.11-1-11"
        }
      },
      "delay": {
        "fine": {
          "fine_type": "percentage",
          "percentage_value": 0.0
        },
        "interest": {
          "method": "compound",
          "pre_fixed": {
            "monthly_rate": 0.0,
            "calendar_base": "calendar_360"
          }
        }
      },
      "principal_value": 1338.28,
      "interest_rate_type": "pre_fixed",
      "external_id": "ccf6f331-d55f-46c0-a32f-fb909884dbb2",
      "originator_document_number": "75.723.105/0001-78",
      "pre_fixed": {
        "calendar_base": "calendar_365",
        "monthly_rate": 0.018
      },
      "installments": [
        {
          "maturity_date": "2023-10-01",
          "installment_number": 1,
          "face_value": 689.33
        },
        {
          "maturity_date": "2024-10-01",
          "installment_number": 2,
          "face_value": 482.53
        },
        {
          "maturity_date": "2025-10-01",
          "installment_number": 3,
          "face_value": 300.36
        },
        {
          "maturity_date": "2026-10-01",
          "installment_number": 4,
          "face_value": 162.77
        },
        {
          "maturity_date": "2027-10-01",
          "installment_number": 5,
          "face_value": 81.39
        },
        {
          "maturity_date": "2028-10-01",
          "installment_number": 6,
          "face_value": 40.69
        }
      ]
    }
}

Definições​

Object Ativo (Request Body)​

CampoTipoDescriçãoCaracteres
asset_type *stringTipo do Ativo.Até 50
total_purchase_value *numberValor total da compra do Ativo. Efetivamente quanto o Cessionário vai pagar.2 casas decimais
premiumslist of objectsLista de Ágios envolvidos na venda. Esta informação é apenas para visualização posterior e não é utilizada em nenhum cálculo posterior. Ver Object Ágio.-
credit_operation *objectVer Object Operação de Crédito.-

Object Ágio​

CampoTipoDescriçãoCaracteres
premium_typestringTipo do Ágio. Ver Enumerador Tipo de Ágio.enumerator
total_valuenumberQual o valor total desse ágio.2 casas decimais

Enumerador Tipo de Ágio​

EnumeradorDescrição
spreadSpread vinculado a originação e Emissão do Crédito

Object Operação de Crédito​

CampoTipoDescriçãoCaracteres
external_id *stringChave única de identificação deste ativo no sistema do parceiro integrador.Até 50
originator_document_number *stringDocumento identificador do Originador/Consultor que viabilizou essa operação de crédito.CPF ou CNPJ formatado
principal_value *numberO principal total em aberto dessa Operação.Até 8 casas decimais
contract *objectVer Object de Contrato.-
borrower *objectVer Object do Sacado.-
amortization_type *stringO tipo de amortização utilizado no cálculo da Operação. Ver Enumerador Tipo de Amortizaçãoenumerator
interest_rate_type *stringO tipo de juros da Operação. Ver Enumerador Tipo de Jurosenumerator
pre_fixed *objectObjeto com informações do cálculo da parte pré fixada. Ver Object de Pré Fixado.-
installments *list of objectsLista das parcelas da operação. Ver Object de Parcelas.-
Atenção

O campo external_id da operação de crédito deve ser único para diferentes ativos e não deve ser confundido com EXTERNAL_ID indentificador do lote

Enumerador Tipo de Amortização​

EnumeradorDescrição
sacAmortização do tipo SAC
priceAmortização do tipo Price

Enumerador Tipo de Juros​

EnumeradorDescrição
pre_fixedPara operações pré fixadas
post_fixedPara operações pós fixadas

Object do Sacado​

CampoTipoDescriçãoCaracteres
name *stringNome do Sacado.Até 255
document_number *stringDocumento identificador do Sacado.CPF ou CNPJ
person_type *stringTipo de Pessoa. Ver Enumerador Tipo de Pessoa.enumerator
emailstringEmail do Sacado.Até 255
address *objectVer Object de Endereço.-
phoneobjectVer Object de Telefone.-

Enumerador Tipo de Pessoa​

EnumeradorDescrição
natural_personPessoa Física. Ver Object de Pessoa Física.
legal_personPessoa Juridica. Ver Object de Pessoa Juridica.

Object de Endereço​

CampoTipoDescriçãoCaracteres
street *stringCaso não tenha todas as infos, mandar o compilado neste campo.Até 255
numberstringNúmero do Endereço.Até 40
neighborhoodstringBairro.Até 255
citystringCidade.Até 255
ufstringEstado.2 Caracteres
complementstringComplemento.Até 255
postal_code *stringCEP.9 Caracteres
countrystringPaís.3 Caracteres

Object Contrato​

CampoTipoDescriçãoCaracteres
number *stringNúmero do Contrato.Até 50
disbursement_date *stringData de desembolso.Data Formatada
issue_date *stringData de emissão.Data Formatada
signature_datestringData de assinatura do contrato.Data Formatada
issue_value *numberValor de emissão do contrato.2 casas decimais

Object Pré Fixado​

CampoTipoDescriçãoCaracteres
calendar_base *stringA base de cálculo utilizada. Ver Enumerador Base de Cálculo.enumerator
monthly_rate *numberA taxa mensal do contrato. Para 1% usar 0.01Até 8 casas decimais

Enumerador Base de Cálculo​

EnumeradorDescrição
workdaysPara base de cálculo dias úteis (252)
calendar_365Para base de cálculos 365
calendar_360Para base de cálculos 360

Object de Pessoa Física​

CampoTipoDescriçãoCaracteres
birthdatestringData de nascimento.Data Formatada
genderstringVer Enumerador de Gênero.enumerator
mother_namestringNome da mãe.Até 255

Enumerador de Gênero​

EnumeradorDescrição
maleMasculino.
femaleFeminino.

Object de Pessoa Juridica​

CampoTipoDescriçãoCaracteres
foundation_datestringData de fundação.Data Formatada
activity_code *stringCódigo de Atividade.Formato: 11.11-1-11
annual_revenuesintegerReceita Anual.-
representativesobjectVer Object de Pessoa Juridica.enumerator

Object Parcelas​

CampoTipoDescriçãoCaracteres
maturity_date *stringData de vencimento da parcela.Data Formatada
installment_number *numberNúmero da parcela.Inteiro
face_valuenumberValor de face.Até 8 casas decimais
principal_valuenumberPrincipal esperado a ser amortizado na data de vencimento.Até 8 casas decimais

Object Atraso​

CampoTipoDescriçãoCaracteres
fine *objectObjeto da multa no vencimento. Ver Object Multa de Atraso.-
interest *objectObjeto do juros de mora. Ver Object Juros de Mora.-

Object Multa de Atraso​

CampoTipoDescriçãoCaracteres
fine_type *stringVer Enumerador Tipo da Multa.enumerator
percentage_valuenumberValor da Multa, se tipo da multa for percentage. Unidade de medida: de 0 à 1, considerando 0 à 100%Até 2 casas decimais
amountnumberValor da Multa, se tipo de multa for fixed.Até 2 casas decimais
Enumerador Tipo da Multa​
EnumeradorDescrição
percentageMulta percentual sobre o valor da parcela
fixedValor fixo de Multa

Object Juros de Mora​

CampoTipoDescriçãoCaracteres
method *stringVer Enumerador Método do Juros de Mora.enumerator
pre_fixed *objectVer Object de Pré Fixado.-
Enumerador Método do Juros de Mora​
EnumeradorDescrição
compoundPara juros de mora composto
pre_fixedPara juros de mora simples

Response​

STATUS
201
Response Body
{
    "asset_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
    "status": "pending_eligibility",
}