跳到主要内容

获取账户交易记录

列出基金某个账户的交易记录（对账单）。这也是确认基金账户间转账的方式。

适用范围
角色主机所需权限
管理人manager-api读取
顾问consultant-apiView accounts

各主机的 Base URL：环境（主机）。

Request​

ENDPOINT
/cash_account/fund_class/FUND_CLASS_KEY/account/ACCOUNT_KEY/transactions
MÉTODO
GET
管理人和顾问

上述路由对两类代理方均适用：账户必须与 FUND_CLASS_KEY 中指定的基金关联。顾问需要在该基金中拥有由管理人授予的账户查询权限。

管理人也可以不指定基金进行查询，路由为 /cash_account/account/ACCOUNT_KEY/transactions。顾问不能使用这种方式。

Path Params​

参数描述
FUND_CLASS_KEY账户所关联基金类别的 key
ACCOUNT_KEY账户的 key，即 获取账户信息 中返回的值

Response​

STATUS
200
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": "11.222.333/0001-81"
                },
                "owner_document_number": "11.222.333/0001-81",
                "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": "11.222.333/0001-81"
                  },
                  "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": "11.222.333/0001-81"
                },
                "owner_document_number": "11.222.333/0001-81",
                "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​

字段类型描述
statusstring交易状态
start_datestring查询起始日期
end_datestring查询结束日期
counter_part_document_numberstring交易对手的证件号
limitint每页条目数。默认：10。最大：50。
pageint要获取的页码（从零开始）

Response Fields​

字段类型描述
dataarrayTransaction 对象列表
limitint每页获取的对象数量上限
pageint所获取的页码
is_last_pageboolean指示所获取的页是否为最后一页

Transaction​

字段类型描述字符数
transaction_keystring交易的唯一标识 key36
transaction_typestring交易类型最多 50
transaction_statusstring交易状态最多 50
transaction_descriptionstring银行提供的交易描述最多 255
amountbigint交易金额乘以 100（例如：R$1,00 == 100）-
transaction_datetimestring交易日期和时间ISO 8601
account_balancebigint交易后的账户余额-
transaction_dataJSON包含交易附加信息的对象-
accountJSON该交易所属账户的对象-

Account​

字段类型描述字符数
account_keystring账户的唯一标识 key36
account_typestring账户类型最多 50
financial_institutionJSON金融机构对象-
account_statusstring账户状态最多 50
account_numberstring账号最多 50
account_digitstring账户校验位1
account_branchstring账户所属分行最多 50
accounting_identificationint账户的序号标识-
balanceint账户当前余额-
ownerJSON账户所有人对象-
owner_document_numberstring账户所有人的证件号14 或 18
注意

余额以分为单位，例如：1234 = R$ 12,34。

Financial institution​

字段类型描述字符数
ispbstring巴西支付系统标识（ISPB）8
codestring金融机构代码3
namestring金融机构名称最多 255

Owner​

字段类型描述字符数
namestring账户所有人名称最多 255
document_numberstring账户所有人的证件号14 或 18

Conciliation Group​

字段类型描述字符数
descriptionstring交易对账的描述最多 255
conciliation_group_keystring对账的唯一标识 key36
conciliation_group_datetimestring对账的日期和时间ISO 8601

错误​

代码HTTP原因解决方法
CIT000018401顾问与所指定的基金没有有效关联，或在该基金中没有账户查询权限。请管理人授予该基金的权限。
CSH000048403账户未与所指定的基金关联，或该基金不属于该代理方。根据基金的账户列表，使用账户所属基金的 FUND_CLASS_KEY。
CSH000006404未找到所指定 ACCOUNT_KEY 对应的账户。检查 ACCOUNT_KEY 是否正确。

认证、权限和主机相关错误：参见 API 错误。