Completando o pedido de reivindicação

Depois que a requisição de reivindicação de portabilidade ou posse de chave é enviada, a instituição que a recebeu dará um retorno ao Bankly, confirmando ou não a doação da chave.

Caso o parceiro tenha reivindicado a portabilidade de uma chave, o pedido sempre será completado automaticamente após a confirmação do recebimento por parte da instituição doadora.

Porém, se o parceiro reivindicou a posse de uma chave, ele deverá completar o pedido por meio do endpoint a seguir.

Pré-requisitos

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

• A reivindicação de posse apresente o status CONFIRMED. O status pode ser verificado por meio do endpoint Consulta dos pedidos de reivindicação;
• O parceiro possua o hash gerado na criação do código TOTP (em caso de reivindicação de chaves do tipo e-mail e telefone).

Requisição (Request)

Requisição HTTP

PATCH https://api-mtls.sandbox.bankly.com.br/pix/claims/{claimId}/complete

--request PATCH \
--url 'https://api-mtls.sandbox.bankly.com.br/pix/claims/{{claimId}}/complete' \ 
--header 'api-version: 1' \ 
--header 'x-bkly-pix-user-id: {{documentNumber}}' \ 
--header 'x-bkly-transactional-hash: {{hash}}' \ 
--header 'Accept: application/json' \ 
--header 'Authorization: Bearer {{token}}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Cabeçalhos (Headers)

❗️

Atenção

Somente será possível completar o pedido de posse de chaves do tipo e-mail e telefone após a validação da identidade do cliente via código TOTP.

Parâmetros da rota (Path)

No path desta requisição envie o seguinte campo:

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará que o pedido foi completado com sucesso.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

{
    "claimId": "265a48f8-8cb3-4cf4-9170-c65fd83fccc3",
    "type": "OWNERSHIP",
    "addressingKey": {
        "type": "PHONE",
        "value": "+5523415162342"
    },
    "claimer": {
        "branch": "0001",
        "number": "15164",
        "bank": {
            "ispb": "13140088"
        }
    },
    "donor": {
        "branch": "1",
        "number": "540108",
        "bank": {
            "ispb": "13140088"
        }
    },
    "status": "COMPLETED",
    "previousStatus": "CONFIRMED",
    "confirmReason": "DONOR_REQUEST",
    "confirmedBy": "DONOR",
    "createdAt": "2023-05-22T19:48:06.921+00:00",
    "updatedAt": "2023-05-22T20:00:35.8177484Z",
    "resolutionLimitDate": "2023-05-29T19:47:00+00:00",
    "conclusionLimitDate": "2023-06-05T19:47:00+00:00",
    "confirmedAt": "2023-05-22T19:54:06.18+00:00",
    "completedAt": "2023-05-22T20:00:35.8177483Z"
}

Possíveis status

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são: