API Reference

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

post
https://example.com/bs2/pix/indireto/webhook/mock/restituicao

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
Body Params

Webhook com dados do Pagamento Restituido

Payload de uma Restituição Finalizada

uuid
string | null

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

string | null

EndToEndId da transação de origem (Pagamento)

double

Valor da Transação

date-time

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

date-time | null
date-time | null
string
enum

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

Allowed:
motivoRejeicao
object
string | null
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 restituição.

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