Sign in

v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
RecebimentoFinalizadoWebhook

Endpoint para receber Webhook de Recebimento Finalizado

Características:

  • Endpoint que deve ser implementado pelo cliente para receber Webhook de Recebimento Finalizado. Requisitos: Realizar a configuração/cadastro do Webhook no Contexto do PIX Indireto
post/bs2/pix/indireto/webhook/mock/recebimento

Headers

apikeystring required

api key

Request body

chaveIdempotenciastring uuid
endToEndIdstring nullable

EndToEndId da transação

transactionIdstring nullable

Id de conciliação definido na geração do QRCode utilizado para fins de conciliação

valornumber double
solicitadoEmUtcstring date-time

Data do Recebimento

dataContabilstring date-time nullable

Data contabil do Recebimento

liquidadoEmUtcstring date-time nullable

Data de Liquidação

status'AguardandoValidacao' | 'Autorizado' | 'NaoAutorizado' | 'Efetivado' | 'Rejeitado' | 'Erro'

1 - AguardandoValidacao - Aguardando Validação do Recebimento pelo Cliente 2 - Autorizado 3 - NaoAutorizado 4 - Efetivado 5 - Rejeitado 99 - Erro

erroDescricaostring nullable

Example request

{
  "endToEndId": "E710278662022121316173321926315P"
}

Response

Webhook recebido com sucesso.

statusCodeinteger