> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eximpe.com/llms.txt
> Use this file to discover all available pages before exploring further.

# REFUND STATUS UPDATE

> Technical reference for the REFUND_STATUS_UPDATE webhook event, including payload schema, field specifications, and implementation details.

## Event Overview

**Event Type**: `REFUND_STATUS_UPDATE`\
**Category**: Payment\
**Description**: Refund status has changed

This webhook is triggered whenever a refund transitions to a new status (for example, while it is being processed) through EximPe.

## Payload Schema

<CodeGroup>
  ```json Example Payload theme={null}
  {
      "data": {
          "refunds": [
              {
                  "bank_arn": null,
                  "comments": "Refund is in progress",
                  "order_id": "OD2683049175",
                  "refund_id": "RF7405286913",
                  "payment_id": "PR1938472605",
                  "refund_amount": 1180,
                  "refund_status": "PROCESSING",
                  "refund_completed_at": null
              }
          ]
      },
      "version": "3.0.0",
      "event_time": "2026-05-27T14:30:01.359434",
      "event_type": "REFUND_STATUS_UPDATE",
      "sequence_number": "9e15c8b0-46d2-4af7-8130-72c5e9a4f6d8"
  }
  ```
</CodeGroup>

## Field Specifications

<Tabs>
  <Tab title="Root Level Fields">
    <ParamField path="event_type" type="string" required>
      Always `"REFUND_STATUS_UPDATE"` for this webhook event
    </ParamField>

    <ParamField path="event_time" type="string" required>
      Timestamp when the event occurred in ISO 8601 format

      **Example**: `"2026-05-27T14:30:01.359434"`
    </ParamField>

    <ParamField path="version" type="string" required>
      Webhook payload version (currently "3.0.0")
    </ParamField>

    <ParamField path="sequence_number" type="string" required>
      Unique identifier for the event instance

      **Example**: `"9e15c8b0-46d2-4af7-8130-72c5e9a4f6d8"`
    </ParamField>

    <ParamField path="data" type="object" required>
      Event-specific data payload containing refund details
    </ParamField>
  </Tab>

  <Tab title="Data Object Fields">
    <ParamField path="data.refunds" type="array" required>
      Array of refund objects containing the refund information
    </ParamField>

    <ParamField path="data.refunds[].order_id" type="string" required>
      Order ID associated with the refund

      **Example**: `"OD2683049175"`
    </ParamField>

    <ParamField path="data.refunds[].refund_id" type="string" required>
      Unique refund identifier

      **Example**: `"RF7405286913"`
    </ParamField>

    <ParamField path="data.refunds[].payment_id" type="string" required>
      Original payment ID that the refund was attempted against

      **Example**: `"PR1938472605"`
    </ParamField>

    <ParamField path="data.refunds[].refund_amount" type="number" required>
      Refund amount

      **Example**: `1180`
    </ParamField>

    <ParamField path="data.refunds[].refund_status" type="string" required>
      Current status of the refund

      **Example**: `"PROCESSING"`
    </ParamField>

    <ParamField path="data.refunds[].comments" type="string">
      Human-readable note describing the current refund status

      **Example**: `"Refund is in progress"`
    </ParamField>

    <ParamField path="data.refunds[].bank_arn" type="string">
      Bank ARN (Acquirer Reference Number) - `null` until the refund reaches the bank

      **Example**: `null`
    </ParamField>

    <ParamField path="data.refunds[].refund_completed_at" type="string">
      Timestamp when the refund completed - `null` while the refund is still in progress

      **Example**: `null`
    </ParamField>
  </Tab>
</Tabs>