API Reference

Notificação de mudança de status do estorno

post
https://api-bnpl-wl.sandbox.open-co.tech/webhooks/refund-status

Direção: Inbound (QI Tech / infraestrutura de pagamento → BNPL WL). Parceiros não chamam este endpoint diretamente.

Endpoint webhook para receber notificações de mudança de status do estorno. Este é disparado quando um estorno transita entre estados. Use para acompanhar o progresso do estorno de forma assíncrona, especialmente útil quando uma requisição de estorno expira.

Transições de status comuns:

  • PENDING -> LIMIT_RESTORED: Limite de crédito do cliente restabelecido, transferência do estorno ainda em processamento
  • LIMIT_RESTORED -> COMPLETED: Estorno processado com sucesso
  • PENDING -> FAILED: Processamento do estorno falhou
  • PENDING -> ACTION_REQUIRED: Estorno requer ação do parceiro (ex: chave PIX inválida — colete uma nova do cliente)
  • ACTION_REQUIRED -> PENDING: Parceiro resubmeteu dados corrigidos, estorno está sendo reprocessado
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Payload de webhook para notificações de mudança de status do estorno. Enviado quando um estorno transita entre estados.

uuid
required

Identificador da pessoa associada a este estorno

string
enum
required

Tipo de evento webhook

Show Details
refund.status_changeDisparado quando o status de um estorno muda
Allowed:
uuid
required

Identificador da aplicação associada a este estorno

uuid
required

Identificador do estorno

string

ID de referência fornecido pelo parceiro para este estorno, utilizado para reconciliação

string
enum
required

Status anterior do estorno antes da mudança

Show Details
PENDINGEstorno sendo processado
LIMIT_RESTOREDLimite de crédito do cliente restabelecido; a transferência do estorno (PIX) ainda está sendo processada
COMPLETEDEstorno concluído com sucesso
FAILEDProcessamento do estorno falhou
ACTION_REQUIREDEstorno requer ação do parceiro — dados novos ou corrigidos devem ser fornecidos pelo cliente
Allowed:
string
enum
required

Novo status do estorno após a mudança

Show Details
PENDINGEstorno sendo processado
LIMIT_RESTOREDLimite de crédito do cliente restabelecido; a transferência do estorno (PIX) ainda está sendo processada
COMPLETEDEstorno concluído com sucesso
FAILEDProcessamento do estorno falhou
ACTION_REQUIREDEstorno requer ação do parceiro — dados novos ou corrigidos devem ser fornecidos pelo cliente
Allowed:
date-time
required

Timestamp quando a mudança de status ocorreu

data
object
required

Dados do evento com detalhes do estorno

Responses

Updated 2 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago