BSbs2
DevolucaoFinalizadoWebhook

Endpoint para receber Webhook de Devolução Finalizada

Características:

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

Request

  • The document declares no server URL.
  • Auth
    none required

Headers

apikeystring required

api key

Request body

chaveIdempotenciastring uuid
idExternostring nullable
endToEndIdstring nullable

EndToEndId da transação de origem (Transação de recebimento que gerou a devolução)

returnIdstring nullable

Identificador da transação

valornumber double
solicitadoEmUtcstring date-time

Data do registro da Devolução

dataContabilstring date-time nullable

Data contabil do Recebimento

liquidadoEmUtcstring date-time nullable

Data de Liquidação

status'Solicitada' | 'Efetivada' | 'Rejeitada' | 'Erro'

1 - Solicitada 2 - Efetivada 3 - Rejeitada 99 - Erro

erroDescricaostring nullable

Example request

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

Response

Webhook recebido com sucesso.

statusCodeinteger

Changes

No recorded changes to this operation across all 1 revision of this API.