登记商业票据操作

此端点允许根据财务数据和投资人数据创建新的商业票据操作。

Request

ENDPOINT

/commercial_paper/operation

MÉTODO

POST

Request Body

{
    "issuer_key": "48e2c597-f2ca-487e-9f06-2b628ecb831e",
    "issuer_bank_account": {
        "account_number": "4464541",
        "account_digit": "3",
        "account_branch": "0001",
        "financial_institution_code_number": "329",
        "financial_institution_ispb": "32402502",
        "account_type": "checking"
    },
    "investors": [
        {
            "investor_key": "70b1b638-ca56-4eb3-9a88-2fd5ffd077a7",
            "subscription_percentage": 100,
            "bank_account": {
                "account_number": "33400254",
                "account_digit": "3",
                "account_branch": "0001",
                "financial_institution_code_number": "329",
                "financial_institution_ispb": "32402502",
                "account_type": "checking"
            }
        }
    ],
    "issue_date": "2025-01-23",
    "signature_method": "certifiqi",
    "financial": {
        "interest_type": "pre_price_days",
        "financial_base_date": "2025-01-23",
        "released_amount": 1000000,
        "number_of_installments": 5,
        "prefixed_interest_rate": {
            "interest_base": "calendar_days_365",
            "monthly_rate": 0.05
        },
        "fine_delay_rate": {
            "interest_base": "calendar_days_365",
            "monthly_rate": 0.01
        },
        "contract_fine_rate": 0.02,
        "fees": [
            {
                "amount": 5,
                "amount_type": "percentage",
                "fee_type": "structuring_fee"
            }
        ]
    }
}

Request Body Params

字段	类型	描述	最大字符数
`issuer_key` *	string	发行人的唯一键。	-
`issuer_bank_account` *	object	发行人的银行账户。	issuer_bank_account 对象
`investors` *	array	相关投资人列表。	investors 对象
`issue_date` *	string	操作发行日期（格式："YYYY-MM-DD"）。	-
`signature_method`	string	操作中使用的签名方式。可选；省略时默认为 `certifiqi`。	signature_method 枚举值
`financial` *	object	操作的财务数据。	financial 对象
`third_party_disbursement`	object	第三方拨付指令。可选；需先开通该功能。	third_party_disbursement 对象

issuer_bank_account 对象

字段	类型	描述
`account_number` *	string	银行账户号码。
`account_digit` *	string	银行账户校验位。
`account_branch` *	string	银行账户支行。
`financial_institution_code_number` *	string	金融机构代码。
`financial_institution_ispb` *	string	金融机构 ISPB 代码。
`account_type` *	string	账户类型（`checking`、`savings`）。

investors 对象

字段	类型	描述
`investor_key` *	string	投资人的唯一键。
`subscription_percentage` *	number	认购比例。
`bank_account` *	object	投资人的银行账户。

financial 对象

字段	类型	描述
`interest_type` *	string	利率类型。
`financial_base_date` *	string	财务基准日期（格式："YYYY-MM-DD"）。
`released_amount`	number	释放金额。
`issue_amount`	number	发行金额。
`number_of_installments` *	integer	期数。
`installments`	array	installments 对象
`prefixed_interest_rate` *	object	prefixed_interest_rate 对象
`fine_delay_rate` *	object	滞纳金利率。
`contract_fine_rate` *	number	合同罚款百分比。
`fees`	array	费用列表。

注意

financial 对象必须包含有效的参数组合才能被处理。接受的组合为：发行/释放金额 + 利率、发行/释放金额 + 每期金额、每期金额 + 利率、发行/释放金额 + 利率 + 每期摊还比例。

installments 对象

字段	类型	描述
`due_date` *	string	期次到期日（格式："YYYY-MM-DD"）。
`amount`	number	期次总金额。
`principal_amortization_percentage`	number	本金摊还百分比值。

prefixed_interest_rate 对象

字段	类型	描述
`interest_base` *	string	利率计算基础。
`daily_rate`	number	适用的日利率。
`monthly_rate`	number	适用的月利率。
`annual_rate`	number	适用的年利率。

third_party_disbursement 对象

可选指令，表示释放的金额将支付给第三方收款方，而不是支付到发行人的清算账户。该对象不接受所列字段之外的任何字段（additionalProperties: false），且 TED 与 boleto 两条通道互斥。

字段	类型	描述	最大字符数
`payment_method` *	string	拨付所使用的支付通道（`ted`、`bank_slip`、`pix`）。	-
`target_account`	object	收款方的银行账户。当 `payment_method` 为 `ted` 时必填；在其他通道下禁止发送。	target_account 对象
`digitable_line`	string	收款方 boleto 的可键入行，仅数字（格式 `^[0-9]{47}$`）。当 `payment_method` 为 `bank_slip` 时必填；在其他通道下禁止发送。	47
`pix_key`	string	收款方的 Pix 密钥；CPF 与 CNPJ 不带格式符号。当 `payment_method` 为 `pix` 时必填；在其他通道下禁止发送。	77
`pix_key_type`	string	所声明的 Pix 密钥类型（`cpf`、`cnpj`、`phone`、`email`、`evp`）。当 `payment_method` 为 `pix` 时必填；在其他通道下禁止发送。	-
`beneficiary`	object	第三方收款人的资格信息。当 `payment_method` 为 `pix` 时必填；在 `ted` 与 `bank_slip` 下为可选。	操作的第三方拨付

