Inbound: Refund status change notification

Direction: Inbound (QI Tech / payment infrastructure → BNPL WL). Partners do not call this endpoint directly.

Webhook endpoint for receiving refund status change notifications. This is triggered when a refund transitions between states. Use this to track refund progress asynchronously, especially useful when a refund request times out.

Common status transitions:

  • PENDING -> LIMIT_RESTORED: Customer credit limit has been restored; the refund transfer (PIX) is still being processed
  • LIMIT_RESTORED -> COMPLETED: Refund transfer processed successfully
  • PENDING -> FAILED: Refund processing failed
  • PENDING -> ACTION_REQUIRED: Refund needs partner action (e.g., invalid PIX key — collect a new one from the customer)
  • ACTION_REQUIRED -> LIMIT_RESTORED: Partner resubmitted corrected PIX data; credit limit already restored, transfer now in progress
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Webhook payload for refund status change notifications. Sent when a refund transitions between states.

uuid
required

Person identifier associated with this refund

string
enum
required

Webhook event type

Show Details
refund.status_changeTriggered when a refund status changes
Allowed:
uuid
required

Application identifier associated with this refund

uuid
required

Refund identifier

string

Partner-provided reference ID for this refund, used for reconciliation

string
enum
required

Previous refund status before the change

Show Details
PENDINGRefund is being processed
ACTION_REQUIREDRefund requires partner action — new or corrected data must be provided by the customer
LIMIT_RESTOREDCustomer credit limit has been restored; the refund transfer (PIX) is still being processed
COMPLETEDRefund has been completed successfully
FAILEDRefund processing failed
Allowed:
string
enum
required

New refund status after the change

Show Details
PENDINGRefund is being processed
ACTION_REQUIREDRefund requires partner action — new or corrected data must be provided by the customer
LIMIT_RESTOREDCustomer credit limit has been restored; the refund transfer (PIX) is still being processed
COMPLETEDRefund has been completed successfully
FAILEDRefund processing failed
Allowed:
date-time
required

Timestamp when the status change occurred

data
object
required

Event data with refund details

Responses

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