Manual
Start typing to search…

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

POST https://sandbox.hiperbanco.com.br/pix/pix-key-claims/{{pixKeyClaimId}}/confirm
--request POST 'https://sandbox.hiperbanco.com.br/pix/pix-key-claims/{{pixKeyClaimId}}/confirm' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

NomePropriedadeDescrição
versioncutting-edgeEssa propriedade garante que o response da API seja retornado no formato JSON
AuthorizationBearer tokenObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

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

NomeTipoDescrição
pixKeyClaimIdpathObrigatório. Identificador único do pedido. Esse valor é retornado na criação de pedido de reivindicação, no evento PIX_CLAIM_WAS_CONFIRMED e na consulta dos pedidos de reivindicação.

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 confirmado com sucesso.Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome

Tipo

Descrição

data

object

Objeto principal da resposta.

data.pixKeyClaims

array

Lista de reivindicações de chaves Pix.

data.pixKeyClaims[].id

string

Identificação única de pedido de portabilidade ou posse. Esse valor deverá ser utilizado todas as vezes que você realizar uma operação referente a essa reivindicação, como consulta, cancelamento etc.

data.pixKeyClaims[].type

string

Tipo de reivindicação, que pode ser "PORTABILITY" (portabilidade) ou "OWNERSHIP" (posse).

data.pixKeyClaims[].status

string

Situação do pedido de reivindicação.

data.pixKeyClaims[].addressingKey

object

Objeto que contém informações sobre a chave de endereçamento.

data.pixKeyClaims[].addressingKey.type

string

Tipo de chave, que pode ser "CPF", "CNPJ", "PHONE" ou "EMAIL".

data.pixKeyClaims[].addressingKey.value

string

Valor da chave.

data.pixKeyClaims[].claimer

object

Objeto que contém informações sobre o banco a conta do reivindicador.

data.pixKeyClaims[].claimer.branch

string

Número da agência.

data.pixKeyClaims[].claimer.number

string

Número da conta.

data.pixKeyClaims[].claimer.bank

object

Objeto que contém informações sobre o banco do reivindicador.

data.pixKeyClaims[].claimer.bank.name

string

Nome da instituição financeira do requerente.

data.pixKeyClaims[].claimer.bank.ispb

string

ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco do reivindicador.

data.pixKeyClaims[].donor

object

Objeto que contém informações sobre a conta do doador.

data.pixKeyClaims[].donor.branch

string

Número da agência.

data.pixKeyClaims[].donor.number

string

Número da conta.

data.pixKeyClaims[].donor.bank

object

Objeto que contém informações sobre o banco do doador.

data.pixKeyClaims[].donor.bank.name

string

Nome do banco do doador.

data.pixKeyClaims[].donor.bank.ispb

string

ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco do doador.

data.pixKeyClaims[].donorActionLimitDate

string

Data limite para o doador de posse e o reivindicador (tanto de posse como de portabilidade) confirmarem ou cancelarem o pedido, no formato ISO 8601 - UTC.

Data limite para o doador realizar ações, como concluir ou cancelar o pedido de reivindicação, no formato ISO 8601 - UTC.

data.pixKeyClaims[].createdAt

string

Data de criação do pedido de reivindicação, no formato ISO 8601 - UTC.

data.pixKeyClaims[].updatedAt

string

Data de atualização do pedido de reivindicação, no formato ISO 8601 - UTC.

data.pixKeyClaims[].confirmReason

string

Motivo da confirmação do pedido de reinvindicação, que pode ser "DONOR_REQUEST", retornado quando o dono da chave realiza a doação para o reivindicador; "DEFAULT_OPERATION", quando o sistema confirma a doação de uma chave que já completou 15 dias em WAITING_RESOLUTION (somente em caso de posse); ou "ACCOUNT_CLOSURE" (encerramento de conta).

⚠️

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.

