# QI Tech — Investment-as-a-Service › Visibilidade de caixa Documentação da QI Tech em texto corrido, para colar em um LLM. Fonte: https://docs.qitech.com.br 6 página(s). Índice: - Recuperando Informações da Conta (/documentation/iaas/visibildade_de_caixa/get_accounts) - Recuperando Transações de uma Conta (/documentation/iaas/visibildade_de_caixa/get_transactions) - Introdução (/documentation/iaas/visibildade_de_caixa/inicio) - Transferência entre contas do fundo (/documentation/iaas/visibildade_de_caixa/post_internal_transfer) - Criando Pedido de Estorno (/documentation/iaas/visibildade_de_caixa/post_transaction_reversal) - Webhooks (/documentation/iaas/visibildade_de_caixa/webhook_transaction_reversal) --- # Recuperando Informações da Conta URL: /documentation/iaas/visibildade_de_caixa/get_accounts --- ### Request ENDPOINT /cash_account/fund_class/FUND_CLASS_KEY/accounts MÉTODO GET ### Response STATUS 200 ```json title='Response Body' { { "data":[ { "account_key":"fdbe66e9-4b1d-4254-8473-523b8d3587be", "account_type":"checking_account", "financial_institution":{ "ispb":"32402502", "code":"329", "name":"QI Sociedade de Crédito Direto" }, "account_status":"open", "account_number":"999999", "account_digit":"9", "account_branch":"0001", "accounting_identification":1, "balance":0, "owner":{ "name":"FUNDO DE INVESTIMENTO EM DIREITOS CREDITORIOS", "document_number":"16.958.441/0001-30" }, "owner_document_number":"16.958.441/0001-30" }, { "account_key":"e40dd24e-4341-4736-a868-f3e767dd6c31", "account_type":"checking_account", "financial_institution":{ "ispb":"32402502", "code":"329", "name":"QI Sociedade de Crédito Direto" }, "account_status":"open", "account_number":"77777", "account_digit":"7", "account_branch":"0001", "accounting_identification":2, "balance":0, "owner":{ "name":"FUNDO DE INVESTIMENTO EM DIREITOS CREDITORIOS", "document_number":"16.958.441/0001-30" }, "owner_document_number":"16.958.441/0001-30" } ], "limit":10, "page":0, "is_last_page":true } } ``` ### Response Fields | Campo | Tipo | Descrição | |---------------|--------|--------------------------------------------------------| | `data` | array | Lista de objetos de **[Account](#account)** | | `limit` | int | Limite de objetos recuperados por página | | `page` | int | Número da página recuperada | | `is_last_page`| boolean| Informação que indica se a página recuperada é a última| ### Account | Campo | Tipo | Descrição | Caracteres | |-----------------------------|--------|------------------------------------------------|------------| | `account_key` | string | Chave única identificadora da conta no sistema | 36 | | `account_type` | string | Tipo de conta | Até 50 | | `financial_institution` | JSON | Objeto de instituição financeira | - | | `account_status` | string | Status da conta | Até 50 | | `account_number` | string | Número da conta | Até 50 | | `account_digit` | string | Digito da conta | 1 | | `account_branch` | string | Agência da conta | Até 50 | | `accounting_identification` | int | Identificador ordinal da conta | - | | `balance` | int | Saldo da conta no momento | - | | `owner` | JSON | Objeto de proprietário | - | | `owner_document_number` | string | Documento do proprietário | 14 ou 18 | :::caution **Atenção** O saldo é disponibilizado concatenando reais e centavos ex.: 1234 = R$ 12,34 ::: ### Finacial institution | Campo | Tipo | Descrição | Caracteres | |--------|--------|--------------------------------------------------|------------| | `ispb` | string | Identificador de Sistema de Pagamentos Brasileiro| 8 | | `code` | string | Código da instituição financeira | 3 | | `name` | string | Nome da instituição financeira | Até 255 | ### Owner | Campo | Tipo | Descrição | Caracteres | |-------------------|--------|---------------------------|------------| | `name` | string | Nome do proprietário | até 255 | | `document_number` | string | Documento do proprietário | 14 ou 18 | --- # Recuperando Transações de uma Conta URL: /documentation/iaas/visibildade_de_caixa/get_transactions --- ### Request ENDPOINT /cash_account/account/ACCOUNT_KEY/transactions MÉTODO GET ### Response STATUS 200 ```json title='Response Body' { "data": [ { "transaction_key": "ed585534-8c05-431d-b829-0dc7883b24ba", "transaction_type": "outgoing_wire_transfer", "transaction_status": "pending_conciliation", "transaction_description": "Descrição do pagamento", "amount": -70000, "transaction_datetime": "2025-01-01T14:00:00Z", "account_balance": 500000, "transaction_data": { "counter_part_account": { "owner": { "name": "Nome da Contraparte", "document_number": "***.805.49*-**" }, "account_digit": "8", "account_branch": "1", "account_number": "1234567", "financial_institution": { "code": "329", "ispb": "32402502" } }, }, "account": { "account_key": "9c1d0c18-01ea-4c32-a878-1c6391f9aa44", "account_type": "checking_account", "financial_institution": { "ispb": "32402502", "code": "329", "name": "QI Sociedade de Crédito Direto" }, "account_status": "open", "account_number": "3289018", "account_digit": "7", "account_branch": "0001", "accounting_identification": 1, "balance": 500000, "owner": { "name": "FUNDO TESTE", "document_number": "93.625.214/0001-34" }, "owner_document_number": "93.625.214/0001-34", "account_configuration": { "pix": true, "wire_transfer": true }, "billings": [] } }, { "transaction_key": "16c9c463-266e-4e73-b87d-efc32aa6727a", "transaction_type": "incoming_wire_transfer", "transaction_status": "reconciled", "transaction_description": "Descrição", "amount": 300000, "transaction_datetime": "2025-06-04T13:00:00Z", "account_balance": 570000, "transaction_data": { "counter_part_account": { "owner": { "name": "FUNDO TESTE", "document_number": "93.625.214/0001-34" }, "account_digit": "8", "account_branch": "73", "account_number": "567567", "financial_institution": { "code": "341", "ispb": "60701190", } }, }, "account": { "account_key": "9c1d0c18-01ea-4c32-a878-1c6391f9aa44", "account_type": "checking_account", "financial_institution": { "ispb": "32402502", "code": "329", "name": "QI Sociedade de Crédito Direto" }, "account_status": "open", "account_number": "3289018", "account_digit": "7", "account_branch": "0001", "accounting_identification": 1, "balance": 500000, "owner": { "name": "FUNDO TESTE", "document_number": "93.625.214/0001-34" }, "owner_document_number": "93.625.214/0001-34", "account_configuration": { "pix": true, "wire_transfer": true }, "billings": [] }, "conciliation_group": { "description": "TRANSFERÊNCIA: CONTA COBRANÇA -> CONTA PRINCIPAL", "conciliation_group_key": "1ac2921c-6c81-481b-8472-6c4126bba4bf", "conciliation_group_datetime": "2025-01-01T13:28:58Z" } } ], "limit": 10, "page": 0, "is_last_page": true } ``` ### Query Params | Campo | Tipo | Descrição | |---------------|--------|----------------------------| | `status` | string | Status da transação | | `start_date` | string | Data inicial de consulta | | `end_date` | string | Data final de consulta | | `page` | string | Número da página recuperada| ### Response Fields | Campo | Tipo | Descrição | |---------------|--------|--------------------------------------------------------| | `data` | array | Lista de objetos de **[Transaction](#transaction)** | | `limit` | int | Limite de objetos recuperados por página | | `page` | int | Número da página recuperada | | `is_last_page`| boolean| Informação que indica se a página recuperada é a última| ### Transaction | Campo | Tipo | Descrição | Caracteres | |-----------------------------|--------|---------------------------------------------------|------------| | `transaction_key` | string | Chave única identificadora da transação | 36 | | `transaction_type` | string | Tipo de transação | Até 50 | | `transaction_status` | string | status da transação | Até 50 | | `transaction_description` | string | Descrição da transação fornecida pelo banco | Até 255 | | `amount` | bigint | Valor da transação vezes 100 (ex: R$1,00 == 100) | - | | `transaction_datetime` | string | Data e hora da transação | ISO 8601 | | `account_balance` | bigint | Saldo da conta após a transação | - | | `transaction_data` | JSON | Objeto com informações adicionais da transação | - | | `account` | JSON | Objeto da conta contendo a transação | - | ### Account | Campo | Tipo | Descrição | Caracteres | |-----------------------------|--------|-------------------------------------|------------| | `account_key` | string | Chave única identificadora da conta | 36 | | `account_type` | string | Tipo de conta | Até 50 | | `financial_institution` | JSON | Objeto de instituição financeira | - | | `account_status` | string | Status da conta | Até 50 | | `account_number` | string | Número da conta | Até 50 | | `account_digit` | string | Digito da conta | 1 | | `account_branch` | string | Agência da conta | Até 50 | | `accounting_identification` | int | Identificador ordinal da conta | - | | `balance` | int | Saldo da conta no momento | - | | `owner` | JSON | Objeto de proprietário | - | | `owner_document_number` | string | Documento do proprietário | 14 ou 18 | :::caution **Atenção** O saldo é disponibilizado concatenando reais e centavos ex.: 1234 = R$ 12,34 ::: ### Finacial institution | Campo | Tipo | Descrição | Caracteres | |--------|--------|---------------------------------------------------|------------| | `ispb` | string | Identificador de Sistema de Pagamentos Brasileiro | 8 | | `code` | string | Código da instituição financeira | 3 | | `name` | string | Nome da instituição financeira | Até 255 | ### Owner | Campo | Tipo | Descrição | Caracteres | |-------------------|--------|---------------------------|------------| | `name` | string | Nome do proprietário | até 255 | | `document_number` | string | Documento do proprietário | 14 ou 18 | ### Conciliation Group | Campo | Tipo | Descrição | Caracteres | |-------------------------------|--------|------------------------------------------|------------| | `description` | string | Descrição da conciliação da transação | Até 255 | | `conciliation_group_key` | string | Chave única identificadora da conciliação| 36 | | `conciliation_group_datetime` | string | data e horário da conciliação | ISO 8601 | --- # Introdução URL: /documentation/iaas/visibildade_de_caixa/inicio A visibilidade das movimentações de caixa é extremamente importante para a gestão de um fundo de investimento. Nesta seção iremos explicar as ferramentas disponibilizadas para consultar as informações de contas. Para ter acesso a esses serviços, entre em contato com o time [integracao.dtvm@qitech.com.br](mailto:integracao.dtvm@qitech.com.br), para que seja feito as devidas liberações, tanto em ambiente de Homologação (Sandbox), quanto em ambiente produtivo. ### Informações de conta Nessa ferramenta é possível resgatar uma lista de informações das contas de um fundo, conforme descrito em: [5.7.2.1 Recuperando Informações da Conta](/documentation/iaas/visibildade_de_caixa/get_accounts). --- # Transferência entre contas do fundo URL: /documentation/iaas/visibildade_de_caixa/post_internal_transfer Esse recurso permite realizar uma transferência de valores entre duas contas pertencentes ao mesmo fundo, debitando a conta de origem e creditando a conta de destino. --- ### Request ENDPOINT /transfer/fund_class/FUND_CLASS_KEY/internal_transfer MÉTODO POST ```json title='Request Body' { "amount": 15000, "description": "Internal transfer", "origin_key": "", "origin_type": "manual_transfer", "source_account_key": "", "target_account_key": "", "transfer_type": "pix" } ``` ### Response STATUS 201 ```json title='Response Body' { "internal_transfer_key": "", "internal_transfer_status": "created" } ``` ### Path Params | Campo | Tipo | Descrição | |------------------|--------|------------------------------------------------| | `fund_class_key` | string | Chave única identificadora do fundo na QI CTVM | ### Body Params | Campo | Tipo | Descrição | |-----------------------|--------|------------------------------------------------------------------------------------------------------------------| | `amount` | int | Valor a ser transferido, em centavos (ex.: `15000` = R$ 150,00) | | `description` | string | Descrição da transferência | | `origin_key` | string | Chave única de idempotência da transferência (UUID v4), gerada pelo integrador a cada solicitação | | `origin_type` | string | Tipo de origem da transferência. Deve ser enviado como `manual_transfer` | | `source_account_key` | string | Chave única identificadora da conta a ser debitada (origem) | | `target_account_key` | string | Chave única identificadora da conta a ser creditada (destino) | | `transfer_type` | string | Tipo de transferência. Aceita `pix` ou `wire_transfer`, limitado ao que a conta de origem suporta | :::caution **Atenção** Para receber o resultado da transferência, é necessário a configuração do webhook de confirmação da transferência. ::: --- # Criando Pedido de Estorno URL: /documentation/iaas/visibildade_de_caixa/post_transaction_reversal --- ### Request ENDPOINT /transaction_reversal/fund_class/FUND_CLASS_KEY/transaction_reversal MÉTODO POST ### Response STATUS 201 ```json title='Response Body' { "amount": 125.25, "description": "Estorno - transferência indevida", "reversal_type": "pix", "reference_date": "2025-01-01", "source_account": { "owner": { "name": "Nome do Fundo", "document_number": "123.805.491-24" }, "account_digit": "8", "account_branch": "0001", "account_number": "1234567", "financial_institution": { "ispb": "32402502", "code": "329", "name": "QI Sociedade de Crédito Direto" }, }, "transaction_key": "4208d7d1-9077-4d00-aa4a-a4368b954867" } ``` ### Path Params | Campo | Tipo | Descrição | |-----------------|--------|------------------------------------------------| | `fund_class_key`| string | Chave única identificadora do fundo na QI CTVM | ### Body Params | Campo | Tipo | Descrição | |----------------------------------|-------------------------|----------------------------------------------------------------------------| | `amount`* | float | Valor a ser estornado | | `description`* | string | Descrição do estorno realizado | | `reversal_type`* | string | Tipo de estorno a ser enviado | | `reference_date`* | string | Data de referência para o processamento do estorno | | `source_account_key` | int | Chave única identificadora da conta de origem do estorno | | `source_account` | **[Account](#account)** | Objeto de conta de origem do estorno | | `transaction_key`* | string | Chave única identificadora da transferência a estornar no sistema de caixa | | `reference_key` | string | Chave de referencia da transferência a estornar no banco de origem | | `conciliation_field` | string | Campo para conciliação em múltiplas expectativas | | `end_to_end_id` | string | Identificador do pix a estornar | | `external_key` | string | Chave única da transação a estornar no banco de origem | | `bank_slip_settlement_group_key` | string | Chave única da liquidação de boleto a estornar no banco de origem | :::caution **Atenção** O Campos `source_account_key` e `source_account` são campos identificadores da origem do valor a ser estornado. Devem ser enviados **1 campo de cada**, caso sejam enviados múltiplos, retornará erro 400. ::: ### Account | Campo | Tipo | Descrição | Caracteres | |-----------------------------|---------------------------------------------------|-------------------------------------|------------| | `account_number` | string | Número da conta | Até 50 | | `account_digit` | string | Digito da conta | 1 | | `account_branch` | string | Agência da conta | Até 4 | | `financial_institution` | **[Finacial Institution](#finacial_institution)** | Objeto de instituição financeira | - | | `owner` | **[Owner](#owner)** | Objeto de proprietário | - | ### Finacial institution | Campo | Tipo | Descrição | Caracteres | |--------|--------|---------------------------------------------------|------------| | `ispb` | string | Identificador de Sistema de Pagamentos Brasileiro | 8 | | `code` | string | Código da instituição financeira | 3 | | `name` | string | Nome da instituição financeira | Até 255 | ### Owner | Campo | Tipo | Descrição | Caracteres | |-------------------|--------|---------------------------|------------| | `name` | string | Nome do proprietário | até 255 | | `document_number` | string | Documento do proprietário | 14 ou 18 | --- # Webhooks URL: /documentation/iaas/visibildade_de_caixa/webhook_transaction_reversal --- #### Liquidação concluida STATUS Settled ```json title='Webhook Body' { "data":{ "transaction_reversal_key": "b6da1a84-5bb3-4d71-9912-cbbcfe7189c1", "amount": 123.45, "status": "paid", "description": "Valor de liquidação indevido", "reference_date": "2025-03-23", "fund_class_document_number": "12.345.678/0009-10", "fund_class_key": "0619574f-2815-419d-8208-630b0dc30487", "source_account": { "account_digit": "7", "account_branch": "0001", "account_number": "0099999", "owner": { "name": "FUNDO DE INVESTIMENTO", "document_number": "12.345.678/0009-10" }, "financial_institution": { "code": "329", "ispb": "32402502", "name": "QI Sociedade de Crédito Direto" }, }, "target_account":{ "owner": { "name": "Nome fictício", "document_number": "111.202.188-99" }, "account_digit": "0", "account_branch": "0001", "account_number": "1029490", "target_pix_key": "1232221", "financial_institution": { "code": "033", "ispb": "90400888", "name": "BCO SANTANDER (BRASIL) S.A." } }, "external_key":"40054daa-c3c5-49cd-add7-858b576c5887" }, "webhook_type":"transaction_reversal.transaction_reversal_status_change", "webhook_datetime":"2025-03-23T15:08:30Z" } ```