> 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: paymentLinks

# Namespace: paymentLinkPayments

# Webhook link: https://dev.wix.com/docs/api-reference/business-management/get-paid/payment-links/payment-link-payments/payment-link-payment-updated.md

## Introduction

Triggered when a payment link payment is updated.

---

## REST API

### Schema

```
Webhook: Payment Link Payment Updated
Description: Triggered when a payment link payment is updated.
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: PaymentLinkPayment | description: The entity after the update.
        - ONE-OF:
           - name: regularPaymentLinkPayment | type: RegularPaymentLinkPayment | description: Conventional payment, not including Wix eCommerce's gift cards. Includes payments made through Wix Payments, Stripe, and all [supported payment gateways](https://www.wix.com/payments/payment-gateways).
              - ONE-OF:
                 - name: creditCardPaymentMethodData | type: CreditCardPaymentMethodData | description: Credit card payment method data.
                    - name: network | type: string | description: Card network.
                    - name: maskedCreditCard | type: string | description: Masked card number.
                    - name: holderName | type: string | description: Card holder name.
                 - name: walletPaymentMethodData | type: WalletPaymentMethodData | description: Wallet payment method data.
                    - name: buyerAccountEmail | type: string | description: Buyer account email.
              - name: paymentMethod | type: string | description: Payment method.
              - name: paymentProvider | type: string | description: Payment service provider.
              - name: contactDetails | type: FullAddressContactDetails | description: Buyer contact details.
                 - name: firstName | type: string | description: Contact's first name.
                 - name: lastName | type: string | description: Contact's last name.
                 - name: phone | type: string | description: Contact's phone number.
                 - name: company | type: string | description: Contact's company name.
                 - name: email | type: string | description: Email associated with the address.
                 - name: vatId | type: VatId | description: Tax info.
                    - name: id | type: string | description: Customer's tax GUID.
                    - name: type | type: VatType | description: Tax type.  Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
                           - enum:
                           -     UNSPECIFIED: 
                           -     CPF: CPF - for individual tax payers.
                           -     CNPJ: CNPJ - for corporations
              - name: contactId | type: string | description: Buyer contact GUID, if relevant.
              - name: billingAddress | type: Address | description: Buyer's billing address.
                 - ONE-OF:
                    - name: streetAddress | type: StreetAddress | description: Street name and number.
                       - name: number | type: string | description: Street number.
                       - name: name | type: string | description: Street name.
                    - name: addressLine | type: string | description: Main address line, usually street and number as free text.
                 - name: country | type: string | description: Country code.
                 - name: subdivision | type: string | description: Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
                 - name: city | type: string | description: City name.
                 - name: postalCode | type: string | description: Zip/postal code.
                 - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains Apt, Suite, and Floor.
              - name: method | type: PaymentMethod | description: Payment method type.
                   - enum:
                   -     UNKNOWN_METHOD_DATA: 
                   -     CREDIT_CARD: Credit card.
                   -     WALLET: Wallet.
              - name: order | type: PaymentOrder | description: Payment order.
                 - ONE-OF:
                    - name: ecomOrder | type: Ecom | description: Wix eCommerce order details.
                       - name: ecomOrderId | type: string | description: Wix eCommerce order GUID.
                    - name: cashierOrder | type: Cashier | description: Wix Cashier order details.
                       - name: cashierOrderId | type: string | description: Wix Cashier payment order GUID.
                 - name: type | type: OrderType | description: Payment order type.
                       - enum:
                       -     UNKNOWN_ORDER_TYPE: 
                       -     ECOM: Wix eCommerce order type.
                       -     CASHIER: Wix Cashier order type.
           - name: giftCardPaymentLinkPayment | type: GiftCardPaymentLinkPayment | description: Wix eCommerce gift card payment details.
              - name: ecomOrderId | type: string | description: Wix eCommerce order GUID associated with the gift card payment.
              - name: contactDetails | type: FullAddressContactDetails | description: Buyer contact details.
              - name: contactId | type: string | description: Buyer contact GUID, if relevant.
              - name: billingAddress | type: Address | description: Buyer's billing address.
        - ONE-OF:
           - name: ecomCheckout | type: EcomCheckout | description: Wix eCommerce checkout.
              - name: ecomCheckoutId | type: string | description: Wix eCommerce checkout GUID.
           - name: ecomOrderCheckout | type: EcomOrderCheckout | description: Wix eCommerce order checkout.
              - name: orderPaymentRequestId | type: string | description: Wix eCommerce order payment request GUID.
        - name: id | type: string | description: Payment link payment GUID. When a gift card is used, this is the gift card payment GUID. Otherwise, this is the transaction GUID associated with the relevant payment type.
        - name: revision | type: string | description: Revision number, which increments by 1 each time the payment link payment is updated.
        - name: createdDate | type: string | description: Date and time the payment was created.
        - name: amount | type: string | description: Payment amount.
        - name: paymentLinkId | type: string | description: Payment link GUID associated with the payment.
        - name: receiptId | type: string | description: Receipt GUID associated with the payment, available in the Get Paid Receipts API.
        - name: type | type: PaymentLinkPaymentType | description: Payment type.
           - enum:
           -     UNKNOWN_PAYMENT_TYPE: Unknown payment type.
           -     REGULAR: Conventional payment, not including Wix eCommerce's gift cards. Includes payments made through Wix Payments, Stripe, and all [supported payment gateways](https://www.wix.com/payments/payment-gateways).
           -     GIFT_CARD: Payment using a Wix eCommerce gift card.
        - name: currency | type: string | description: Currency code in [ISO-4217 alphabetic](https://www.iso.org/iso-4217-currency-codes.html) format.
        - name: transactionDate | type: string | description: Date and time the payment transaction was created.
        - name: extendedFields | type: ExtendedFields | description: Custom field data for the payment link. [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).

```

