Cadastrar uma Chave Pix

Cadastrar uma chave Pix para uma conta

Essa funcionalidade permite que os clientes da Celcoin consigam criar uma chave Pix para conta de seus clientes.

📘
GLOSSÁRIO
EVP = Chave Aleatória
CPF = Chave CPF
CNPJ = Chave CNPJ
EMAIL = Chave Email
PHONE = Chave Telefone

Passos para Integrar

Realizar autenticação na API - [API Reference]
Criar Chave PIX - [API Reference]

Criar chave Pix [API Reference]

JSON de exemplo Chave EVP

{
  "account": "300000001",
  "keyType": "EVP"
}

*JSON de exemplo demais chaves

{
  "account": "300000001",
  "keyType": "EMAIL",
"key": "[email protected]"
}

{
  "account": "300000001",
  "keyType": "PHONE",
"key": "+5511999999999"
}

{
  "account": "300000001",
  "keyType": "CPF",
"key": "99999999999"
}

{
  "account": "300000001",
  "keyType": "CNPJ",
"key": "99999999999999"
}

Campo	Descrição	Regra
account	Numero da conta titular da chave Pix
keyType	Tipo da chave que deseja cadastrar
key	Valor da chave que deseja cadastrar.	Não enviar quando keyType for: EVP

⚠️
Atenção
Após criar uma chave Pix, é necessário aguardar 10 minutos antes de registrar uma segunda chave do mesmo tipo para a mesma conta.

cURL da chamada

curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/baas/v2/pix/dict/entry' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "account": "30054065518",
    "keyType": "EVP"
}'

Exemplo de retorno

👍
Sucesso 200

{
  "version": "1.0.0",
  "status": "CONFIRMED",
  "body": {
    "keyType": "EMAIL",
    "key": "[email protected]",
    "account": {
      "participant": "30306294",
      "branch": "0001",
      "account": "10545584",
      "accountType": "TRAN",
      "createDate": "2020-11-03T06:30:00-03:00"
    },
    "owner": {
      "type": "NATURAL_PERSON",
      "documentNumber": "34335125070",
      "name": "Carlos Henrique da Silva"
    }
  }
}

❗
Error 400

{
  "version": "1.0.0",
  "status": "ERROR",
  "error": {
    "errorCode": "CBE178",
    "message": "Quando keyType igual a EVP o campo key não deve ser informado."
  }
}

Tabela de errorCode

Code	Message
CBE091	É necessário informar o campo: account.
CBE039	Account invalido.
CBE041	Account possui tamanho maximo de 20 caracteres
CBE173	keyType é obrigatório e deve ser: CPF, CNPJ, EMAIL, PHONE, ou EVP
CBE174	O Campo key não pode ultrapassar 77 caracteres
CBE175	Cadastro de chave não permitido. Verifique o formato da chave informada
CBE176	Operação não permitida. Conta esta encerrada
CBE177	Operação não permitida. Conta esta bloqueada
CBE178	Quando keyType igual a EVP o campo key não deve ser informado.
CBE181	Não é permitido cadastrar chave CPF/CNPJ com o numero do documento diferente do titular.
CBE187	Limite excedido de chave Pix. É permitido 5 chaves para contas PF.
CBE188	Limite excedido de chave Pix. É permitido 20 chaves para contas PJ.
CBE226	Parâmetros fornecidos inválidos.
CBE223	Atingiu o limite de requisições em um espaço curto de tempo durante a chamada da api. Tente novamente mais tarde.
CBE227	Limite excedido de chave Pix
CBE228	Já existe registro para a chave informada.
CBE229	Cadastro de chave não permitido.
CBE230	Cadastro de chave não permitido. Essa chave já pertence a outra pessoa.
CBE231	Cadastro de chave não permitido. Existe um processo de reinvidicação em aberto para a mesma.
CBE232	A chave fornecida deve ser de um tipo válido.
CBE233	Nome do responsavel da chave invalido. Verifique nome cadastrado na conta.
CBE234	Não foi possivel realizar essa operação. Tente novamente mais tarde.
CBE236	Chave já cadastrada para o mesmo participante.
CBE410	Não foi possível realizar essa operação.

Updated 10 days ago