资产 - 信贷业务
创建 - 商业汇票
Request
ENDPOINT
/trade_receivables/BASE_URL/assignment/EXTERNAL_ID/assetMÉTODO
POSTRequest Body
{
"asset_type": "duplicata_mercantil",
"total_purchase_value": 1231.21,
"discounted_credit_right": {
"external_id": "ccf6f331-d55f-46c0-a32f-fb909884dbb2",
"originator_document_number": "46.282.154/0001-14",
"maturity_date": "2023-12-10",
"order_number": "18923619954796912",
"face_value": 1023.01,
"person_type": "natural_person",
"borrower": {
"name": "Natália Nascimento",
"document_number": "805.359.140-08",
"person_type": "natural_person",
"email": "natália.nascimento@yopmail.com",
"address": {
"street": "Gilberto Sabino",
"number": "215",
"neighborhood": "Pinheiros",
"city": "São Paulo",
"postal_code": "05425-020",
"uf": "SP",
"country": "BRA"
},
"phone": {
"area_code": "11",
"number": "36360268"
},
"natural_person": {
"mother_name": "Lívia Santos",
"birthdate": "2001-01-05"
}
},
"participant_control_number": "ICX841HWCPUGU4U101XPLDW8D",
"bankslip": {
"our_number": {
"number": 2,
"digit": "P"
}
},
"delay": {
"fine": {
"fine_type": "percentage",
"percentage_value": 0.0
},
"interest": {
"method": "pre_fixed",
"pre_fixed": {
"daily_rate": 0.0,
"calendar_base": "calendar_360"
}
}
},
"invoice": {
"access_key": "69037229347091328617032722238810300308237163",
"total_value": 1231.21,
"serie": "123",
"number": "958431587",
"issue_date": "2023-10-10"
}
}
}
定义
资产对象(Request Body)
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
asset_type * | string | 资产类型。 | 最多 50 |
total_purchase_value * | number | 资产采购总价。即受让方实际支付的金额。 | 保留 2 位小数 |
discounted_credit_right * | object | 参见 信用权利对象。 | - |
信用权利对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
external_id * | string | 集成合作伙伴系统中此批次的唯一标识键。 | 最多 50 个字符 |
originator_document_number * | string | 促成此信贷业务的发起人/顾问的标识文件号。 | 格式化 CPF 或 CNPJ |
maturity_date * | string | 分期到期日。 | 格式化日期 |
order_number * | string | 订单编号。 | 最多 45 |
face_value * | number | 面值。 | 最多 8 位小数 |
borrower * | object | 参见 借款人对象。 | - |
participant_control_number | string | 集成合作伙伴系统中的参与者控制编号。 | 50 个字母数字字符 |
bankslip | object | 参见 银行票据对象。 | - |
delay | object | 参见 逾期对象。 | - |
invoice * | object | 参见 发票对象。 | - |
借款人对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
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 个字符 |
自然人对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
birthdate | string | 出生日期。 | 格式化日期 |
gender | string | 参见 性别枚举值。 | enumerator |
mother_name | string | 母亲姓名。 | 最多 255 |
性别枚举值
| 枚举值 | 描述 |
|---|---|
| male | 男性。 |
| female | 女性。 |
法人对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
foundation_date | string | 成立日期。 | 格式化日期 |
activity_code | string | 经营活动代码。 | - |
annual_revenues | integer | 年收入。 | - |
representatives | object | 参见 法人对象。 | enumerator |
代表人对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
name | string | 代表人姓名。 | 最多 255 |
document_number | string | 代表人标识文件号。 | CPF 或 CNPJ |
email | string | 代表人电子邮箱。 | 最多 255 |
phone | object | 参见 电话对象。 | enumerator |
address | object | 参见 地址对象。 | enumerator |
person_type | string | 参见 人员类型枚举值。 | enumerator |
representative_type | string | 代表人类型。 | 最多 50 |
电话对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
international_dial_code | string | 国际区号。 | 最多 3 |
area_code | string | 区号。 | 2 位数字 |
number | string | 号码 。 | 最多 10 |
银行票据对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
our_number | object | 包含"我方编号"数据的对象。仅适用于由客户开具我方编号的情况。参见 我方编号对象。 | - |
我方编号对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
number | number | 我方编号。用于有登记收款的银行编号。 | 1 至 11 位数字字符 |
digit | string | 我方编号的自校验位。 | 1 位字母数字字符 |
逾期对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
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 | 复利逾期利息 |
| pre_fixed | 单利逾期利息 |
发票对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
access_key * | string | 发票编号。 | 44 个字符 |
total_value | number | 总值。 | 保留 2 位小数 |
serie * | string | 序列号。 | 最多 3 |
number * | string | 发票号码。 | 最多 50 |
issue_date * | string | 发行日期。 | 格式化日期 |
Response
STATUS
201Response Body
{
"asset_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
"status": "pending_eligibility",
}