Responder Portabilidade de Chave Pix

O endpoint de responder solicitações de portabilidade de chaves Pix permite que os nossos clientes aceitem ou recusem portabilidade de outras instituições parceiros, cabe a nossos clientes mostrar a solicitação para que o usuário final aceite ou não o pedido;

Exemplo de caso de uso:
Seu cliente possui uma Chave Pix na Celcoin e deseja transferir essa chave para a uma instituição X, você precisa aceitar e responder essas solicitações

Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:

O Cliente possua uma conta ativa no BaaS;
Possua uma processo de portabilidade em andamento

Fluxo de Integração CONFIRMED

Fluxo de status de uma solicitação 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 status de uma solicitação 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
id	Numero de Identificação único também conhecido como Id/ClaimId que retorna na criação da reivindicação/portabilidade
reason	Motivo da solicitação Opcional por default é USER_REQUESTED	USER_REQUESTED ACCOUNT_CLOSURE FRAUD DEFAULT_OPERATION

Descrição - Motivos da solicitação

Reason	Descrição
USER_REQUESTED	Requisição feita pelo usuário
ACCOUNT_CLOSURE	Requisição feita pelo sistema por motivo de Encerramento de Conta
FRAUD	Requisição feita pelo Sistema por motivo de Fraude. Exclusivamente usado quando usuário cancela durante período de Resolução ultrapassado em uma Posse.
DEFAULT_OPERATION	Requisição feita pelo Sistema quando período de Resolução ultrapassou a data limite.

Matriz de respostas para Cancelamento

Motivo	Resposta reivindicação	Solicitação reivindicação	Resposta portabilidade	Solicitação portabilidade
USER_REQUESTED		X	X	X
ACCOUNT_CLOSURE		X		X
FRAUD	X	X	X	X
DEFAULT_OPERATION			X

CONFIRMAR Portabilidade ou Reivindicação

Essa funcionalidade deve utilizada para confirmar uma portabilidade ou reivindicação de uma chave Pix.

JSON de exemplo

{
  "id": "e1cd2879-e16f-491f-b4cb-525555b42884",
  "reason": "USER_REQUESTED"
}

cURL da chamada

curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/baas/v2/pix/dict/claim/confirm' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "id": "e1cd2879-e16f-491f-b4cb-525555b42884",
  "reason": "USER_REQUESTED"
}'

Exemplo de retorno

👍
Sucesso 200

{
  "version": "1.0.0",
  "status": "CONFIRMED",
  "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-08-10T17",
    "lastModified": "2023-08-11T17:11:33"
  }
}

❗
Error 400

{
  "version": "1.0.0",
  "status": "ERROR",
  "error": {
    "errorCode": "CBE306",
    "message": "Não foi possível confirmar essa Claim, pois a mesma não está mais pendente."
  }
}

Tabela de errorCode

Code	Message
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.
CBE234	Não foi possível realizar essa operação. Tente novamente mais tarde.
CBE301	Reason fornecido inválido.
CBE306	Não foi possível confirmar essa Claim, pois a mesma não está mais pendente.
CBE320	Claim não encontrada.
CBE348	Operação não permitida. Conta esta bloqueada

CANCELAR Portabilidade ou Reivindicação

Essa funcionalidade deve utilizada para cancelar um pedido de portabilidade ou reivindicação de uma chave Pix, que estiver no status de OPEN ou AWAITING.