Creating a PIX key for an Alias

Request

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_key

METHOD

POST

Request Body - 'random_key' type key

{
  "request_control_key": "3d3d0083-ac71-46f0-8a90-c00a157a4893",
  "pix_key_type": "random_key"
}

Request Body - CPF type key

{
  "request_control_key": "3d3d0083-ac71-46f0-8a90-c00a157a4893",
  "pix_key_type": "cpf",
  "pix_key": "67824450007"
}

Request Path Params

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

Request Body Params

Field	Type	Description	Max. Characters
request_control_key *	string	UUID4 for querying purposes about the made request.	36
pix_key_type *	string	Definition of the type of key to be created. Possible values: 'cpf', 'cnpj', 'email', 'phone_number', 'random_key'	10
pix_key	string	PIX key value to be created. Should not be sent for 'random_key' type cases.	10

PIX Key Types

The pix_key sent in the request can be a CPF, CNPJ, email or mobile phone, following these formats:

CPF: Integer number with 11 digits.

CNPJ: Integer number with 14 digits.

Email: Text containing at least one "@".

Mobile phone: Text containing the following values: "+55" + "mobile area code" + "Mobile phone integer number with minimum 8 and maximum 9 digits". Ex: "+5511987654321".

Response

STATUS

200

Response Body

{
  "pix_key": "asra-4cd6-4c04-9651-1c0a2c30d7dd",
  "pix_key_status": "active",
  "created_at": "2021-12-06T21:16:11.001Z",
  "pix_key_type": "random_key"
}

Response Body Params

Field	Type	Description	Max. Characters
pix_key	string	Created PIX key value.	200
pix_key_status	string	PIX key activation status. Can be "active","inactive" or "pending"	8
created_at	datetime Zulu	Request creation date.	20

PIX Key Types

The pix_key sent in the request response can be a CPF, CNPJ, email, mobile phone or random key, following these formats:

CPF: Integer number with 11 digits.

CNPJ: Integer number with 14 digits.

Email: Text containing at least one "@".

Mobile phone: Text containing the following values: "+55" + "mobile area code" + "Mobile phone integer number with minimum 8 and maximum 9 digits". Ex: "+5511987654321".

Random key: UUIDV4.

STATUS

4XX

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "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