获取账户信息

列出基金的账户，包括余额、状态以及每个账户支持的转账类型。

适用范围

角色	主机	所需权限
管理人	manager-api	读取
顾问	consultant-api	View accounts

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

Request

ENDPOINT

/cash_account/fund_class/FUND_CLASS_KEY/accounts

MÉTODO

GET

Query Params

字段	类型	描述
limit	int	每页条目数。默认：10。最大：50。
page	int	页码（从零开始）。默认：0。

Response

STATUS

200

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,
         "blocked_balance":0,
         "owner":{
            "name":"FUNDO DE INVESTIMENTO EM DIREITOS CREDITORIOS",
            "document_number":"11.222.333/0001-81"
         },
         "owner_document_number":"11.222.333/0001-81",
         "account_configuration":{
            "pix":true,
            "wire_transfer":true,
            "statement":true
         },
         "billings":[]
      },
      {
         "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,
         "blocked_balance":0,
         "owner":{
            "name":"FUNDO DE INVESTIMENTO EM DIREITOS CREDITORIOS",
            "document_number":"11.222.333/0001-81"
         },
         "owner_document_number":"11.222.333/0001-81",
         "account_configuration":{
            "pix":true,
            "wire_transfer":true,
            "statement":true
         },
         "billings":[]
      }
   ],
   "limit":10,
   "page":0,
   "is_last_page":true
}

Response Fields

字段	类型	描述
data	array	Account 对象列表
limit	int	每页获取的对象数量上限
page	int	所获取的页码
is_last_page	boolean	指示所获取的页是否为最后一页

Account

字段	类型	描述	字符数
account_key	string	账户在系统中的唯一标识 key	36
account_type	string	账户类型	最多 50
financial_institution	JSON	金融机构对象	-
account_status	string	账户状态	最多 50
account_number	string	账号	最多 50
account_digit	string	账户校验位	1
account_branch	string	账户所属分行	最多 50
accounting_identification	int	账户的序号标识	-
balance	int	账户当前余额	-
owner	JSON	账户所有人对象	-
owner_document_number	string	账户所有人的证件号	14 或 18
blocked_balance	int	冻结余额，以分为单位	-
account_configuration	JSON	账户已启用的功能：pix、wire_transfer（TED）和 statement（对账单），各为 true/false	-
billings	array	账户费用。在此列表中始终为空	-
authorized_agents	JSON	获授权操作该账户的代理方。有值时返回	-

注意

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

Financial institution

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

Owner

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

错误

状态码	代码	触发条件
404	CSH000005	该 fund_class_key 不存在。
403	CSH000048	该基金不属于您的角色。

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