API Reference

Endpoint para receber Webhook de Pagamento Finalizado

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

Requisitos:

  • Endpoint que deve ser implementado pelo cliente para receber Webhook de Pagamento Finalizado.
  • Realizar a configuração/cadastro do Webhook no Contexto do PIX Indireto
Body Params

Webhook com dados do Pagamento

Payload de um Pagamento Finalizado

uuid
uuid
string | null

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

double

Valor da Transação

string
enum

0 - Iniciado 1 - Confirmado 2 - Efetivado 3 - Rejeitado 4 - Expirado 5 - Cancelado 99 - Erro

Allowed:
date-time

Data/Hora do registro da Solicitação de pagamento

date-time | null
date-time | null
rejeicao
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 o pagamento.

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