Sign in

v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
RestituicaoFinalizadaWebhook

Endpoint para receber Webhook de Restituição do Pagamento Finalizada

Requisitos:

  • Endpoint que deve ser implementado pelo cliente para receber Webhook de Restituição do Pagamento Finalizada.
  • Realizar a configuração/cadastro do Webhook no Contexto do PIX Indireto
post/bs2/pix/indireto/webhook/mock/restituicao

Headers

apikeystring required

api key

Request body

chaveIdempotenciastring uuid
returnIdstring nullable

Identificador da Devolução formatado no padrão de EndToEndId

endToEndIdstring nullable

EndToEndId da transação de origem (Pagamento)

valornumber double

Valor da Transação

solicitadoEmUtcstring date-time

Data/Hora do registro da Restituição (Devolução de pagamento)

dataContabilstring date-time nullable
liquidadoEmUtcstring date-time nullable
status'AguardandoValidacao' | 'Autorizada' | 'NaoAutorizada' | 'Efetivada' | 'Rejeitada' | 'Erro'

0 - AguardandoValidacao 1 - Autorizada 2 - NaoAutorizada 3 - Efetivada 4 - Rejeitada 99 - Erro

erroDescricaostring nullable

Example request

{
  "returnId": "D710278662022121316173321926315D",
  "endToEndId": "E710278662022121316173321926315P"
}

Response

Webhook recebido com sucesso.

statusCodeinteger