Criação de uma chave pix para um Alias

Request

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_key

MÉTODO

POST

Request Body - Chave do tipo 'random_key'

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

Request Body - Chave do tipo CPF

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

Request Path Params

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

Request Body Params

Campo	Tipo	Descrição	Max. Caracteres
request_control_key *	string	UUID4 para fins de consulta sobre a requisição feita.	36
pix_key_type *	string	Definição do tipo de chave que será criada. Valores possíveis: 'cpf', 'cnpj', 'email', 'phone_number', 'random_key'	10
pix_key	string	Valor da chave Pix a ser criado. Não deve ser enviado para casos de chave do tipo 'random_key'.	10

Tipos de Chave Pix

A pix_key enviada na requisição pode ser um CPF, CNPJ, E-mail ou celular, seguindo as seguintes formatações:

CPF: Número inteiro com 11 dígitos.

CNPJ: Número inteiro com 14 dígitos.

E-mail: Texto contendo ao menos um “@”.

Celular: Texto contendo os seguintes valores: “+55” + “DDD do celular“ + “Número Inteiro do Celular com no mínimo 8 e no máximo 9 dígitos”. 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

Campo	Tipo	Descrição	Max. Caracteres
pix_key	string	Valor da chave Pix criada.	200
pix_key_status	string	Status de ativação da chave Pix. Pode ser "active","inactive" ou "pending"	8
created_at	datetime Zulu	Data de criação da requisição.	20

Tipos de Chave Pix

A pix_key enviada na resposta da requisição pode ser um CPF, CNPJ, E-mail, celular ou chave aleatória, seguindo as seguintes formatações:

CPF: Número inteiro com 11 dígitos.

CNPJ: Número inteiro com 14 dígitos.

E-mail: Texto contendo ao menos um “@”.

Celular: Texto contendo os seguintes valores: “+55” + “DDD do celular“ + “Número Inteiro do Celular com no mínimo 8 e no máximo 9 dígitos”. Ex: “+5511987654321“.

Chave aleatória: UUIDV4.

STATUS

4XX

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

Código HTTP	Código QI code	Título title	Descrição (eng) Description	Descrição (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