### Examples


```curl
{
  "id": "faf66111-86e9-4480-a4bb-7a3004eb0092",
  "entityFqdn": "wix.paymentlinks.payments.v1.payment_link_payment",
  "slug": "updated",
  "entityId": "afb2f6c0-e497-4c69-9ddb-be8c82351456",
  "createdEvent": {
    "currentEntity": {
      "id": "afb2f6c0-e497-4c69-9ddb-be8c82351456",
      "revision": "1",
      "createdDate": "2025-01-21T09:18:11.648Z",
      "amount": "10.99",
      "paymentLinkId": "6a206d71-52f5-4012-b3dd-8a283fea052e",
      "receiptId": "92161421-7897-40ed-9af5-5bc3b1f1fdeb",
      "type": "REGULAR",
      "regularPaymentLinkPayment": {
        "paymentMethod": "creditCard",
        "paymentProvider": "Credit/Debit Cards",
        "contactDetails": {
          "firstName": "John",
          "lastName": "Doe",
          "fullName": "John Doe",
          "phone": "0123456789",
          "company": "Green Car Toys",
          "email": "business@example.com",
          "vatId": {
            "id": "12345678",
            "type": "CPF"
          }
        },
        "contactId": "2c8ea7dd-c169-47ab-8bcc-0d5e49b7dcc6",
        "billingAddress": {
          "country": "US",
          "subdivision": "NY",
          "city": "New York City",
          "postalCode": "10000",
          "streetAddress": {
            "number": "1234",
            "name": "Example",
            "apt": "12A"
          },
          "formattedAddress": "NY, Example 12A",
          "subdivisions": []
        },
        "method": "CREDIT_CARD",
        "creditCardPaymentMethodData": {
          "network": "visa",
          "maskedCreditCard": "**** **** **** 5678",
          "holderName": "John Doe"
        },
        "order": {
          "type": "ECOM",
          "ecomOrder": {
            "ecomOrderId": "095159f9-9f44-4ce0-a06f-312d59d56760"
          }
        }
      },
      "currencyCode": "USD",
      "ecomCheckout": {
        "ecomCheckoutId": "e19d84b5-dd8d-4621-92af-abc04b8903d9"
      }
    }
  },
  "eventTime": "2025-01-21T09:18:25.253777816Z",
  "triggeredByAnonymizeRequest": false,
  "entityEventSequence": "2"
}

```

---

## JavaScript SDK

### Schema

