资产 - 信贷业务

创建 - 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 CTVM",
        "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"
          }
      ],
    }
}

定义

资产对象（Request Body）

字段	类型	描述	字符数
`asset_type` *	string	资产类型。	最多 50
`total_purchase_value` *	number	资产采购总价。即受让方实际支付的金额。	保留 2 位小数
`premiums`	list of objects	销售中涉及的溢价列表。此信息仅供后续查看，不用于任何后续计算。参见溢价对象。	-
`credit_operation` *	object	参见信贷业务对象。	-

溢价对象

字段	类型	描述	字符数
`premium_type`	string	溢价类型。参见溢价类型枚举值。	enumerator
`total_value`	number	该溢价的总金额。	保留 2 位小数

溢价类型枚举值

枚举值	描述
spread	与信贷发起和发行相关的利差

信贷业务对象

字段	类型	描述	字符数
`external_id` *	string	集成合作伙伴系统中此资产的唯一标识键。	最多 50
`originator_document_number` *	string	促成此信贷业务的发起人/顾问的标识文件号。	格式化 CPF 或 CNPJ
`principal_value` *	number	此业务的未偿还本金总额。	最多 8 位小数
`contract` *	object	参见合同对象。	-
`borrower` *	object	参见借款人对象。	-
`amortization_type` *	string	业务计算中使用的摊销类型。参见摊销类型枚举值	enumerator
`interest_rate_type` *	string	业务的利率类型。参见利率类型枚举值	enumerator
`pre_fixed` *	object	含固定利率部分计算信息的对象。参见固定利率对象。	-
`installments` *	list of objects	业务分期列表。参见分期对象。	-
`modality_code`	string	标识与资产相关联的金融业务类别或类型的标识符。	4
`consignee`	object	参见代扣对象。	-
`collaterals`	list of objects	担保品列表。参见担保品对象。	-

注意

信贷业务的 external_id 字段对于不同资产必须唯一，不应与批次标识符 EXTERNAL_ID 混淆。

摊销类型枚举值

枚举值	描述
sac	SAC 类型摊销
price	Price 类型摊销

利率类型枚举值

枚举值	描述
pre_fixed	固定利率业务
post_fixed	浮动利率业务

借款人对象

字段	类型	描述	字符数
`name` *	string	借款人姓名。	最多 255
`document_number` *	string	借款人标识文件号。	CPF 或 CNPJ
`person_type` *	string	人员类型。参见人员类型枚举值。	enumerator
`email`	string	借款人电子邮箱。	最多 255
`address` *	object	参见地址对象。	-
`phone`	object	参见电话对象。	-

人员类型枚举值

枚举值	描述
natural_person	自然人。参见自然人对象。
legal_person	法人。参见法人对象。

地址对象

字段	类型	描述	字符数
`street` *	string	如无完整信息，可将汇总信息填入此字段。	最多 255
`number`	string	门牌号。	最多 40
`neighborhood`	string	街区/社区。	最多 255
`city`	string	城市。	最多 255
`uf`	string	州/省。	2 个字符
`complement`	string	补充地址。	最多 255
`postal_code` *	string	邮政编码。	9 个字符
`country`	string	国家。	3 个字符

电话对象

字段	类型	描述	字符数
`area_code` *	string	区号。	2
`number` *	string	电话号码。	9

合同对象

字段	类型	描述	字符数
`number` *	string	合同编号。	最多 50
`disbursement_date` *	string	放款日期。	格式化日期
`issue_date` *	string	发行日期。	格式化日期
`signature_date`	string	合同签署日期。	格式化日期
`issue_value` *	number	合同发行价值。	保留 2 位小数

固定利率对象

字段	类型	描述	字符数
`calendar_base` *	string	使用的计算基础。参见计算基础枚举值。	enumerator
`monthly_rate` *	number	合同的月利率。1% 使用 0.01	最多 8 位小数

计算基础枚举值

枚举值	描述
workdays	以工作日为计算基础（252天）
calendar_365	以 365 天为计算基础
calendar_360	以 360 天为计算基础

自然人对象

字段	类型	描述	字符数
`birthdate`	string	出生日期。	格式化日期
`gender`	string	参见性别枚举值。	enumerator
`mother_name`	string	母亲姓名。	最多 255

性别枚举值

枚举值	描述
male	男性。
female	女性。

法人对象

