Recuperando Informações da Conta

Lista as contas do fundo, com saldo, status e os tipos de transferência que cada uma aceita.

Disponível em

Perfil	Host	Permissão exigida
Gestora	manager-api	Leitura
Consultoria	consultant-api	Ler contas

URL base de cada host: Ambientes (Hosts).

Request

ENDPOINT

/cash_account/fund_class/FUND_CLASS_KEY/accounts

MÉTODO

GET

Query Params

Campo	Tipo	Descrição
limit	int	Itens por página. Padrão: 10. Máximo: 50.
page	int	Número da página (começando por zero). Padrão: 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

Campo	Tipo	Descrição
data	array	Lista de objetos de 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
blocked_balance	int	Saldo bloqueado, em centavos	-
account_configuration	JSON	Funcionalidades habilitadas na conta: pix, wire_transfer (TED) e statement (extrato), cada uma true/false	-
billings	array	Tarifas da conta. Nesta listagem vem sempre vazia	-
authorized_agents	JSON	Agentes autorizados a operar a conta. Presente quando houver	-

Atenção

O saldo é disponibilizado em centavos, ex.: 1234 = R$ 12,34.

Financial 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

Erros

Status	Código	Quando acontece
404	CSH000005	A fund_class_key não existe.
403	CSH000048	O fundo não pertence ao seu perfil.

Erros de autenticação, permissão e host: veja Erros da API.