# Webhook - Payment Refund Requested

## 1. Webhook Overview

### Purpose

[context]
This Webhook event is sent from the EBP system to the store when a refund request for a captured payment is successfully received from the store.<br>
Through this event, the store can verify in real-time that the refund request has been normally received by the system and proceed with subsequent processes such as updating order information to a 'Refund in Progress' status.
[/context]

> **Note**: A registered URL is required to receive Webhooks. (Contact: [ebp-server@lge.com](mailto:ebp-server@lge.com))

### Details

[table:key-value]
| Item | Value |
| :--- | :--- |
| **Webhook Name** | Payment Refund Requested |
| **Event Type** | `PAYMENT_REFUND_REQUESTED` |
| **HTTP Method** | [badge:POST,blue,lg] |
| **Region** | [badge:Global,green-subtle,lg] |
[/table]

@@include:webhook-authentication.md@@

## 3. Data Schema

### 3.1. Payload Data Schema

| depth | Field | Details & Description                                                                                               |
| :--- | :--- |:--------------------------------------------------------------------------------------------------------------------|
| -1 | eventType | [type:string] [req:Yes] [desc:Event type] [eg:PAYMENT_REFUND_REQUESTED]                                                        |
| -1 | eventTime | [type:string] [req:Yes] [desc:Timestamp when the event occurred[tooltip:UTC, ISO-8601]] [eg:2025-12-30T10:00:00Z]                           |
| -1 | data | [type:object] [req:Yes] [desc:Detailed refund request data]                                                                            |
| 0 | orderNo | [type:string] [req:Yes] [desc:Order number issued by EBP] [eg:ORD_7202603277730794]                                                      |
| 0 | paymentStatus | [type:string] [req:Yes] [desc:Payment status code] [eg:REFUND_REQUESTED] |
| 0 | refundRequestedAmount | [type:number] [req:Yes] [desc:Refund requested amount] [eg:50000]                                                  |
| 0 | currencyCode | [type:string] [req:Yes] [desc:Currency code. ISO 4217] [eg:USD]                                               |
| 0 | exponent | [type:number] [req:Yes] [desc:Currency decimal exponent] [eg:2]                                               |
| 0 | resultCode | [type:string] [req:Yes] [desc:EBP result code ('0' for success)] [eg:0]                                                    |
| 0 | resultMessage | [type:string] [req:Optional] [desc:Result message] [eg:SUCCESS]                                                   |
| 0 | refundRequestedAt | [type:string] [req:Yes] [desc:Timestamp when the refund request was received[tooltip:UTC, ISO-8601]] [eg:2025-12-30T10:00:00Z]                        |
| 0 | pgProvider | [type:string] [req:Yes] [desc:Payment Gateway provider code] [eg:WORLDPAY, OMISE]                  |

## 3.2. Payload Example

### HTTP Request
```http
POST /your-webhook-endpoint HTTP/1.1
Content-Type: application/json
x-webhook-signature: 25f0e... (HMAC-SHA256 Hex String)
x-webhook-signature-timestamp: 1735552800 (Unix Epoch Seconds)

{
  "eventType": "PAYMENT_REFUND_REQUESTED",
  "eventTime": "2025-12-30T10:00:00Z",
  "data": {
    "orderNo": "ORD_7202603277730794",
    "paymentStatus": "REFUND_REQUESTED",
    "refundRequestedAmount": 50000,
    "currencyCode": "USD",
    "exponent": 2,
    "resultCode": "0",
    "resultMessage": "SUCCESS",
    "refundRequestedAt": "2025-12-30T10:00:00Z",
    "pgProvider": "WORLDPAY"
  }
}
```