Solicitar Portabilidade de Chave Pix
O endpoint de Solicitação de portabilidade de chaves Pix permite que os clientes de nossos parceiros, possam solicitar, junto a outras instituições, a portabilidade de uma chave para que ela seja cadastrada na Celcoin;
Exemplo de caso de uso:
Seu cliente possui uma Chave Pix na Instituição X e deseja transferir essa chave para a Celcoin, você precisa realizar essa chamada.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O Cliente possua uma conta ativa no BaaS;
- Possua a chave Pix cadastrada em outra instituição;
Fluxo de Integração CONFIRMED
Importante
O status confirmed é um status transitório, para garantir que a portabilidade foi concluída por segurança vale olhar apenas para o status completed
Fluxo de CONFIRMED
Etapa | Nome Webhook | Descrição |
---|---|---|
1. | pix-dict-claim-open | Aberto processo de Portabilidade ou Reivindicação |
2. | pix-dict-claim-waiting | Aguardando resposta do processo de Portabilidade ou Reivindicação |
3. | pix-dict-claim-confirmed | Processo de Portabilidade ou Reivindicação realizado com Sucesso |
4. | pix-dict-claim-completed | Processo de Portabilidade ou Reivindicação Concluído |
Fluxo de Integração CANCELLED
Fluxo de CANCELLED
Etapa | Nome Webhook | Descrição |
---|---|---|
1. | pix-dict-claim-open | Aberto processo de Portabilidade ou Reivindicação |
2. | pix-dict-claim-waiting | Aguardando resposta do processo de Portabilidade ou Reivindicação |
3. | pix-dict-claim-cancelled | Processo de Portabilidade ou Reivindicação Cancelado |
Descrição dos campos
Campo | Descrição | Tipo Campo |
---|---|---|
key | Chave que deseja realizar a reivindicação/portabilidade Formatos: | |
keyType | Tipo da chave | CPF CNPJ PHONE |
account | Número da conta que ira realizar a solicitação de portabilidade ou reivindicação de chave | |
claimType | Tipo de operação | 1-PORTABILITY - Portabilidade de chave entre contas do mesmo titular, sendo permitido realizar a portabilidade para os seguintes tipos de chave: CPF CNPJ PHONE 2-OWNERSHIP - Reivindicação de chave entre contas de diferentes titularidades, sendo permitido realizar a reivindicação para os seguintes tipos de chaves: PHONE |
Solicitar Portabilidade ou Reivindicação
Essa funcionalidade deve utilizada para solicitar uma portabilidade ou reivindicação de uma chave Pix, cadastrada em outra instituição para uma conta BaaS Celcoin
JSON de exemplo
{
"key": "[email protected]",
"keyType": "Email",
"account": "30053913742139",
"claimType": "PORTABILITY"
}
cURL da chamada
curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/celcoin-baas-pix-dict-webservice/v1/pix/dict/claim' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"key": "[email protected]",
"keyType": "Email",
"account": "30053913742139",
"claimType": "PORTABILITY"
}'
Exemplo de retorno
Sucesso 200
{
"version": "1.0.0",
"status": "OPEN",
"body": {
"id": "8bbc0ba5-2aee-44a0-a3c9-b897802a9f66",
"claimType": "OWNERSHIP",
"key": "[email protected]",
"keyType": "EMAIL",
"claimerAccount": {
"participant": "30306294",
"branch": "0001",
"account": "30053913742139",
"accountType": "TRAN"
},
"claimer": {
"personType": "NATURAL_PERSON",
"taxId": "34335125070",
"name": "João da Silva Junior"
},
"donorParticipant": "30306294",
"createTimestamp": "2023-05-01T13:05:09",
"completionPeriodEnd": "2023-05-01T13:05:09",
"resolutionPeriodEnd": "2023-05-01T13:05:09",
"lastModified": "2023-05-01T13:05:09",
"confirmReason": "USER_REQUESTED",
"cancelReason": "FRAUD",
"cancelledBy": "DONOR",
"donorAccount": {
"account": "30053913742139",
"branch": "0001",
"taxId": "34335125070",
"name": "João da Silva"
}
}
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CBE039",
"message": "Account invalido.."
}
}
Tabela de errorCode
Code | Message |
---|---|
CBE091 | É necessário informar o campo: account. |
CBE039 | Account invalido. |
CBE041 | Account possui tamanho máximo de 20 caracteres |
CBE173 | keyType é obrigatório e deve ser: CPF, CNPJ, EMAIL, PHONE |
CBE174 | O Campo key não pode ultrapassar 77 caracteres |
CBE175 | Chave invalida. Verifique o formato da chave informada. |
CBE176 | Operação não permitida. Conta esta encerrada |
CBE177 | Operação não permitida. Conta esta bloqueada |
CBE179 | É necessário informar o campo: key |
CBE181 | Não é permitido cadastrar chave CPF/CNPJ com o numero do documento diferente do titular. |
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. |
CBE224 | Formato do JSON esta fora do padrão. Verifique a documentação. |
CBE232 | A chave fornecida deve ser de um tipo válido. |
CBE234 | Não foi possível realizar essa operação. Tente novamente mais tarde. |
CBE286 | Não é permitido realizar pedido de Claim para chave EVP |
CBE287 | Não é permitido realizar pedido de Claim para chave CPF/CNPJ |
CBE290 | A chave já possui uma solicitação de reivindicação ativa. |
CBE293 | Já existe uma solicitação de portabilidade para essa chave |
CBE295 | Não é possível solicitar uma portabilidade para uma chave que pertence a outra pessoa. |
CBE346 | O campo ClaimType é obrigatório. |
CBE349 | O valor do claimType não é válido. O claimType deve ser 'OWNERSHIP' ou 'PORTABILITY'. |
CBE345 | Cadastro com pendencias no KYC, favor verificar. |
Updated 3 months ago