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
Para saber se um usuário possui um pedido de reivindicação aberto, seja do tipo portabilidade ou posse, o parceiro deve utilizar o endpoint de consulta de pedidos.

Etapas

Endpoint

Para uso deste endpoint, é obrigatório preencher 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;

Body

reason: motivo pelo qual a confirmação está ocorrendo, que nesse caso deverá ser preenchido com DONOR_REQUEST (solicitação do cliente).

curl --location --request PATCH '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 <Bearer Token>' \ 
--data-raw '{ 
  "reason": "DONOR_REQUEST" 
}'

Retorno

O status code 200 indicará que o pedido foi confirmado com sucesso.

{ 
    "claimId": "8d1e917c-850c-4c57-b9d6-4fd1e6826e20", 
    "type": "PORTABILITY", 
    "addressingKey": { 
        "type": "EMAIL", 
        "value": "[email protected]" 
    }, 
    "claimer": { 
        "branch": "0001", 
        "number": "123456", 
        "bank": { 
            "ispb": "13140088" 
        } 
    }, 
    "donor": { 
        "branch": "0001", 
        "number": "12345678", 
        "bank": { 
            "ispb": "12345678" 
        } 
    }, 
    "status": "CONFIRMED", 
    "confirmReason": "DONOR_REQUEST", 
    "confirmedBy": "DONOR", 
    "createdAt": "2022-06-03T19:15:31.288+00:00", 
    "updatedAt": "2022-06-23T12:32:29.0434187Z", 
    "resolutionLimitDate": "2022-06-10T19:15:31.288+00:00", 
    "conclusionLimitDate": "2022-06-17T19:15:31.288+00:00", 
    "confirmedAt": "2022-06-23T12:32:29.0434185Z" 
}

Erros

Status code	Código	Descrição
422	CLAIM_CANNOT_BE_CONFIRMED_BY_CLAIMER	A reivindicação não pode ser confirmada pelo reivindicador.
422	CLAIM_STATUS_DOES_NOT_ALLOW_CONFIRMATION	O status não permite realizar a confirmação.
422	CLAIM_CAN_ONLY_BE_CONFIRMED_BY_DONOR_ACCOUNT_HOLDER	A reivindicação de portabilidade ou de posse só pode ser confirmada pelo titular da conta do doador.
422	CLAIM_ALREADY_CONFIRMED	A reivindicação já foi confirmada.
422	INVALID_STATUS_TO_CONFIRM_CLAIM	Esse status não permite realizar a confirmação da reivindicação.
422	CONFIRMATION_REASON_NOT_INFORMED	A razão da confirmação não foi informada.
422	CONFIRMATION_REASON_INVALID_TO_PORTABILITY_CLAIM	A razão da confirmação é inválida para a reivindicação de portabilidade.
422	INVALID_STATUS_TO_CONFIRM_OWNERSHIP_CLAIM	Não é possível realizar a confirmação da reivindicação de posse quando o status é diferente de WAITING_RESOLUTION ou CONFIRMED.
422	CONFIRMATION_REASON_INVALID_TO_OWNERSHIP_CLAIM	A razão da confirmação é inválida para reivindicação de posse.
422	OWNERSHIP_CLAIM_RESOLUTION_DATE_NOT_ENDED	Como a data de resolução da reivindicação de posse ainda não expirou, não é possível utilizar a razão DEFAULT_OPERATION.

Importante

Etapas

Endpoint

Retorno

Erros

Próximo