Ativos - Operações de Crédito

---

Criação - CCB

Request

ENDPOINT

/trade_receivables/BASE_URL/assignment/EXTERNAL_ID/asset

MÉTODO

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
        }
      ],
      "modality_code": "0202",
      "consignee": {
        "consignee_type": "inss",
        "name": "Consignee name",
        "document_number": "11.620.231/3105-71"
      },
      "collaterals": [
           {
            "collateral_type": "social_security",
            "benefit_number": "0000000000",
            "benefit_type": "benefit_type",
            "status": "reserved"
          }
      ],
    }
}

Definições

Objeto Ativo (Request Body)

Campo	Tipo	Descrição	Caracteres
asset_type *	string	Tipo do Ativo.	Até 50
total_purchase_value *	number	Valor total da compra do Ativo. Efetivamente quanto o Cessionário vai pagar.	2 casas decimais
premiums	list of objects	Lista de Ágios envolvidos na venda. Esta informação é apenas para visualização posterior e não é utilizada em nenhum cálculo posterior. Ver Objeto Ágio.	-
credit_operation *	object	Ver Objeto Operação de Crédito.	-

Objeto Ágio

Campo	Tipo	Descrição	Caracteres
premium_type	string	Tipo do Ágio. Ver Enumerador Tipo de Ágio.	enumerator
total_value	number	Qual o valor total desse ágio.	2 casas decimais

Enumerador Tipo de Ágio

Enumerador	Descrição
spread	Spread vinculado a originação e Emissão do Crédito

Objeto Operação de Crédito

Campo	Tipo	Descrição	Caracteres
external_id *	string	Chave única de identificação deste ativo no sistema do parceiro integrador.	Até 50
originator_document_number *	string	Documento identificador do Originador/Consultor que viabilizou essa operação de crédito.	CPF ou CNPJ formatado
principal_value *	number	O principal total em aberto dessa Operação.	Até 8 casas decimais
contract *	object	Ver Objeto de Contrato.	-
borrower *	object	Ver Objeto do Sacado.	-
amortization_type *	string	O tipo de amortização utilizado no cálculo da Operação. Ver Enumerador Tipo de Amortização	enumerator
interest_rate_type *	string	O tipo de juros da Operação. Ver Enumerador Tipo de Juros	enumerator
pre_fixed *	object	Objeto com informações do cálculo da parte pré fixada. Ver Objeto de Pré Fixado.	-
installments *	list of objects	Lista das parcelas da operação. Ver Objeto de Parcelas.	-
modality_code	string	Identificador que especifica a categoria ou tipo de operação financeira associada a um ativo.	4
consignee	object	Ver Objeto de Consignado.	-
collaterals	list of objects	Lista de garantias. Ver Objeto de Garatia.	-

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

Enumerador	Descrição
sac	Amortização do tipo SAC
price	Amortização do tipo Price

Enumerador Tipo de Juros

Enumerador	Descrição
pre_fixed	Para operações pré fixadas
post_fixed	Para operações pós fixadas

Objeto do Sacado

Campo	Tipo	Descrição	Caracteres
name *	string	Nome do Sacado.	Até 255
document_number *	string	Documento identificador do Sacado.	CPF ou CNPJ
person_type *	string	Tipo de Pessoa. Ver Enumerador Tipo de Pessoa.	enumerator
email	string	Email do Sacado.	Até 255
address *	object	Ver Objeto de Endereço.	-
phone	object	Ver Objeto de Telefone.	-

Enumerador Tipo de Pessoa

Enumerador	Descrição
natural_person	Pessoa Física. Ver Objeto de Pessoa Física.
legal_person	Pessoa Juridica. Ver Objeto de Pessoa Juridica.

Objeto de Endereço

Campo	Tipo	Descrição	Caracteres
street *	string	Caso não tenha todas as infos, mandar o compilado neste campo.	Até 255
number	string	Número do Endereço.	Até 40
neighborhood	string	Bairro.	Até 255
city	string	Cidade.	Até 255
uf	string	Estado.	2 Caracteres
complement	string	Complemento.	Até 255
postal_code *	string	CEP.	9 Caracteres
country	string	País.	3 Caracteres

Objeto de Telefone

Campo	Tipo	Descrição	Caracteres
area_code *	string	Código de area.	2
number *	string	Número de telefone.	9

Objeto Contrato

Campo	Tipo	Descrição	Caracteres
number *	string	Número do Contrato.	Até 50
disbursement_date *	string	Data de desembolso.	Data Formatada
issue_date *	string	Data de emissão.	Data Formatada
signature_date	string	Data de assinatura do contrato.	Data Formatada
issue_value *	number	Valor de emissão do contrato.	2 casas decimais

Objeto Pré Fixado

Campo	Tipo	Descrição	Caracteres
calendar_base *	string	A base de cálculo utilizada. Ver Enumerador Base de Cálculo.	enumerator
monthly_rate *	number	A taxa mensal do contrato. Para 1% usar 0.01	Até 8 casas decimais

Enumerador Base de Cálculo

Enumerador	Descrição
workdays	Para base de cálculo dias úteis (252)
calendar_365	Para base de cálculos 365
calendar_360	Para base de cálculos 360

Objeto de Pessoa Física

Campo	Tipo	Descrição	Caracteres
birthdate	string	Data de nascimento.	Data Formatada
gender	string	Ver Enumerador de Gênero.	enumerator
mother_name	string	Nome da mãe.	Até 255

