Consultar pedidos de Portabilidade ou Reivindicação
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
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
- Realizar autenticação na API - [API Reference]
- Consultar pedidos de Portabilidade ou Reivindicação - [API Reference]
Fluxo de Integração
Fluxo de Status
| 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 ou pix-dict-claim-cancelled | Processo de Portabilidade ou Reivindicação realizado com Sucesso ou Cancelado |
| 4. | pix-dict-claim-completed | Processo 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/baas/v2/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
| Code | Message |
|---|---|
| CBE303 | É preciso informar o campo: claimId |
| CBE320 | Claim não encontrada. |
| CBE348 | O campo id está no formato incorreto. Verifique a documentação. |
| CBE351 | Nã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âmetros | Descrição |
|---|---|
| DateFrom | Data de Inicio que deseja buscar |
| DateTo | Data Fim que deseja buscar |
| LimitPerPage | Limite de resultados por página |
| Page | Página que deseja visualizar |
| Status | OPEN, WAITING_RESOLUTION, CONFIRMED, CANCELLED, COMPLETED |
| claimType | OWNERSHIP, PORTABILITY |
cURL da chamada
curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/baas/v2/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
| Code | Message |
|---|
Updated 3 days ago