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] (https://developers.celcoin.com.br/docs/cadastrar-uma-chave-pix)]
JSON de exemplo Chave EVP
{
"account": "444444",
"keyType": "EVP"
}
JSON de exemplo demais chaves
{
"account": "444444",
"keyType": "EMAIL",
"key": "[email protected]"
}
| 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 |
cURL da chamada
curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/celcoin-baas-pix-dict-webservice/v1/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 pelo menos um dos campos: id, clientCode, ou endtoendId. |
| 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. |
| CBE197 | Tipo de chave não permitido. |
Updated 23 days ago