Consultar conta

Request

ENDPOINT

/account/ACCOUNT_KEY

MÉTODO

GET

PATH PARAMS

Campo	Tipo	Descrição
ACCOUNT_KEY	UUID	Chave da conta a ser detalhada

Response

Response Body

{
    "account_branch": "0001",
    "account_digit": "5",
    "account_documents": ["1e4b8746-da58-4799-bcd0-063326428ssd"],
    "account_key": "3e4b8746-da58-4799-bcd0-063326428d3f",
    "account_number": "5960388",
    "account_status": "opened",
    "account_type": "checking",
    "balance": 264.76,
    "blocked_balance": 0,
    "owner_document_number": "30987145223",
    "owner_name": "Maria Luiza Vieira",
    "owner_person_key": "47d08366-a8ec-414c-a0a5-a089fc8a4ee8",
    "created_at": "2023-05-15T19:56:10"
}

Body params

Campo	Tipo	Descrição	Max. Caracteres
account_key	uuid	Identificador único da conta.	36
account_branch	string	Agência, sem o dígito verificador.	4
account_digit	string	Dígito verificador da conta.	1
account_number	string	Número de conta, sem o dígito verificador.	20
account_type	string	Definição do tipo de conta.	20
account_status	string	Status da conta.	Enumeradores account_status
owner_document_number	string	Numero de CPF ou CNPJ.	14
owner_name	string	Nome do dono da conta.	120
balance	double	Saldo da conta.	120
blocked_balance	double	Saldo bloqueado da conta.	120
owner_person_key	string	Identificador único da pessoa dona da conta.	36
account_documents	ARRAY	Array de identificadores únicos da conta.	-
created_at	datetime Zulu	Data de criação da requisição.	20

Enumeradores account_status

Enumerador	Descrição
opened	Conta aberta
closed	Conta encerrada
blocked	Conta bloqueada

STATUS

404

Response Body: Usuário não possui credenciais

{
    "title": "Not Found",
    "description": "Account not found for the given key 3e4b8746-da58-4799-bcd0-063326428d3f",
    "translation": "Conta não encontrada para a seguinte chave 3e4b8746-da58-4799-bcd0-063326428d3f",
    "code": "ACC000006"
}

STATUS

403

Response Body: Usuário não possui credenciais

{
    "title": "Permission Validator Error",
    "description": "Selected agent do not own this item.",
    "translation": "O agente selecionado não é dono do item.",
    "code": "QIT000005"
}