跳到主要内容

登记认购

此端点允许登记投资人认购某一认缴操作中特定数量股份的意向。

登记认购 (POST)​

Request​

ENDPOINT
/integralization/integralization_process/INTEGRALIZATION-KEY/subscription
MÉTODO
POST

Path Params​

字段类型描述字符数
INTEGRALIZATION-KEYstring认缴的唯一键（UUID v4）。36

Request Body​

Request Body
{
  "investor_key": "123e4567-e89b-12d3-a456-426614174000",
  "investor_bank_account": {
    "account_number": "12345678",
    "account_digit": "0",
    "account_branch": "1234",
    "financial_institution_code_number": "001",
    "financial_institution_ispb": "12345678"
  },
  "subscription_date": "2025-01-01",
  "financial_base_date": "2025-01-01",
  "subscription_note_template_key": "c649c01a-dd24-47b7-b93e-5a6bac50bcf0",
  "subscripted_quantity": 100000
}

Request Body Params​

字段类型描述
investor_key*string投资人的唯一键（UUID v4）。
investor_bank_account*object投资人银行账户数据。
investor_bank_account.account_number*string投资人银行账户号码。
investor_bank_account.account_digit*string投资人银行账户校验位。
investor_bank_account.account_branch*string投资人银行支行。
investor_bank_account.financial_institution_code_number*string投资人金融机构代码。
investor_bank_account.financial_institution_ispb*string投资人金融机构 ISPB。
subscripted_quantity*integer投资人希望认购的股份数量。
financial_base_date*string财务基准日期。
subscription_date*string认购日期。
subscription_note_template_key*string认购公告模板。

Response​

STATUS
201
Response Body
{
    "subscription_key": "2f7e00b5-988f-4214-bb46-4728d9081148",
    "investor_key": "a76e408a-c733-4a68-963a-dc93ff0bc3e3",
    "investor_name": "Global Enterprises",
    "investor_document_number": "89206257000108",
    "investor_bank_account": {
        "account_digit": "0",
        "account_branch": "1234",
        "account_number": "12345678",
        "financial_institution_ispb": "12345678",
        "financial_institution_code_number": "001"
    },
    "subscription_date": "2025-01-27",
    "financial_base_date": "2025-01-27",
    "subscripted_quantity": 1000000,
    "unit_price": 1.0,
    "expected_amount": 1000000.0,
    "paid_amount": 1000000.0,
    "subscription_note_template_key": "6d4c5168-b7c7-4092-9931-4c76aea6af80",
    "subscription_note_document_key": "5ea88fca-4ca3-4dfe-aea4-35e431aef3c5/2f7e00b5-988f-4214-bb46-4728d9081148/subscription_note/f206d799-cb94-48d5-81c5-5988ecef8079",
    "envelope_signature_status": "pending_creation",
    "envelope_signature_url": "https://certifiqi.com.br/envelope_key",
    "envelope_key": "6d4c5168-b7c7-4092-9931-4c76aea6af80",
    "subscription_payment_list": []
}

Response Body Params​

字段类型描述
subscription_keystring认购的唯一键（UUID v4）。
investor_keystring与认购关联的投资人唯一键（UUID v4）。
investor_namestring投资人名称。
investor_document_numberstring投资人证件号码（CPF 或 CNPJ）。
investor_bank_accountobjectinvestor_bank_account 对象。
subscription_datestring认购日期（格式：YYYY-MM-DD）。
financial_base_datestring认购财务基准日期（格式：YYYY-MM-DD）。
subscripted_quantityinteger已认购的股份数量。
unit_pricenumber已认购股份的单价。
expected_amountnumber认购预期总金额。
paid_amountnumber认购已支付总金额。
subscription_note_template_keystring认购公告模板的唯一键（UUID v4）。
subscription_note_document_keystring认购公告文件的唯一键。
envelope_signature_statusstring认购公告签名状态。
envelope_signature_urlstring认购公告签名 URL。
envelope_keystring签名信封键。
subscription_payment_listarray与认购关联的付款列表。subscription_payment_list 对象。

investor_bank_account 对象​

字段类型描述
account_numberstring投资人银行账户号码。
account_digitstring投资人银行账户校验位。
account_branchstring投资人银行支行。
financial_institution_code_numberstring投资人金融机构代码。
financial_institution_ispbstring投资人金融机构 ISPB。

subscription_payment_list 对象​

字段类型描述
subscription_payment_keystring认购付款的唯一键（UUID v4）。
payment_receipt_document_keystring付款凭证文件键。
descriptionstring付款凭证说明。
amountnumber已登记的付款金额。
subscription_payment_statusstring付款状态。可能的值：waiting_confirmation、confirmed、denied。
updated_atstring付款最后更新日期和时间（格式：ISO 8601）。