Consulta de uma entidade Alias

Consulta de uma entidade Alias, ja cadastrada para uma conta existente.

Request

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY

MÉTODO

GET

Path Params

Campo	Tipo	Descrição	Caracteres
account_key	uuidv4	Chave única da conta.	36
alias_key	uuidv4	Chave única do alias.	36

Response

STATUS

200

Response Body

{
  "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"
}

Response Body Params

Campo	Tipo	Descrição	Max. Caracteres
alias_key	string	Chave única do alias	36
ispb	string	Ispb da instituição financeira vinculada ao Alias	36
account_branch	string	Agência, sem o dígito verificador	4
account_number	string	Número de conta, sem o dígito verificador	20
account_digit	string	Dígito verificador da conta	1
account_type	enumerador	Tipo da conta	Enumerador account_type
account_created_at	string	Data de criação da conta	20
owner_document_number	string	Numero de CPF ou CNPJ	14
owner_name	string	Nome do dono da conta	120
owner_trading_name	string	Nome fantasia do dono da conta (somente para CNPJ)	100
created_at	string	Data de criação da requisição	20

Enumerador account_type

Enumerador	Descrição
checking_account	Conta Corrente
salary_account	Conta Salário
saving_account	Conta Poupança
payment_account	Conta de Pagamentos

STATUS

404

Response Body: Not Found

{
  "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"
}

Response Body: Not found

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