Confirmação de um pedido de reivindicação

A confirmação de um pedido de reivindicação é uma etapa exclusiva do fluxo de doação de chaves. Ela ocorre quando outra instituição financeira faz ao cliente de nosso parceiro um pedido de reivindicação de portabilidade ou posse de uma chave.

Caso o cliente opte por ceder a chave solicitada, será necessário confirmar o pedido.

Ao confirmar um pedido de reivindicação, o vínculo da chave com o doador é removido.

🚧

Importante

Os pedidos de reivindicação de portabilidade ou posse são comunicados ao parceiro via eventos de webhoook. Para receber esses eventos, é preciso realizar a configuração dos webhooks.

Se desejar, o parceiro também poderá utilizar o endpoint de consulta de pedidos.

Pré-requisito

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

• O cliente de nosso parceiro tenha recebido um pedido de reivindicação de portabilidade ou posse de uma chave.

Requisição (Request)

Requisição HTTP

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

--request PATCH \
--url 'https://api-mtls.sandbox.bankly.com.br/pix/claims/{{claimId}}/confirm' \ 
--header 'api-version: 1' \ 
--header 'x-bkly-pix-user-id: {{DOCUMENT_NUMBER}}' \ 
--header 'Content-Type: application/json' \ 
--header 'Accept: application/json' \ 
--header 'Authorization: Bearer {{token}}' \ 
--data-raw '{ 
	"reason": "DONOR_REQUEST" 
	}'

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)

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

{ 
  "reason": "DONOR_REQUEST" 
}

Resposta (Response)

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

🚧

Importante

Os pedidos de reivindicação de portabilidade ou posse são comunicados ao parceiro via eventos de webhoook. Para receber esses eventos, é preciso realizar a configuração dos webhooks. Se desejar, o parceiro também poderá utilizar o endpoint de consulta de pedidos.

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

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: