DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Responder Portabilidade de Chave Pix

Suggest Edits

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

Passos para Integrar

  1. Realizar autenticação na API - [API Reference]
  2. Receber solicitações de portabilidade ou reivindicação de Chave Pix
    1. Receber via Webhook - [API Reference]
    2. Consultar via endpoint as solicitações - [API Reference]
  3. Apresentar o pedido ao cliente final
  4. Responder solicitação:
    1. Confirmar Pedido - [API Reference]
    2. Cancelar Pedido - [API Reference]

Fluxo de Integração

Fluxo de status de uma solicitação

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
idNumero de Identificação único também conhecido como Id/ClaimId que retorna na criação da reivindicação/portabilidade
reasonMotivo da solicitação Opcional por default é USER_REQUESTEDUSER_REQUESTED
ACCOUNT_CLOSURE
FRAUD
DEFAULT_OPERATION

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/celcoin-baas-pix-dict-webservice/v1/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

CodeMessage
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.
CBE234Não foi possível realizar essa operação. Tente novamente mais tarde.
CBE301Reason fornecido inválido.
CBE306Não foi possível confirmar essa Claim, pois a mesma não está mais pendente.
CBE320Claim não encontrada.
CBE348Operaçã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.

JSON de exemplo

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

cURL da chamada

curl --location --request POST 'https://sandbox.openfinance.celcoin.dev/celcoin-baas-pix-dict-webservice/v1/pix/dict/claim/cancel' \
--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": "CANCELLED",
  "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 Juniors"
    },
    "donorParticipant": "30306294",
    "createTimestamp": "2023-05-01T13:05:09",
    "completionPeriodEnd": "2023-05-01T13:05:09",
    "resolutionPeriodEnd": "2023-08-10T17",
    "lastModified": "2023-08-11T17:11:33",
    "cancelledBy": "CLAIMER",
    "cancelReason": "FRAUD"
  }
}

❗

Error 400

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

Tabela de errorCode

CodeMessage
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.
CBE234Não foi possível realizar essa operação. Tente novamente mais tarde.
CBE301Reason fornecido inválido.
CBE306Não foi possível confirmar essa Claim, pois a mesma não está mais pendente.
CBE320Claim não encontrada.
CBE348Operação não permitida. Conta esta bloqueada

Updated 5 months ago