Pular para o conteúdo principal

Recuperando Informações da Conta


Request

ENDPOINT
/cash_account/fund_class/FUND_CLASS_KEY/accounts
MÉTODO
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

CampoTipoDescrição
dataarrayLista de objetos de Account
limitintLimite de objetos recuperados por página
pageintNúmero da página recuperada
is_last_pagebooleanInformação que indica se a página recuperada é a última

Account

CampoTipoDescriçãoCaracteres
account_keystringChave única identificadora da conta no sistema36
account_typestringTipo de contaAté 50
financial_institutionJSONObjeto de instituição financeira-
account_statusstringStatus da contaAté 50
account_numberstringNúmero da contaAté 50
account_digitstringDigito da conta1
account_branchstringAgência da contaAté 50
accounting_identificationintIdentificador ordinal da conta-
balanceintSaldo da conta no momento-
ownerJSONObjeto de proprietário-
owner_document_numberstringDocumento do proprietário14 ou 18
Atenção

O saldo é disponibilizado concatenando reais e centavos ex.: 1234 = R$ 12,34

Finacial institution

CampoTipoDescriçãoCaracteres
ispbstringIdentificador de Sistema de Pagamentos Brasileiro8
codestringCódigo da instituição financeira3
namestringNome da instituição financeiraAté 255

Owner

CampoTipoDescriçãoCaracteres
namestringNome do proprietárioaté 255
document_numberstringDocumento do proprietário14 ou 18