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.

🚧

Importante

Para ser completada, a reivindicação de posse precisa estar com o status CONFIRMED.

Endpoint

Para utilizar o endpoint de conclusão de pedido de reivindicação, é obrigatório enviar os seguintes campos:

Path

• claimId: identificador único do pedido. Esse valor é retornado na criação de pedido de reivindicação de chave.

Header

• x-bkly-pix-user-id: número do documento do cliente que está fazendo a requisição. Insira apenas números, sem formatação;

• x-bkly-transactional-hash: o envio desse campo no header da requisição é obrigatório apenas para reivindicação de chaves do tipo e-mail e telefone. Ele deve ser preenchido com o hash gerado na criação do código TOTP;

❗️

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.

curl --location --request PATCH '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}}'

Retorno

O status code 200 indicará sucesso na requisição.

{
   "claimId": "259032ca-f630-4cc9-b926-db8b889e6f01",
   "type": "OWNERSHIP",
   "addressingKey": {
      "type": "PHONE",
      "value": "+5500123556789"
   },
   "claimer": {
      "branch": "0001",
      "number": "123456",
      "bank": {
         "ispb": "13140088"
      }
   },
   "donor": {
      "branch": "0001",
      "number": "654321",
      "bank": {
         "ispb": "13140088"
      }
   },
   "status": "COMPLETED",
   "previousStatus": "CONFIRMED",
   "confirmReason": "DONOR_REQUEST",
   "confirmedBy": "DONOR",
   "createdAt": "2022-07-26T13:39:31.548+00:00",
   "updatedAt": "2022-07-26T13:52:34.7053932Z",
   "resolutionLimitDate": "2022-08-02T13:39:31.548+00:00",
   "conclusionLimitDate": "2022-08-09T13:39:31.548+00:00",
   "confirmedAt": "2022-07-26T13:48:23.957+00:00",
   "completedAt": "2022-07-26T13:52:34.705393Z"
}

Erros