Retrieving Account Information

---

Request

ENDPOINT

/cash_account/fund_class/FUND_CLASS_KEY/accounts

METHOD

GET

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,
         "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

Field	Type	Description
data	array	List of Account objects
limit	int	Limit of objects retrieved per page
page	int	Number of the retrieved page
is_last_page	boolean	Information indicating if the retrieved page is the last

Account

Field	Type	Description	Characters
account_key	string	Unique identifier key of the account in the system	36
account_type	string	Account type	Up to 50
financial_institution	JSON	Financial institution object	-
account_status	string	Account status	Up to 50
account_number	string	Account number	Up to 50
account_digit	string	Account digit	1
account_branch	string	Account branch	Up to 50
accounting_identification	int	Account ordinal identifier	-
balance	int	Account balance at the moment	-
owner	JSON	Owner object	-
owner_document_number	string	Owner's document	14 or 18

Attention

The balance is provided by concatenating reais and cents e.g.: 1234 = R$ 12.34

Financial institution

Field	Type	Description	Characters
ispb	string	Brazilian Payment System Identifier	8
code	string	Financial institution code	3
name	string	Financial institution name	Up to 255

Owner

Field	Type	Description	Characters
name	string	Owner's name	up to 255
document_number	string	Owner's document	14 or 18