Enumerador de Gênero

Enumerador	Descrição
male	Masculino.
female	Feminino.

Objeto de Pessoa Juridica

Campo	Tipo	Descrição	Caracteres
foundation_date	string	Data de fundação.	Data Formatada
activity_code *	string	Código de Atividade.	Formato: 11.11-1-11
annual_revenues	integer	Receita Anual.	-
representatives	object	Ver Objeto de Pessoa Juridica.	enumerator

Objeto Parcelas

Campo	Tipo	Descrição	Caracteres
maturity_date *	string	Data de vencimento da parcela.	Data Formatada
installment_number *	number	Número da parcela.	Inteiro
face_value	number	Valor de face.	Até 8 casas decimais
principal_value	number	Principal esperado a ser amortizado na data de vencimento.	Até 8 casas decimais

Objeto Atraso

Campo	Tipo	Descrição	Caracteres
fine *	object	Objeto da multa no vencimento. Ver Objeto Multa de Atraso.	-
interest *	object	Objeto do juros de mora. Ver Objeto Juros de Mora.	-

Objeto Multa de Atraso

Campo	Tipo	Descrição	Caracteres
fine_type *	string	Ver Enumerador Tipo da Multa.	enumerator
percentage_value	number	Valor da Multa, se tipo da multa for percentage. Unidade de medida: de 0 à 1, considerando 0 à 100%	Até 2 casas decimais
amount	number	Valor da Multa, se tipo de multa for fixed.	Até 2 casas decimais

Enumerador Tipo da Multa

Enumerador	Descrição
percentage	Multa percentual sobre o valor da parcela
fixed	Valor fixo de Multa

Objeto Juros de Mora

Campo	Tipo	Descrição	Caracteres
method *	string	Ver Enumerador Método do Juros de Mora.	enumerator
pre_fixed *	object	Ver Objeto de Pré Fixado.	-

Enumerador Método do Juros de Mora

Enumerador	Descrição
compound	Para juros de mora composto
simple	Para juros de mora simples

Objeto de Consignado

Campo	Tipo	Descrição	Caracteres
name *	string	Nome do ente consignante.	Até 255
document_number *	string	Documento identificador do ente consignante.	CPF ou CNPJ
consignee_type *	string	Tipo de consignado. Ver Enumerador Tipo de Consignado.	enumerator

Enumerador Tipo de Consignado

Enumerador	Descrição
public	consignado público
private	consignado privado
inss	consignado INSS

Objeto de Garantia

Campo	Descrição
collateral_type *	Tipo de garantia. Ver Enumerador Tipo de Garantia

Enumerador Tipo de Garantia

Enumerador	Descrição
fgts	Garantia de FGTS. Ver Objeto de FGTS
social_security	Garantia de INSS. Ver Objeto de INSS
home_equity	Garantia de Imóveis. Ver Objeto de Imóveis

Objeto de FGTS

Campo	Descrição
protocol_number *	Número do protocolo.
status *	Status.

Objeto de INSS

Campo	Tipo	Descrição	Caracteres
benefit_number *	string	Número do benefício.	-
benefit_type *	string	Tipo do benefício.	-
status *	string	Status.	-

Objeto de Imóveis

Campo	Tipo	Descrição	Caracteres
enterprise_name *	string	Nome do empreendimento.	-
registration_number *	string	Número do registro do imóvel.	-
enterprise_document_number	string	Documento identificador associado ao empreendimento.	CPF ou CNPJ
collateral_properties *	list object	Lista de propriedades dos imóveis. Ver Objeto de Propriedades dos Imóveis.	-

Objeto de Propriedades dos Imóveis

Campo	Tipo	Descrição	Caracteres
address *	object	Endereço do imóvel. Ver Objeto de Endereço.	-
total_collateral_value *	number	Valor do imóvel.	Até 8 casas decimais

Response

STATUS

201

Response Body

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

Possíveis erros

STATUS

404

Response Body

{
  "title": "Assignment not found",
  "description": "Assignment not found",
  "translation": "Lote não encontrado",
  "code": "TRC000018"
}

STATUS

404

Response Body

{
  "title": "Asset type does not exist",
  "description": "Asset type 'invalid_asset_type' does not exist",
  "translation": "Tipo do ativo 'invalid_asset_type' nao existe",
  "code": "TRC000015"
}

STATUS

400

Response Body

{
  "title": "Invalid asset type configuration",
  "description": "This assignment can not receive this asset type: ccb",
  "translation": "Esse lote não pode receber esse tipo de ativo: ccb",
  "code": "TRC000025"
}

STATUS

400

Response Body

{
  "title": "Assignment is closed",
  "description": "Assignment is closed to insert new assets",
  "translation": "Lote esta fechado para inserir novos ativos",
  "code": "TRC000022"
}

STATUS

400

Response Body

{
  "title": "Invalid Document number",
  "description": "Given '000.000.000-00' document number is invalid.",
  "translation": "O numero de document '000.000.000-00' fornecido não é valido.",
  "code": "TRC000009"
}

STATUS

400

Response Body

{
  "title": "Originator bond not found",
  "description": "Originator bond not found",
  "translation": "Vinculo com originador não foi encontrado",
  "code": "TRC000019"
}

STATUS

400

Response Body

{
  "title": "Already Exist This External Id",
  "description": "Already exist an asset with this External Id",
  "translation": "Ja existe um ativo com esse External Id",
  "code": "TRC000054"
}