Pix Keys listing for an Alias

Request

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_key

METHOD

GET

Path Params

Field	Type	Description	Characters
account_key	string	Unique account key.	36
alias_key	string	Unique alias key.	36

Pix Key Types

The “pix_key” is of the type Random Key (UUID4), following this format: Random Key: UUID4.

Query Params

Field	Type	Description	Characters
page_number	integer	Current page being queried.	-
page_size	integer	Number of results per page.	-

Response

STATUS

200

Response Body: Key active

{
  "data": [
    {
      "pix_key": "ecdb1790-667f-42ab-b319-fbc838a04672",
      "pix_key_type": "random_key",
      "pix_key_status": "active",
      "created_at": "2021-10-22T20:30:23.459Z"
    },
    {
      "pix_key": "f5eb52c1-5247-4de3-9982-f4f0ee9edad4",
      "pix_key_type": "random_key",
      "pix_key_status": "active",
      "created_at": "2021-12-06T21:16:12.123Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "rows_per_page": 10
  }
}

Response Body Params

Field	Type	Description	Max. Characters
pix_key	string	PIX key.	77
pix_key_type	string	Type of the PIX key. Can be "random_key"	10
pix_key_status	string	Activation status of the PIX key. Can be "active", "inactive" or "pending"	8
created_at	datetime Zulu	Date of creation of the request.	20

STATUS

4XX

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "description in portuguese",
  "code": "codigo",
  "extra_fields": {}
}

HTTP Code	QI Code code	Title title	Description (eng) Description	Description (ptbr) translation
403	PIX000080	Not enough permission	The selected agent is not an Pix Indirect Participant	O agente selecionado não é um Participante Indireto do Pix
404	PIX000082	Alias not found	Alias {alias_key} not found	Alias {alias_key} não encontrado
400	PIX000088	Page size too large	Requested page size above limit of {max_page_size}	Tamanho de página requerido acima do limite de {max_page_size}
400	PIX000089	Invalid value for params	Page Size and Page Number must be integers	age Size e Page Number devem ser números inteiros