查询 Alias 实体

查询已为现有账户注册的 Alias 实体。

请求

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY

MÉTODO

GET

路径参数

字段	类型	描述	字符数
account_key	uuidv4	账户唯一密钥。	36
alias_key	uuidv4	Alias 唯一密钥。	36

响应

STATUS

200

响应体

{
  "alias_key": "c446e513-131c-4741-bbc2-b7e6b6282899",
  "ispb": "12345678",
  "account_branch": "0001",
  "account_number": "4968688",
  "account_digit": "3",
  "account_type": "checking_account",
  "account_created_at": "2021-10-22T20:30:23.459Z",
  "owner_person_type": "legal",
  "owner_document_number": "89248771384257",
  "owner_name": " Vinicius De Oliveira",
  "owner_trading_name": "Pix Ltda",
  "created_at": "2021-10-22T20:30:23.459Z"
}

响应体参数

字段	类型	描述	最大字符数
alias_key	string	Alias 唯一密钥。	36
ispb	string	与 Alias 关联的金融机构 ISPB。	36
account_branch	string	支行号，不含校验位。	4
account_number	string	账号，不含校验位。	20
account_digit	string	账号校验位。	1
account_type	enumerador	账户类型。	account_type 枚举值
account_created_at	string	账户创建日期。	20
owner_document_number	string	CPF 或 CNPJ 号码。	14
owner_name	string	账户所有者姓名。	120
owner_trading_name	string	账户所有者商业名称（仅限 CNPJ）。	100
created_at	string	请求创建日期。	20

account_type 枚举值

枚举值	描述
checking_account	支票账户
salary_account	工资账户
saving_account	储蓄账户
payment_account	支付账户

STATUS

404

响应体：未找到

{
  "title": "Not Found", 
  "description": "Account not found for the given key \{account_key\}", 
  "translation": "A account_key \{account_key\} não foi encontrada",
  "extra_fields": {}, 
  "code": "ACC000006"
}

响应体：未找到

{
  "title": "Not found", 
  "description": "Alias \{alias_key\} not found", 
  "translation": "Alias \{alias_key\} não encontrado",
  "extra_fields": {}, 
  "code": "ACC000181"
}