Documentação
DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Consultar pedidos de Portabilidade ou Reivindicação

Suggest Edits

O endpoint de consulta de solicitações de portabilidade de chaves Pix permite que os nossos clientes consultem informações de uma portabilidade especifica ou uma listagem de portabilidade por status

Exemplo de caso de uso:

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

  • O Cliente possua uma conta ativa no BaaS;
  • Possua algum processo de Portabilidade ou Reivindicação em andamento;

Passos para Integrar

  1. Realizar autenticação na API - [API Reference]
  2. Consultar pedidos de Portabilidade ou Reivindicação - [API Reference]

Fluxo de Integração

Fluxo de Status

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

Consulta reivindicação/portabilidade de chave Pix

Essa funcionalidade deve utilizada para consultar o processo de reivindicação/portabilidade especifica de uma chave

cURL da chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/celcoin-baas-pix-dict-webservice/v1/pix/dict/claim/{id}' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \

Exemplo de retorno

👍

Sucesso 200

{
  "version": "1.0.0",
  "status": "SUCCESS",
  "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": "CBE320",
    "message": "Claim não encontrada."
  }
}

Tabela de errorCode

CodeMessage
CBE303É preciso informar o campo: claimId
CBE320Claim não encontrada.
CBE348O campo id está no formato incorreto. Verifique a documentação.
CBE351Não foi possível encontrar dados relacionados a Claim informada.

Consulta lista de reivindicação/portabilidade de chave Pix

Essa funcionalidade deve utilizada para consultar uma lista de reivindicação/portabilidade de chaves, através dos parâmetros você pode filtrar a busca por:

Parâmetros:

Os parâmetros são opcionais, caso você não informe nada retornaremos uma listagem com 200 resultados

ParâmetrosDescrição
DateFromData de Inicio que deseja buscar
DateToData Fim que deseja buscar
LimitPerPageLimite de resultados por página
PagePágina que deseja visualizar
StatusOPEN, WAITING_RESOLUTION, CONFIRMED, CANCELLED, COMPLETED
claimTypeOWNERSHIP, PORTABILITY

cURL da chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/celcoin-baas-pix-dict-webservice/v1/pix/dict/claim/list?DateFrom=2023-06-07&DateTo=2023-06-10&LimitPerPage=10&Page=1&Status=OPEN&claimType=OWNERSHIP' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Exemplo de retorno

👍

Sucesso 200

{
  "version": "1.0.0",
  "status": "SUCCESS",
  "body": {
    "claims": [
      {
        "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",
        "status": "OPEN",
        "createTimestamp": "2023-05-01T13:05:09",
        "completionPeriodEnd": "2023-05-01T13:05:09",
        "resolutionPeriodEnd": "2023-05-01T13:05:09",
        "lastModified": "2023-05-01T13:05:09",
        "donorAccount": {
          "account": "30053913742139",
          "branch": "0001",
          "taxId": "34335125070",
          "name": "João da Silva Junior"
        }
      }
    ]
  }
}

❗

Error 400

{
  "version": "1.0.0",
  "status": "ERROR",
  "error": {
    "errorCode": "CBE320",
    "message": "Claim não encontrada."
  }
}

Tabela de errorCode

CodeMessage

Updated 4 months ago