Commercial Paper Operation Registration
This endpoint allows creating a new commercial paper operation based on financial and investor data.
Request
ENDPOINT
/commercial_paper/operationMETHOD
POSTRequest 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
| Field | Type | Description | Max Characters |
|---|---|---|---|
issuer_key * | string | Unique issuer key. | - |
issuer_bank_account * | object | Issuer bank account. | issuer_bank_account Object |
investors * | array | List of involved investors. | investors Object |
issue_date * | string | Operation issue date (format "YYYY-MM-DD"). | - |
signature_method | string | Signature method used in the operation. Optional; when omitted, defaults to certifiqi. | signature_method Enumerators |
financial * | object | Operation financial data. | financial Object |
third_party_disbursement | object | Third-party disbursement instruction. Optional; requires prior enablement. | third_party_disbursement Object |
issuer_bank_account Object
| Field | Type | Description |
|---|---|---|
account_number * | string | Bank account number. |
account_digit * | string | Bank account digit. |
account_branch * | string | Bank account branch. |
financial_institution_code_number * | string | Financial institution code. |
financial_institution_ispb * | string | Financial institution ISPB code. |
account_type * | string | Account type (checking, savings). |
investors Object
| Field | Type | Description |
|---|---|---|
investor_key * | string | Unique investor key. |
subscription_percentage * | number | Subscription percentage. |
bank_account * | object | Investor bank account. |
financial Object
| Field | Type | Description |
|---|---|---|
interest_type * | string | Interest type. |
financial_base_date * | string | Financial base date (format "YYYY-MM-DD"). |
released_amount * | number | Released amount. |
number_of_installments * | integer | Number of installments. |
prefixed_interest_rate * | object | Prefixed interest rate. |
fine_delay_rate * | object | Delay fine rate. |
contract_fine_rate * | number | Contractual fine in percentage. |
fees | array | List of fees. |
third_party_disbursement Object
Optional instruction stating that the released amount will be paid to a third-party beneficiary instead of the issuer's settlement account. The object does not accept fields beyond the ones listed (additionalProperties: false) and the two tracks — TED and bank slip — are mutually exclusive.
| Field | Type | Description | Max Characters |
|---|---|---|---|
payment_method * | string | Payment track used in the disbursement (ted, bank_slip, pix). | - |
target_account | object | Beneficiary bank account. Required when payment_method is ted; forbidden on the other tracks. | target_account Object |
digitable_line | string | Digitable line of the beneficiary's bank slip, digits only (pattern ^[0-9]{47}$). Required when payment_method is bank_slip; forbidden on the other tracks. | 47 |
pix_key | string | Beneficiary's Pix key, unformatted for CPF and CNPJ. Required when payment_method is pix; forbidden on the other tracks. | 77 |
pix_key_type | string | Declared type of the Pix key (cpf, cnpj, phone, email, evp). Required when payment_method is pix; forbidden on the other tracks. | - |
beneficiary | object | Qualification of the third-party beneficiary. Required when payment_method is pix; optional on ted and bank_slip. | Third-party disbursement |
Feature available on request
Sending third_party_disbursement requires prior enablement by QI Tech; without it the creation is refused with COM000062. The complete rules — including the bank slip amount check, the Pix key types and the beneficiary object fields — are in Third-party disbursement on the operation.
target_account Object
| Field | Type | Description | Max Characters |
|---|---|---|---|
account_branch * | string | Beneficiary bank account branch, digits only (exactly 4). | 4 |
account_number * | string | Beneficiary bank account number, digits only (1 to 20). | 20 |
account_digit * | string | Beneficiary bank account digit, digits only (exactly 1). | 1 |
financial_institution_ispb * | string | ISPB code of the beneficiary's financial institution, digits only (exactly 8). Determines the TED routing. | 8 |
financial_institution_code_number | string or null | Code of the beneficiary's financial institution, digits only (3). Optional and not used for routing. | 3 |
account_type * | string | Beneficiary account type (checking, savings, salary, payment). | - |
owner_document_number * | string | CPF or CNPJ of the account holder, formatted (000.000.000-00 or 00.000.000/0000-00). The check digits are validated. | 18 |
owner_name * | string | Account holder name (1 to 50 characters). | 50 |
signature_method Enumerators
| Value | Description |
|---|---|
certifiqi | Default value. The operation is sent to the signature service; a signature envelope is created and the client receives the signature URL (signature_url). |
qi_sign | The operation is sent to the signature service; a signature envelope is created and the client receives the signature URL (signature_url). Also allows querying the operation's signers. |
client_side | The documents are signed outside the QI Tech platform and sent through the send signed documents endpoint. No signature URL is generated. |
Response
STATUS
201Response 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
| Field | Type | Description |
|---|---|---|
tenant_key * | string | Unique tenant key. |
operation_key * | string | Unique operation key. |
operation_status * | string | Operation status. |
issuer_key * | string | Unique issuer key. |
issuer_name * | string | Issuer name. |
issuer_document_number * | string | Issuer document. |
financial * | object | financial Object |
financial Object Response
| Field | Type | Description | Max Characters |
|---|---|---|---|
financial_base_date * | string | Operation financial base date (format "YYYY-MM-DD"). | - |
issue_amount * | number | Total issued amount of the operation. | - |
released_amount * | number | Net amount released in the operation. | - |
issue_quantity * | integer | Total quantity of units issued. | - |
unit_price * | number | Unit price of the issuance. | - |
cet * | number | Total Effective Cost (CET) in percentage. | - |
annual_cet * | number | Annual CET in percentage. | - |
number_of_installments * | integer | Total number of installments. | - |
prefixed_interest_rate * | object | Object containing prefixed interest rate details. | prefixed_interest_rate Object |
fees | array | List of fees associated with the operation. | fees Object |
installments | array | List of installment details generated in the operation. | installments Object |
fine_delay_rate * | object | Object containing delay fine details. | fine_delay_rate Object |
contract_fine_rate * | number | Contractual fine applied in percentage. | - |
prefixed_interest_rate Object
| Field | Type | Description | Max Characters |
|---|---|---|---|
interest_base * | string | Calculation base for interest. | interest_base Enumerators |
monthly_rate * | number | Applied monthly interest rate. | - |
daily_rate * | number | Applied daily interest rate. | - |
annual_rate * | number | Applied annual interest rate. | - |
fees Object
| Field | Type | Description | Max Characters |
|---|---|---|---|
amount * | number | Percentage value of the fee. | - |
fee_amount * | number | Monetary value corresponding to the fee. | - |
amount_type * | string | Type of fee value. | amount_type Enumerators |
fee_type * | string | Type of fee. | fee_type Enumerators |
type * | string | Fee recipient. | fee_recipient Enumerators |
installments Object
| Field | Type | Description |
|---|---|---|
installment_number * | integer | Installment number. |
workdays * | integer | Business days until installment due date. |
calendar_days * | integer | Calendar days until installment due date. |
principal_amortization_amount * | number | Principal amortized amount. |
principal_amortization_unit_price * | number | Amortized amount per unit. |
interest_amount * | number | Interest amount applied in the installment. |
amount * | number | Total installment amount. |
due_date * | string | Installment due date (format "YYYY-MM-DD"). |