字段	类型	描述	字符数
`foundation_date`	string	成立日期。	格式化日期
`activity_code` *	string	经营活动代码。	格式：11.11-1-11
`annual_revenues`	integer	年收入。	-
`representatives`	object	参见法人对象。	enumerator

分期对象

字段	类型	描述	字符数
`maturity_date` *	string	分期到期日。	格式化日期
`installment_number` *	number	分期编号。	整数
`face_value`	number	面值。	最多 8 位小数
`principal_value`	number	到期日预期摊还的本金。	最多 8 位小数

逾期对象

字段	类型	描述	字符数
`fine` *	object	到期罚款对象。参见逾期罚款对象。	-
`interest` *	object	逾期利息对象。参见逾期利息对象。	-

逾期罚款对象

字段	类型	描述	字符数
`fine_type` *	string	参见罚款类型枚举值。	enumerator
`percentage_value`	number	罚款金额（当罚款类型为 `percentage` 时）。计量单位：0 至 1，对应 0 至 100%	最多 2 位小数
`amount`	number	罚款金额（当罚款类型为 `fixed` 时）。	最多 2 位小数

罚款类型枚举值

枚举值	描述
percentage	按分期金额的百分比计算的罚款
fixed	固定罚款金额

逾期利息对象

字段	类型	描述	字符数
`method` *	string	参见逾期利息计算方法枚举值。	enumerator
`pre_fixed` *	object	参见固定利率对象。	-

逾期利息计算方法枚举值

枚举值	描述
compound	复利逾期利息
simple	单利逾期利息

代扣对象

字段	类型	描述	字符数
`name` *	string	代扣实体名称。	最多 255
`document_number` *	string	代扣实体标识文件号。	CPF 或 CNPJ
`consignee_type` *	string	代扣类型。参见代扣类型枚举值。	enumerator

代扣类型枚举值

枚举值	描述
public	公共代扣
private	私人代扣
inss	INSS 代扣

担保品对象

字段	描述
`collateral_type` *	担保品类型。参见担保品类型枚举值

担保品类型枚举值

枚举值	描述
fgts	FGTS 担保。参见 FGTS 对象
social_security	INSS 担保。参见 INSS 对象
home_equity	不动产担保。参见不动产对象

FGTS 对象

字段	描述
`protocol_number` *	协议编号。
`status` *	状态。

INSS 对象

字段	类型	描述	字符数
`benefit_number` *	string	福利编号。	-
`benefit_type` *	string	福利类型。	-
`status` *	string	状态。	-

不动产对象

字段	类型	描述	字符数
`enterprise_name` *	string	项目名称。	-
`registration_number` *	string	不动产登记编号。	-
`enterprise_document_number`	string	与项目相关联的标识文件号。	CPF 或 CNPJ
`collateral_properties` *	list object	不动产属性列表。参见不动产属性对象。	-

不动产属性对象

字段	类型	描述	字符数
`address` *	object	不动产地址。参见地址对象。	-
`total_collateral_value` *	number	不动产价值。	最多 8 位小数

Response

STATUS

201

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

可能的错误

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"
}

创建 - CCB​

Request​

定义​

资产对象（Request Body）​

溢价对象​

溢价类型枚举值​

信贷业务对象​

摊销类型枚举值​

利率类型枚举值​

借款人对象​

人员类型枚举值​

地址对象​

电话对象​

合同对象​

固定利率对象​

计算基础枚举值​

自然人对象​

性别枚举值​

法人对象​

分期对象​

逾期对象​

逾期罚款对象​

罚款类型枚举值​

逾期利息对象​

逾期利息计算方法枚举值​

代扣对象​

代扣类型枚举值​

担保品对象​

担保品类型枚举值​

FGTS 对象​

INSS 对象​

不动产对象​

不动产属性对象​

Response​

可能的错误​

创建 - CCB

Request

定义

资产对象（Request Body）

溢价对象

溢价类型枚举值

信贷业务对象

摊销类型枚举值

利率类型枚举值

借款人对象

人员类型枚举值

地址对象

电话对象

合同对象

固定利率对象

计算基础枚举值

自然人对象

性别枚举值

法人对象

分期对象

逾期对象

逾期罚款对象

罚款类型枚举值

逾期利息对象

逾期利息计算方法枚举值

代扣对象

代扣类型枚举值

担保品对象

担保品类型枚举值

FGTS 对象

INSS 对象

不动产对象

不动产属性对象

Response

可能的错误