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

# Namespace: orderPaymentRequests

# Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-payment-requests/order-payment-request-updated.md

## Introduction

Triggered when an order payment request is updated.

---

## REST API

### Schema

```
Webhook: Order Payment Request Updated
Description: Triggered when an order payment request 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: OrderPaymentRequest | description: The entity after the update.
        - name: id | type: string | description: Order payment request GUID.
        - name: source | type: Source | description: Details about the source that created the order payment request.
           - name: appId | type: string | description: GUID of the app that created the order payment request.
           - name: externalId | type: string | description: Reference to a record in the source system. For example, if the payment request was created from a paylink or invoice, use this field to store the paylink GUID or invoice GUID.
        - name: status | type: Status | description: Payment request status. Set by the system. A new order payment request starts as `UNPAID`, unless `expirationDate` is already in the past at creation time, in which case it is created as `EXPIRED`. The system sets the status to `PAID` once payment is collected, `EXPIRED` when the expiration date passes, or `VOIDED` when the request is voided.
           - enum:
           -     UNPAID: Payment is owed but hasn't been collected yet.
           -     PAID: Payment has been collected.
           -     EXPIRED: The order payment request has passed its `expirationDate` without being paid.
        - name: orderId | type: string | description: Order GUID.
        - name: orderNumber | type: string | description: Order number.
        - name: amount | type: Price | description: Amount to collect. Set when the order payment request is created and can't be changed afterward.
           - name: amount | type: string | description: Amount.
           - name: formattedAmount | type: string | description: Amount formatted with currency symbol.
        - name: currency | type: string | description: Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency.
        - name: paymentGatewayOrderId | type: string | description: Payment gateway order GUID associated with this payment request.
        - name: title | type: string | description: Title displayed to the customer on the payment page.
        - name: description | type: string | description: Description displayed to the customer on the payment page.
        - name: expirationDate | type: string | description: Date and time the order payment request expires. If not provided, the order payment request doesn't expire.
        - name: extendedFields | type: ExtendedFields | description: Custom field data for this order payment request.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.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: createdDate | type: string | description: Date and time the order payment request was created.
        - name: updatedDate | type: string | description: Date and time the order payment request was last updated.
        - name: image | type: Image | description: Image to display to the customer on the payment page.
           - name: id | type: string | description: WixMedia image GUID.
           - name: height | type: integer | description: Original image height.
           - name: width | type: integer | description: Original image width.
           - name: altText | type: string | description: Image alt text.
           - name: filename | type: string | description: Image filename.
        - name: blockedPaymentMethods | type: array<PaymentMethod> | description: List of payment methods that can't be used for this order payment request.
           - enum:
           -     MANUAL: Manual payment.

```

---