Consulta de Subscrição

Este endpoint permite consultar uma subcrição em andamento.

---

Consulta de Subscrição (GET)

Request

ENDPOINT

/integralization/integralization_process/INTEGRALIZATION-KEY/subscription/SUBSCRIPTION-KEY

MÉTODO

GET

Path Params

Campo	Tipo	Descrição	Caracteres
INTEGRALIZATION-KEY	string	Chave única da integralização (UUID v4).	36
SUBSCRIPTION-KEY	string	Chave única da subscrição (UUID v4).	36

---

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": [
        {
            "subscription_payment_key": "7e51be5b-fdfd-4f2f-ba1a-0d81cdb08177",
            "payment_receipt_document_key": "f352de14-222f-4787-bd67-2063524f8d9f/2f7e00b5-988f-4214-bb46-4728d9081148/subscription_payment/7e51be5b-fdfd-4f2f-ba1a-0d81cdb08177",
            "description": "Comprovante itau",
            "amount": 1000000.0,
            "subscription_payment_status": "confirmed",
            "updated_at": "2025-01-27T14:33:54.214891"
        }
    ]
}

---

Response Body Params

Campo	Tipo	Descrição
subscription_key	string	Chave única da subscrição (UUID v4).
investor_key	string	Chave única do investidor associado à subscrição (UUID v4).
investor_name	string	Nome do investidor.
investor_document_number	string	Número do documento do investidor (CPF ou CNPJ).
investor_bank_account	object	Objeto investor_bank_account.
subscription_date	string	Data da subscrição (formato: YYYY-MM-DD).
financial_base_date	string	Data base financeira da subscrição (formato: YYYY-MM-DD).
subscripted_quantity	integer	Quantidade de cotas subscritas.
unit_price	number	Preço unitário das cotas subscritas.
expected_amount	number	Valor total esperado da subscrição.
paid_amount	number	Valor total pago na subscrição.
subscription_note_template_key	string	Chave única do template da nota de subscrição (UUID v4).
subscription_note_document_key	string	Chave única do documento da nota de subscrição.
envelope_signature_status	string	Status de assinatura da nota de subscrição.
envelope_signature_url	string	URL de assinatura da nota de subscrição.
envelope_key	string	Chave do envelope de assinatura.
subscription_payment_list	array	Lista de pagamentos associados à subscrição. Objeto subscription_payment_list.

---

Objeto investor_bank_account

Campo	Tipo	Descrição
account_number	string	Número da conta bancária do investidor.
account_digit	string	Dígito verificador da conta bancária do investidor.
account_branch	string	Agência bancária do investidor.
financial_institution_code_number	string	Código da instituição financeira do investidor.
financial_institution_ispb	string	ISPB da instituição financeira do investidor.

Objeto subscription_payment_list

Campo	Tipo	Descrição
subscription_payment_key	string	Chave única do pagamento da subscrição (UUID v4).
payment_receipt_document_key	string	Chave do documento do comprovante de pagamento.
description	string	Descrição do comprovante de pagamento.
amount	number	Valor do pagamento registrado.
subscription_payment_status	string	Status do pagamento. Valores possíveis: waiting_confirmation, confirmed, denied.
updated_at	string	Data e hora da última atualização do pagamento (formato: ISO 8601).