DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Solicitar Portabilidade de Chave Pix

Suggest Edits

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;

Passos para Integrar

  1. Realizar autenticação na API - [API Reference]
  2. Solicitar Portabilidade ou Reivindicação [API Reference]
  3. Receber o Webhook com Status "Open" (Solicitação Aberta)
  4. Receber o Webhook com o Status "Waiting" (Aguardando Resolução)
  5. Após a outra instituição responder podemos receber 2 respostas:
    1. Receber Webhook com o Status "Confirmed" (Portabilidade Aceita)
    2. Receber Webhook com o Status "Cancelled" (Portabilidade Cancelada)
  6. Receber o Webhook com o Status "Completed" (Processo encerrado)

Fluxo de Integração

Fluxo de Webhook

EtapaNome WebhookDescrição
1.pix-dict-claim-openAberto processo de Portabilidade ou Reivindicação
2.pix-dict-claim-waitingAguardando resposta do processo de Portabilidade ou Reivindicação
3.pix-dict-claim-confirmed
ou
pix-dict-claim-cancelled		Processo de Portabilidade ou Reivindicação realizado com Sucesso ou Cancelado
4.pix-dict-claim-completedProcesso de Portabilidade ou Reivindicação Concluído

Descrição dos campos

CampoDescriçãoTipo Campo
keyChave que deseja realizar a reivindicação/portabilidade Formatos:
keyTypeTipo da chaveCPF
CNPJ
EMAIL
PHONE
accountNúmero da conta que ira realizar a solicitação de portabilidade ou reivindicação de chave
claimTypeTipo de operação1-PORTABILITY - Portabilidade de chave entre contas do mesmo titular, sendo permitido realizar a portabilidade para os seguintes tipos de chave:

CPF
CNPJ
EMAIL
PHONE

2-OWNERSHIP - Reivindicação de chave entre contas de diferentes titularidades, sendo permitido realizar a reivindicação para os seguintes tipos de chaves:

EMAIL
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

CodeMessage
CBE091É necessário informar o campo: account.
CBE039Account invalido.
CBE041Account possui tamanho máximo de 20 caracteres
CBE173keyType é obrigatório e deve ser: CPF, CNPJ, EMAIL, PHONE
CBE174O Campo key não pode ultrapassar 77 caracteres
CBE175Chave invalida. Verifique o formato da chave informada.
CBE176Operação não permitida. Conta esta encerrada
CBE177Operação não permitida. Conta esta bloqueada
CBE179É necessário informar o campo: key
CBE181Não é permitido cadastrar chave CPF/CNPJ com o numero do documento diferente do titular.
CBE226Parâmetros fornecidos inválidos.
CBE223Atingiu o limite de requisições em um espaço curto de tempo durante a chamada da api. Tente novamente mais tarde.
CBE224Formato do JSON esta fora do padrão. Verifique a documentação.
CBE232A chave fornecida deve ser de um tipo válido.
CBE234Não foi possível realizar essa operação. Tente novamente mais tarde.
CBE286Não é permitido realizar pedido de Claim para chave EVP
CBE287Não é permitido realizar pedido de Claim para chave CPF/CNPJ
CBE290A chave já possui uma solicitação de reivindicação ativa.
CBE293Já existe uma solicitação de portabilidade para essa chave
CBE295Não é possível solicitar uma portabilidade para uma chave que pertence a outra pessoa.
CBE346O campo ClaimType é obrigatório.
CBE349O valor do claimType não é válido. O claimType deve ser 'OWNERSHIP' ou 'PORTABILITY'.
CBE345Cadastro com pendencias no KYC, favor verificar.

Updated 5 months ago