{
  "data": {
    "pixKeyClaims": [
      {
        "id": "f9a1b2c3-4d5e-6789-90ab-cdef12345678",
        "type": "OWNERSHIP",
        "status": "CONFIRMED",
        "confirmReason": "DONOR_REQUEST",
        "addressingKey": {
          "type": "PHONE",
          "value": "+5521987654321"
        },
        "claimer": {
          "branch": "1234",
          "number": "9876543210",
          "bank": {
            "name": "Banco Digital Fictício S.A.",
            "ispb": "18236120"
          }
        },
        "donor": {
          "branch": "5678",
          "number": "1234567890",
          "bank": {
            "name": "Banco Virtual do Brasil S.A.",
            "ispb": "13140088"
          }
        },
        "donorActionLimitDate": "2025-08-04T17:01:27.000Z",
        "createdAt": "2025-07-21T14:01:28.657Z",
        "updatedAt": "2025-07-21T14:01:48.927Z"
      }
    ]
  }
}

Possíveis status

StatusDescrição
OPENSolicitação aberta pelo reivindicador, mas ainda não recebida pelo doador.
WAITING_RESOLUTIONA reivindicação já foi recebida pelo doador e está aguardando a resolução.
CONFIRMEDO doador confirmou o pedido de reivindicação e vai ceder a chave para a outra instituição. Isso implica a remoção da chave do DICT e da base interna do PSP doador. Está aguardando o reivindicador encerrar o processo.
WAITING_VALIDATIONApós a confirmação, indica-se que o donorActionLimitDate foi atingido. A partir deste momento, a reivindicação passa a ter o status de WAITING_VALIDATION, permitindo ao reivindicador realizar a validação de posse (TOTP) e concluir a reivindicação. Isso é aplicável apenas para reivindicações de posse (OWNERSHIP).
CANCELEDO doador ou reivindicador cancelou a reivindicação, mantendo o vínculo inalterado (conforme estava antes da reivindicação), tanto no DICT quanto na base interna do PSP.
COMPLETEDO pedido de portabilidade ou posse foi completado com sucesso e a chave foi transferida para o Hiperbanco.

Erros

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

Status codeCódigoMensagemDescrição
404CLAIM_NOT_FOUNDClaim not found.Pedido de reinvindicação não encontrado.
422CLAIM_CANNOT_BE_CONFIRMED_BY_CLAIMERClaim cannot be confirmed by claimer.A reivindicação não pode ser confirmada pelo reivindicador.
422CLAIM_STATUS_DOES_NOT_ALLOW_CONFIRMATIONReceived claim status does not allow confirmation.O status não permite realizar a confirmação.
422CLAIM_CAN_ONLY_BE_CONFIRMED_BY_DONOR_ACCOUNT_HOLDERPortability claim and ownership claim only can be confirmed by donor account holder.A reivindicação de portabilidade ou de posse só pode ser confirmada pelo titular da conta do doador.
422CLAIM_ALREADY_CONFIRMEDClaim already confirmed.A reivindicação já foi confirmada.
422INVALID_STATUS_TO_CONFIRM_CLAIMClaim cannot be confirmed when status is different than WAITING_RESOLUTIONEsse status não permite realizar a confirmação da reivindicação.
422CONFIRMATION_REASON_NOT_INFORMEDConfirmation reason not informed.A razão da confirmação não foi informada.
422CONFIRMATION_REASON_INVALID_TO_PORTABILITY_CLAIMConfirmation reason is invalid to portability claim.A razão da confirmação é inválida para a reivindicação de portabilidade.
422INVALID_STATUS_TO_CONFIRM_OWNERSHIP_CLAIMOwnership claim cannot be confirmed when status is different than WAITING_RESOLUTIONNão é possível realizar a confirmação da reivindicação de posse quando o status é diferente de WAITING_RESOLUTION ou CONFIRMED.
422CONFIRMATION_REASON_INVALID_TO_OWNERSHIP_CLAIMConfirmation reason is invalid to ownership claim.A razão da confirmação é inválida para reivindicação de posse.
422OWNERSHIP_CLAIM_RESOLUTION_DATE_NOT_ENDEDOwnership claim resolution date not ended to use confirm reason DEFAULT_OPERATION.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.
422MAXIMUM_ENTRIES_COUNT_REGISTERED_FOR_CLAIMERAccount has reached the maximum entries count registered.Número de vínculos associados à conta transacional excedeu o limite máximo.
422REQUEST_NOT_ALLOWED_OUT_OF_BUSINESS_PERIODRequest not allowed out of business period.Serviço indisponível ou em manutenção.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints 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:

Nome do eventoDescrição
PIX_CLAIM_WAS_CONFIRMEDO pedido de reivindicação foi confirmado.

Updated 26 days ago