Sign in

v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
PagamentoFinalizadoWebhook

Endpoint para receber Webhook de Pagamento Finalizado

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
post/bs2/pix/indireto/webhook/mock/pagamento

Headers

apikeystring required

api key

Request body

chaveIdempotenciastring uuid
pagamentoIdstring uuid
endToEndIdstring nullable

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

valornumber double

Valor da Transação

status'Iniciado' | 'Confirmado' | 'Efetivado' | 'Rejeitado' | 'Expirado' | 'Cancelado' | 'Erro'

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

solicitadoEmUtcstring date-time

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

dataContabilstring date-time nullable
liquidadoEmUtcstring date-time nullable
erroDescricaostring nullable

Example request

{
  "endToEndId": "D710278662022121316173321926315D"
}

Response

Webhook recebido com sucesso.

statusCodeinteger