> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Package: payments

# Namespace: refunds

# Webhook link: https://dev.wix.com/docs/api-reference/business-management/payments/refunds/refund-updated.md

## Introduction

# Webhook Permissions Scopes IDs:
Read Refunds: SCOPE.DC-PAYMENTS.READ-REFUNDS

---

## REST API

### Schema

```
Webhook: Refund Updated
Description: 
Event body:
 - name: id | type: string | description: Unique event ID. Allows clients to ignore duplicate events.
 - name: entityFqdn | type: string | description: Fully qualified domain name of the entity associated with the event.
 - name: slug | type: string | description: Event name.
 - name: entityId | type: string | description: ID of the entity associated with the event.
 - name: eventTime | type: string (date-time) | description: Event timestamp.
 - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application such as GDPR.
 - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
 - name: updatedEvent | type: object | description: Updated event details.
    - name: currentEntity | type: Refund | description: The entity after the update.
        - name: id | type: string | description: Refund GUID.
        - name: revision | type: string | description: Revision number, which increments by 1 each time the refund is updated.  Ignored when creating a refund.
        - name: createdDate | type: string | description: Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#coordinated_Universal_Time_(UTC)) format. For example, "2024-01-30T13:30:00".
        - name: updatedDate | type: string | description: Date and time the refund was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#coordinated_Universal_Time_(UTC)) format. For example, "2024-01-30T13:30:00".
        - name: extendedFields | type: ExtendedFields | description: Custom field data for the refund object.  [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls.
           - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md).
        - name: chargeId | type: string | description: GUID of the charge to refund.
        - name: currencyCode | type: string | description: Refund currency. Should be the same as the charge currency.
        - name: amount | type: string | description: Amount being returned to the buyer in the refund currency's main units (such as dollars or euros). For example, `"12.95"`.
        - name: returnedApplicationFee | type: string | description: Application fee returned to the merchant from Wix in the refund currency's main units (such as dollars or euros). For example, `"12.95"`.  Only included if an application fee was returned.
        - name: returnedProcessingFee | type: string | description: Processing fee returned to the merchant from the payment service provider in the refund currency's main units (such as dollars or euros). For example, `"12.95"`.  This field is empty when the processing fee is unknown.
        - name: full | type: boolean | description: Whether the refund is for the entire amount of the charge.
        - name: status | type: Status | description: Status of the refund.  Learn more about the [refund lifecycle](https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction.md#lifecycle-of-a-refund>).
           - enum:
           -     PENDING: Refund is in progress.
           -     SUCCEEDED: Refund succeeded.
           -     FAILED: Refund failed.
           -     REVERSED: Refund had succeeded, but has since been reversed.
        - name: providerRefundId | type: string | description: Payment service provider's GUID for the refund.
        - name: reason | type: string | description: Reason this refund was issued.
        - name: statusInfo | type: StatusInfo | description: Details about the refund status. Used to provide additional information about why a refund was given its status.
           - name: code | type: string | description: Reason code with detailed information about the refund status. See the full list of [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes.md#refund-declined).
           - name: description | type: string | description: Description of the status.
        - name: acquirerReferenceNumber | type: string | description: Unique number assigned to a refund. This number is shared across all parties involved in processing the refund. It allows the merchant to track the refund with their bank.
        - name: note | type: string | description: Note providing additional information about this refund.
    - name: modifiedFields | type: Map<string,Value> | description: Fields that were updated and their values before the update.

```

### Examples


```curl
{
  "id": "268e0bd1-f288-4ebb-b645-c83b7f8c975a",
  "entityFqdn": "wix.payments.refunds.v1.refund",
  "slug": "updated",
  "entityId": "8046df3c-7575-4098-a5ab-c91ad8f33c47",
  "updatedEvent": {
    "currentEntity": {
      "id": "8046df3c-7575-4098-a5ab-c91ad8f33c47",
      "revision": 2,
      "createdDate": "2019-10-30T17:22:10.458Z",
      "updatedDate": "2019-10-30T17:22:11.299Z",
      "chargeId": "602b516f-e8a2-4e1a-9a17-0708099a74db",
      "currencyCode": "USD",
      "amount": "100",
      "full": true,
      "status": "SUCCEEDED",
      "providerRefundId": "re_1Nispe2eZvKYlo2Cd31jOCsZ"
    },
    "modifiedFields": {
      "revision": 1,
      "updatedDate": "2019-10-30T17:22:10.458Z",
      "status": "PENDING",
      "providerRefundId": null
    }
  },
  "eventTime": "2019-10-30T17:22:11.299900Z",
  "triggeredByAnonymizeRequest": false
}

```

---

## JavaScript SDK

### Schema

```
Webhook: onRefundUpdated
Description: 
Payload: RefundUpdatedEnvelope
  - name: entity | type: Refund | description: none
     - name: _id | type: string | description: Refund GUID.
     - name: revision | type: string | description: Revision number, which increments by 1 each time the refund is updated.  Ignored when creating a refund.
     - name: _createdDate | type: Date | description: Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#coordinated_Universal_Time_(UTC)) format. For example, "2024-01-30T13:30:00".
     - name: _updatedDate | type: Date | description: Date and time the refund was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#coordinated_Universal_Time_(UTC)) format. For example, "2024-01-30T13:30:00".
     - name: extendedFields | type: ExtendedFields | description: Custom field data for the refund object.  [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls.
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md).
     - name: chargeId | type: string | description: GUID of the charge to refund.
     - name: currencyCode | type: string | description: Refund currency. Should be the same as the charge currency.
     - name: amount | type: string | description: Amount being returned to the buyer in the refund currency's main units (such as dollars or euros). For example, `"12.95"`.
     - name: returnedApplicationFee | type: string | description: Application fee returned to the merchant from Wix in the refund currency's main units (such as dollars or euros). For example, `"12.95"`.  Only included if an application fee was returned.
     - name: returnedProcessingFee | type: string | description: Processing fee returned to the merchant from the payment service provider in the refund currency's main units (such as dollars or euros). For example, `"12.95"`.  This field is empty when the processing fee is unknown.
     - name: full | type: boolean | description: Whether the refund is for the entire amount of the charge.
     - name: status | type: Status | description: Status of the refund.  Learn more about the [refund lifecycle](https://dev.wix.com/docs/rest/business-management/payments/refunds/introduction.md#lifecycle-of-a-refund>).
         - enum:
         -     PENDING: Refund is in progress.
         -     SUCCEEDED: Refund succeeded.
         -     FAILED: Refund failed.
         -     REVERSED: Refund had succeeded, but has since been reversed.
     - name: providerRefundId | type: string | description: Payment service provider's GUID for the refund.
     - name: reason | type: string | description: Reason this refund was issued.
     - name: statusInfo | type: StatusInfo | description: Details about the refund status. Used to provide additional information about why a refund was given its status.
        - name: code | type: string | description: Reason code with detailed information about the refund status. See the full list of [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes.md#refund-declined).
        - name: description | type: string | description: Description of the status.
     - name: acquirerReferenceNumber | type: string | description: Unique number assigned to a refund. This number is shared across all parties involved in processing the refund. It allows the merchant to track the refund with their bank.
     - name: note | type: string | description: Note providing additional information about this refund.
  - name: modifiedFields | type: Map<string,Value> | description: Fields that were updated and their values before the update.
     - ONE-OF:
        - name: nullValue | type:  | description: 
        - name: numberValue | type: number | description: 
        - name: stringValue | type: string | description: 
        - name: boolValue | type: boolean | description: 
        - name: structValue | type: object | description: 
        - name: listValue | type: ListValue | description: 
           - name: values | type: array<Value> | description: 
  - name: metadata | type: EventMetadata | description: none
     - name: instanceId | type: string | description: App instance GUID.
     - name: eventType | type: string | description: Event type.
     - name: identity | type: IdentificationData | description: The identification type and identity data.
        - ONE-OF:
           - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
           - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
           - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
           - name: appId | type: string | description: GUID of an app.
        - name: identityType | type: WebhookIdentityType | description: 
             - enum: UNKNOWN, ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
     - name: accountInfo | type: AccountInfo | description: Details related to the account
        - name: accountId | type: string | description: GUID of the Wix account associated with the event.
        - name: parentAccountId | type: string | description: GUID of the parent Wix account. Only included when accountId belongs to a child account.
        - name: siteId | type: string | description: GUID of the Wix site associated with the event. Only included when the event is tied to a specific site.
     - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
     - name: entityFqdn | type: string | description: Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
     - name: slug | type: string | description: Event action name, placed at the top level to make it easier for users to dispatch messages. For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
     - name: entityId | type: string | description: GUID of the entity associated with the event.
     - name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`.
     - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
     - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
     - name: entityEventSequence | type: string | description: A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.

```

### Examples


```javascript
import { refunds } from '@wix/payments';

refunds.onRefundUpdated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { refunds } from '@wix/payments';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
  }),
  modules: {
      refunds,
    },
});

wixClient.refunds.onRefundUpdated((event) => {
    // handle your event here
});
```

---