```
Webhook: onPaymentLinkPaymentUpdated
Description: Triggered when a payment link payment is updated.
Payload: PaymentLinkPaymentUpdatedEnvelope
  - name: entity | type: PaymentLinkPayment | description: none
     - ONE-OF:
        - name: regularPaymentLinkPayment | type: RegularPaymentLinkPayment | description: Conventional payment, not including Wix eCommerce's gift cards. Includes payments made through Wix Payments, Stripe, and all [supported payment gateways](https://www.wix.com/payments/payment-gateways).
           - ONE-OF:
              - name: creditCardPaymentMethodData | type: CreditCardPaymentMethodData | description: Credit card payment method data.
                 - name: network | type: string | description: Card network.
                 - name: maskedCreditCard | type: string | description: Masked card number.
                 - name: holderName | type: string | description: Card holder name.
              - name: walletPaymentMethodData | type: WalletPaymentMethodData | description: Wallet payment method data.
                 - name: buyerAccountEmail | type: string | description: Buyer account email.
           - name: paymentMethod | type: string | description: Payment method.
           - name: paymentProvider | type: string | description: Payment service provider.
           - name: contactDetails | type: FullAddressContactDetails | description: Buyer contact details.
              - name: firstName | type: string | description: Contact's first name.
              - name: lastName | type: string | description: Contact's last name.
              - name: phone | type: string | description: Contact's phone number.
              - name: company | type: string | description: Contact's company name.
              - name: email | type: string | description: Email associated with the address.
              - name: vatId | type: VatId | description: Tax info.
                 - name: _id | type: string | description: Customer's tax GUID.
                 - name: type | type: VatType | description: Tax type.  Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
                         - enum:
                         -     UNSPECIFIED: 
                         -     CPF: CPF - for individual tax payers.
                         -     CNPJ: CNPJ - for corporations
           - name: contactId | type: string | description: Buyer contact GUID, if relevant.
           - name: billingAddress | type: Address | description: Buyer's billing address.
              - name: city | type: string | description: none
              - name: subdivision | type: string | description: none
              - name: country | type: string | description: none
              - name: postalCode | type: string | description: none
              - name: addressLine1 | type: string | description: none
              - name: addressLine2 | type: string | description: none
           - name: method | type: PaymentMethod | description: Payment method type.
                 - enum:
                 -     UNKNOWN_METHOD_DATA: 
                 -     CREDIT_CARD: Credit card.
                 -     WALLET: Wallet.
           - name: order | type: PaymentOrder | description: Payment order.
              - ONE-OF:
                 - name: ecomOrder | type: Ecom | description: Wix eCommerce order details.
                    - name: ecomOrderId | type: string | description: Wix eCommerce order GUID.
                 - name: cashierOrder | type: Cashier | description: Wix Cashier order details.
                    - name: cashierOrderId | type: string | description: Wix Cashier payment order GUID.
              - name: type | type: OrderType | description: Payment order type.
                     - enum:
                     -     UNKNOWN_ORDER_TYPE: 
                     -     ECOM: Wix eCommerce order type.
                     -     CASHIER: Wix Cashier order type.
        - name: giftCardPaymentLinkPayment | type: GiftCardPaymentLinkPayment | description: Wix eCommerce gift card payment details.
           - name: ecomOrderId | type: string | description: Wix eCommerce order GUID associated with the gift card payment.
           - name: contactDetails | type: FullAddressContactDetails | description: Buyer contact details.
           - name: contactId | type: string | description: Buyer contact GUID, if relevant.
           - name: billingAddress | type: Address | description: Buyer's billing address.
     - ONE-OF:
        - name: ecomCheckout | type: EcomCheckout | description: Wix eCommerce checkout.
           - name: ecomCheckoutId | type: string | description: Wix eCommerce checkout GUID.
        - name: ecomOrderCheckout | type: EcomOrderCheckout | description: Wix eCommerce order checkout.
           - name: orderPaymentRequestId | type: string | description: Wix eCommerce order payment request GUID.
     - name: _id | type: string | description: Payment link payment GUID. When a gift card is used, this is the gift card payment GUID. Otherwise, this is the transaction GUID associated with the relevant payment type.
     - name: revision | type: string | description: Revision number, which increments by 1 each time the payment link payment is updated.
     - name: _createdDate | type: Date | description: Date and time the payment was created.
     - name: amount | type: string | description: Payment amount.
     - name: paymentLinkId | type: string | description: Payment link GUID associated with the payment.
     - name: receiptId | type: string | description: Receipt GUID associated with the payment, available in the Get Paid Receipts API.
     - name: type | type: PaymentLinkPaymentType | description: Payment type.
         - enum:
         -     UNKNOWN_PAYMENT_TYPE: Unknown payment type.
         -     REGULAR: Conventional payment, not including Wix eCommerce's gift cards. Includes payments made through Wix Payments, Stripe, and all [supported payment gateways](https://www.wix.com/payments/payment-gateways).
         -     GIFT_CARD: Payment using a Wix eCommerce gift card.
     - name: currency | type: string | description: Currency code in [ISO-4217 alphabetic](https://www.iso.org/iso-4217-currency-codes.html) format.
     - name: transactionDate | type: Date | description: Date and time the payment transaction was created.
     - name: extendedFields | type: ExtendedFields | description: Custom field data for the payment link. [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: 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 { paymentLinkPayments } from '@wix/get-paid';

paymentLinkPayments.onPaymentLinkPaymentUpdated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { paymentLinkPayments } from '@wix/get-paid';

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

wixClient.paymentLinkPayments.onPaymentLinkPaymentUpdated((event) => {
    // handle your event here
});
```

---