跳到主要内容

资产 - 信贷业务


创建 - 商业汇票

Request

ENDPOINT
/trade_receivables/BASE_URL/assignment/EXTERNAL_ID/asset
MÉTODO
POST
Request 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_numberstring集成合作伙伴系统中的参与者控制编号。50 个字母数字字符
bankslipobject参见 银行票据对象-
delayobject参见 逾期对象-
invoice *object参见 发票对象-

借款人对象

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

人员类型枚举值

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

地址对象

字段类型描述字符数
street *string如无完整信息,可将汇总信息填入此字段。最多 255
numberstring门牌号。最多 40
neighborhoodstring街区/社区。最多 255
citystring城市。最多 255
ufstring州/省。2 个字符
complementstring补充地址。最多 255
postal_code *string邮政编码。9 个字符
countrystring国家。3 个字符

自然人对象

字段类型描述字符数
birthdatestring出生日期。格式化日期
genderstring参见 性别枚举值enumerator
mother_namestring母亲姓名。最多 255

性别枚举值

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

法人对象

字段类型描述字符数
foundation_datestring成立日期。格式化日期
activity_codestring经营活动代码。-
annual_revenuesinteger年收入。-
representativesobject参见 法人对象enumerator

代表人对象

字段类型描述字符数
namestring代表人姓名。最多 255
document_numberstring代表人标识文件号。CPF 或 CNPJ
emailstring代表人电子邮箱。最多 255
phoneobject参见 电话对象enumerator
addressobject参见 地址对象enumerator
person_typestring参见 人员类型枚举值enumerator
representative_typestring代表人类型。最多 50

电话对象

字段类型描述字符数
international_dial_codestring国际区号。最多 3
area_codestring区号。2 位数字
numberstring号码。最多 10

银行票据对象

字段类型描述字符数
our_numberobject包含"我方编号"数据的对象。仅适用于由客户开具我方编号的情况。参见 我方编号对象-

我方编号对象

字段类型描述字符数
numbernumber我方编号。用于有登记收款的银行编号。1 至 11 位数字字符
digitstring我方编号的自校验位。1 位字母数字字符

逾期对象

字段类型描述字符数
fineobject到期罚款对象。参见 逾期罚款对象-
interestobject逾期利息对象。参见 逾期利息对象-

逾期罚款对象

字段类型描述字符数
fine_typestring参见 罚款类型枚举值enumerator
percentage_valuenumber罚款金额(当罚款类型为 percentage 时)。计量单位:0 至 1,对应 0 至 100%最多 2 位小数
amountnumber罚款金额(当罚款类型为 fixed 时)。最多 2 位小数
罚款类型枚举值
枚举值描述
percentage按分期金额的百分比计算的罚款
fixed固定罚款金额

逾期利息对象

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

发票对象

字段类型描述字符数
access_key *string发票编号。44 个字符
total_valuenumber总值。保留 2 位小数
serie *string序列号。最多 3
number *string发票号码。最多 50
issue_date *string发行日期。格式化日期

Response

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