Sign in

v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
ReivindicacaoChave

Endpoint para receber Webhook de atualizações na reivindicação de chave

Requisitos:

  • Endpoint que deve ser implementado pelo cliente para receber Webhook de atualizações na reivindicação de chave.
  • Realizar a configuração/cadastro do Webhook no Contexto do PIX Indireto
post/bs2/pix/indireto/webhook/mock/reivindicacao-chave

Headers

apikeystring required

api key

Request body

correlationIdstring uuid

Identificador de correlação para suporte operacional.

tipo'OWNERSHIP' | 'PORTABILITY'
tipoChave'CPF' | 'CNPJ' | 'PHONE' | 'EMAIL' | 'EVP'
status'OPEN' | 'WAITING_RESOLUTION' | 'CONFIRMED' | 'CANCELLED' | 'COMPLETED'
ispbDoadorstring nullable

Identificador SPB do participante que doa a chave reinvidicada.

chavestring nullable

Chave PIX

abertoEmUtcstring date-time nullable

Data-hora da abertura da reivindicação de chave.

aguardandoResolucaoEmUtcstring date-time nullable

Data-hora da atualização de status para "Aguardando Resolução".

confirmadaEmUtcstring date-time nullable

Data-hora da atualização de status para "Confirmada".

canceladaEmUtcstring date-time nullable

Data-hora da atualização de status para "Cancelada".

completaEmUtcstring date-time nullable

Data-hora da atualização de status para "Completa"..

fimPeriodoResolucaostring date-time nullable

Data-hora quando termina o período de resolução.

fimPeriodoEncerramentostring date-time nullable

Data-hora quando termina o período de encerramento. Apenas para reivindicação de posse.

ultimaModificacaostring date-time nullable

Data-hora da última modificação do status da reivindicação.

motivoSolicitacao'USER_REQUESTED' | 'ACCOUNT_CLOSURE' | 'FRAUD' | 'DEFAULT_OPERATION' | 'RECONCILIATION'
motivoCancelamento'USER_REQUESTED' | 'ACCOUNT_CLOSURE' | 'FRAUD' | 'DEFAULT_OPERATION' | 'RECONCILIATION'
canceladoPor'DONOR' | 'CLAIMER'
participanteIndiretoReivindicadorboolean

Flag que identifica se o participante indireto BS2 é o Reivindicador

participanteIndiretoDoadorboolean

Flag que identifica se o participante indireto BS2 é o Doador

Example request

{
  "correlationId": "1CD524B2-C3EA-4494-9F48-EB3A54D34DA5"
}

Response

Webhook recebido com sucesso.

statusCodeinteger