v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
ValidacaoRestituicaoWebhook

Validação Síncrona da(s) Restituição(s) (Pagamento Restituido)

Requisitos:

  • Endpoint que deve ser implementado pelo cliente para que a validação da Restituição seja recebida.
  • Valida se a(s) solicitações de Restituição(s) podem ser recebida/efetivada.
  • As validações devem respeitar o tempo de SLA regulamentado pelo Bacen para evitar a rejeição por timeout.
  • Caso a(s) solicitações não possam ser efetivadas retorna uma lista de erros.
post/bs2/pix/indireto/webhook/mock/restituicao/validacao

Headers

apikeystring required

api key

Request body

solicitadoEmUtcstring date-time

Data de registro da restituição (Devolução do pagamento)

returnIdstring nullable

Identificador da transação formatado no padrão do EndToEndId

endToEndIdstring nullable

EndToEndId da transação de origem (Pagamento)

valornumber double

Valor da Transação

codigoDevolucao'BE08' | 'FR01' | 'MD06' | 'SL02'
tipoDevolucao'Parcial' | 'Total'
prioridadeTransacao'Alta' | 'Normal'
campoLivrestring nullable
motivostring nullable
isbpPagadorstring nullable
isbpRecebedorstring nullable

Example request

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

Response

Validação realizada com sucesso.

transacaoAutorizadaboolean