API Reference

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

post
https://example.com/bs2/pix/indireto/webhook/mock/reivindicacao-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
Body Params

Webhook com dados de reivindicação de chave

uuid

Identificador de correlação para suporte operacional.

string
enum
Allowed:
string
enum
Allowed:
string
enum
Allowed:
string | null

Identificador SPB do participante que doa a chave reinvidicada.

string | null

Chave PIX

contaSolicitante
object
solicitante
object
date-time | null

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

date-time | null

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

date-time | null

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

date-time | null

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

date-time | null

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

date-time | null

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

date-time | null

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

date-time | null

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

string
enum
Allowed:
string
enum
Allowed:
string
enum
Allowed:
boolean

Flag que identifica se o participante indireto BS2 é o Reivindicador

boolean

Flag que identifica se o participante indireto BS2 é o Doador

Headers
string
required

api key

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

400

Ocorreu um erro ao receber a reivindicação de chave.

Updated 12 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 12 months ago