需申请开通的功能

发送 third_party_disbursement 需要事先向 QI Tech 申请开通；未开通时，创建操作会以 COM000062 被拒绝。完整规则 — 包括 boleto 金额的核对、Pix 密钥类型以及 beneficiary 对象的字段 — 见操作的第三方拨付。

target_account 对象

字段	类型	描述	最大字符数
`account_branch` *	string	收款方银行账户的支行，仅数字（正好 4 位）。	4
`account_number` *	string	收款方银行账户的号码，仅数字（1 至 20 位）。	20
`account_digit` *	string	收款方银行账户的校验位，仅数字（正好 1 位）。	1
`financial_institution_ispb` *	string	收款方金融机构的 ISPB 代码，仅数字（正好 8 位）。决定 TED 的路由。	8
`financial_institution_code_number`	string 或 `null`	收款方金融机构的代码，仅数字（3 位）。可选，且不参与路由。	3
`account_type` *	string	收款方的账户类型（`checking`、`savings`、`salary`、`payment`）。	-
`owner_document_number` *	string	账户持有人的 CPF 或 CNPJ，需带格式（`000.000.000-00` 或 `00.000.000/0000-00`）。系统会校验其校验位。	18
`owner_name` *	string	账户持有人的姓名（1 至 50 个字符）。	50

signature_method 枚举值

值	描述
`certifiqi`	默认值。操作将发送至签名服务；创建签名信封，客户端将收到签名 URL（`signature_url`）。
`qi_sign`	操作将发送至签名服务；创建签名信封，客户端将收到签名 URL（`signature_url`）。此外还支持查询操作的签署人。
`client_side`	文件在 QI Tech 平台之外签署，并通过提交已签署文件端点提交。不会生成签名 URL。

Response

STATUS

201

Response Body

{
    "tenant_key": "1d29d606-649a-487f-af1c-c0f5cb3e9814",
    "operation_key": "a846cc4a-b542-4f66-9823-b6d5458bd127",
    "operation_status": "in_filling",
    "issuer_key": "48e2c597-f2ca-487e-9f06-2b628ecb831e",
    "issuer_name": "Dynamic Enterprises",
    "issuer_document_number": "28980395000155",
    "financial": {
        ...
    }
}

Response Body Params

字段	类型	描述
`tenant_key` *	string	tenant 的唯一键。
`operation_key` *	string	操作的唯一键。
`operation_status` *	string	操作的状态。
`issuer_key` *	string	发行人的唯一键。
`issuer_name` *	string	发行人的名称。
`issuer_document_number` *	string	发行人的证件号码。
`financial` *	object	financial 对象

financial response 对象

字段	类型	描述	最大字符数
`financial_base_date` *	string	操作的财务基准日期（格式："YYYY-MM-DD"）。	-
`issue_amount` *	number	操作发行的总金额。	-
`released_amount` *	number	操作中释放的净金额。	-
`issue_quantity` *	integer	发行的总单位数量。	-
`unit_price` *	number	每单位发行价格。	-
`cet` *	number	有效总成本（CET）百分比。	-
`annual_cet` *	number	年化 CET 百分比。	-
`number_of_installments` *	integer	总期数。	-
`prefixed_interest_rate` *	object	包含固定利率详情的对象。	prefixed_interest_rate 对象
`fees`	array	与操作相关的费用列表。	fees 对象
`installments`	array	操作中生成的期数详情列表。	installments 对象
`fine_delay_rate` *	object	包含滞纳金详情的对象。	fine_delay_rate 对象
`contract_fine_rate` *	number	合同罚款百分比。	-

prefixed_interest_rate response 对象

字段	类型	描述
`interest_base` *	string	利率计算基础。
`monthly_rate`	number	适用的月利率。
`daily_rate`	number	适用的日利率。
`annual_rate`	number	适用的年利率。

fees 对象

字段	类型	描述
`amount` *	number	费率百分比值。
`fee_amount` *	number	对应的货币金额。
`amount_type` *	string	费用值类型。
`fee_type` *	string	费用类型。
`type` *	string	费用收款方。

installments response 对象

字段	类型	描述
`installment_number` *	integer	期数编号。
`workdays` *	integer	至到期日的工作日数。
`calendar_days` *	integer	至到期日的自然日数。
`principal_amortization_amount` *	number	本金摊还金额。
`principal_amortization_unit_price` *	number	每单位摊还金额。
`interest_amount` *	number	该期应计利息金额。
`amount` *	number	该期总金额。
`due_date` *	string	该期到期日（格式："YYYY-MM-DD"）。

Request​

Request Body Params​

issuer_bank_account 对象​

investors 对象​

financial 对象​

installments 对象​

prefixed_interest_rate 对象​

third_party_disbursement 对象​

target_account 对象​

signature_method 枚举值​

Response​

Response Body Params​

financial response 对象​

prefixed_interest_rate response 对象​

fees 对象​

installments response 对象​