跳到主要内容

创建信贷操作

请求

ENDPOINT
/baas/debt_fgts
方法
POST

模拟操作将返回一系列信息,其中最重要的是 disbursed_issue_amount,它代表可以发放的净现值。基于此值,可以进行计算并按所需格式构建操作请求。

FGTS 生日提款发行属性

操作创建包含 4 个对象:

  • borrower:债务借款人(自然人对象)
  • collaterals:付款分期信息(FGTS Collateral 对象)
  • financial:操作的财务流程数据(FGTS 财务对象)
  • disbursement_bank_accounts:发放信息的银行账户列表(银行账户对象)

Body Params

字段描述
borrower *(必填)标识发送对象为自然人。对于自然人对象,必须始终包含 "natural" 值
collaterals *(必填)付款分期信息
financial *(必填)包含财务对象的所有信息,还需加入 desired installments,表示客户模拟的每期金额
disbursement_bank_accounts *(必填)债务发行必须包含发放银行信息,默认为借款人账户。此对象必须为包含一个或多个账户的列表

BORROWER 对象

字段描述
person_type *(必填)标识发送对象为自然人。必须始终包含 "natural" 值
name *(必填)人员姓名
mother_name *(必填)母亲姓名
birth_date *(必填)出生日期(格式 "YYYY-MM-DD")
profession *(必填)职业
nationality *(必填)国籍
marital_status *(必填)婚姻状况:"single"、"married"、"widower" 或 "divorced"
property_system财产分配制度(仅对 marital_status 为 "married" 的人员必填):"total_communion_of_goods"、"partial_communion_of_goods"、"total_separation_of_goods"、"final_participation_of_acquisitions" 或 "compulsory_separation_of_goods"
wedding_certificate *(必填)结婚证 PDF 的 DOCUMENT_KEY(提前上传)。若 marital_status 为 "single",此字段值应为 null
spouse *(必填)配偶的自然人对象(仅在财产制度为 "total_communion_of_goods"、"partial_communion_of_goods"、"final_participation_of_acquisitions" 或 "compulsory_separation_of_goods" 时必填)。若 marital_status 为 "single",此字段值应为 null
is_pep *(必填)是否为政治公众人物(PEP)的声明,布尔值
individual_document_number *(必填)人员 CPF(仅数字)
document_identification *(必填)带照片身份证件 PDF 的 DOCUMENT_KEY(RG 或 CNH,提前上传)
document_identification_back带照片身份证件背面 PDF 的 DOCUMENT_KEY(提前上传)
document_identification_type身份证件类型,接受 "rg" 或 "cnh" 的枚举值
document_identification_number *(必填)document_identification 中发送的身份证件号码
email电子邮件地址
phone电话号码
address地址
proof_of_residence *(必填)地址证明 PDF 的 DOCUMENT_KEY(提前上传)
ocr用于传递 OCR SDK 生成 key 的对象

PHONE 对象

字段描述
country_code *(必填)电话 DDI 代码(需恰好为 3 位数字)
area_code *(必填)电话 DDD 代码
number *(必填)电话号码(仅数字)
document_number *(必填)签署人证件号码

ADDRESS 对象

字段描述
street *(必填)街道名称
state *(必填)州(两位大写字母)
city *(必填)城市
neighborhood *(必填)社区/街区
number *(必填)门牌号
postal_code *(必填)邮政编码(仅数字)
complement *(必填)地址补充信息(自由文本)

COLLATERALS 对象

字段描述
percentage担保比例(0 到 1 之间)
collateral_type *(必填)担保类型。对于 FGTS,必须为 "fgts_balance"
collateral_data担保数据

COLLATERAL DATA 对象

字段描述
total_amount *(必填)特定日期的摊销金额
due_date到期日期(格式 "YYYY-MM-DD")

FINANCIAL 对象

字段描述
desired_installments客户的发放金额
interest_type *(必填)债务适用的利息类型
credit_operation_type *(必填)信贷操作类型:"ccb"、"cce"、"cci"、"nce"
annual_interest_rate *(必填)固定利息的百分比值(注意:1 = 100%)
disbursement_date发放日期(格式 "YYYY-MM-DD",与 disbursement_date 互斥)
disbursement_start_date发放期间起始日期(格式 "YYYY-MM-DD",与 disbursement_date 互斥)
disbursement_end_date发放期间结束日期(格式 "YYYY-MM-DD",与 disbursement_date 互斥)
issue_dateCCB 发行日期(格式 "YYYY-MM-DD")
interest_grace_period利息宽限期(月)
principal_grace_period本金宽限期(月)
number_of_installments分期数量(年)
fine_configuration罚款配置
rebates返利对象列表

DISBURSEMENT BANK ACCOUNT 对象

字段描述
bank_code *(必填)巴西支付系统中的机构标识符(仅在未发送 COMPE 时必填)
branch_number *(必填)支行号
account_number *(必填)账号
account_digit账户验证位(如有则必填)
document_number发放账户持有人的 CPF 或 CNPJ(如有多个发放账户则必填)
name发放账户持有人姓名(如有多个发放账户则必填)
percentage_receivable账户发放金额的百分比(用于多账户分配)
ispb_number巴西支付系统标识符
pix_keyPix 密钥
qr_code_key创建 QR Code 时提供的密钥
digitable_line银行划款条码的数字表示