1 - Criar Chave Pix

Scopes:

api.pix api.chave.criar

Por meio deste endpoint, o parceiro pode registrar uma nova chave Pix, ampliando suas opções de recebimento. As opções de chave incluem: CPF/CNPJ, e-mail, número de celular ou uma chave aleatória.

Para utilizar este endpoint é necessário realizar a dupla verificação através de MFA para realizar a criação de de uma chave que utilize “e-mail” ou “telefone”

Mostrar Mensagens de requisições com erro

O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

Endpoint	Mensagem de erro
/api/v2/Chave	Código da conta não identificado na requisição. Verifique autenticação AuthCompany
/api/v2/Chave	Erro - Generico Ocorreu um erro na requisição
/api/v2/Chave	Erro SBP
/api/v2/Chave	Conta inválida
/api/v2/Chave	Agência inválida
/api/v2/Chave	Necessário informar Conta + ContaDigito ou ContaPgto
/api/v2/Chave	Conta inválida
/api/v2/Chave	Conta != Ativa
/api/v2/Chave	Operador não encontrado
/api/v2/Chave	Parceiro não autorizado para esta conta
/api/v2/Chave	É necessário informar um código de autenticação
/api/v2/Chave	É necessário informar o código mfa da autenticação
/api/v2/Chave	MFA não encontrado com este código de autenticação, solicite um novo
/api/v2/Chave	Tipo chave pix inválido para o tipo informado na solicitação de MFA
/api/v2/Chave	Tipo chave pix inválido para o tipo informado na solicitação de MFA
/api/v2/Chave	Chave inválida para o MFA solicitado
/api/v2/Chave	Este MFA não é compatível com a chave informada
/api/v2/Chave	Token inválido ou já expirou
/api/v2/Chave	Dados do correntista titular não encontrados
/api/v2/Chave	Para continuar, o telefone informado deverá constar nos dados do correntista principal
/api/v2/Chave	Para continuar, o e-mail informado deverá constar nos dados do correntista principal
/api/v2/Chave	Não foi possível identificar o correntista titular da conta
/api/v2/Chave	Correntista não permitido para esta conta
/api/v2/Chave	Não é possível criar uma chave pix para uma conta vinculada
/api/v2/Chave	Correntista não informado
/api/v2/Chave	Correntista [] não está ativo
/api/v2/Chave	Não é permitido informar o campo ‘chave’ para criar chave do tipo
/api/v2/Chave	Tipo de chave inválida. Correntista não é pessoa física
/api/v2/Chave	Tipo de chave inválida. Correntista não é pessoa jurídica
/api/v2/Chave	Chave não pode ser informada para tipo aleatória
/api/v2/Chave	Chave inválida. Telefone incorreto
/api/v2/Chave	E-mail não informado
/api/v2/Chave	E-mail não pode conter caracteres maiúsculos
/api/v2/Chave	E-mail inválido

Authorizations

Authorization · string · header · required

Copie 'Bearer ' + token

Headers

IdempotencyKey · string · required

IgnoraHandshake · boolean · default: true · required

(somente em homologação)

Body

contaDto · object

Objeto detalhado da conta bancária.*

Mostrar atributos filhos

tipoChave · enum<integer>

Tipo da chave.*

Valores: 0 - CPF 1 - CNPJ 2 - TELEFONE 3 - EMAIL 4 - EVP

Opções disponíveis:

0,

1,

2,

3,

4

chave · string | null

Chave pix a ser criada.*

codigoAutenticacao · string<uuid>

Identificador único (UUID) para validar a autenticidade da solicitação.*

codigoMfa · string | null

Código recebido para autenticaçâo multifator (MFA).*

Response

200

application/json

Success

sucesso · boolean

mensagem · string | null