查询账户

Request

ENDPOINT

/account/ACCOUNT_KEY

MÉTODO

GET

Path Params

字段	类型	描述
ACCOUNT_KEY	UUID	需要查询的账户密钥

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

字段	类型	描述	最大字符数
account_key	uuid	账户唯一标识符。	36
account_branch	string	机构号，不含检验位。	4
account_digit	string	账户检验位。	1
account_number	string	账户号，不含检验位。	20
account_type	string	账户类型定义。	20
account_status	string	账户状态。	account_status 枚举值
owner_document_number	string	CPF 或 CNPJ 号码。	14
owner_name	string	账户所有人姓名。	120
balance	double	账户余额。	120
blocked_balance	double	账户冻结余额。	120
owner_person_key	string	账户所有人唯一标识符。	36
account_documents	ARRAY	账户唯一标识符数组。	-
created_at	datetime Zulu	请求创建日期。	20

account_status 枚举值

枚举值	描述
opened	账户已开立
closed	账户已关闭
blocked	账户已冻结

STATUS

404

Response Body: 用户无凭证

{
    "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: 用户无凭证

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