Menu

Webform notifications and statuses

What you need to know about the content of REFUND_WEBFORM_ISSUED notifications:

Field name

Order Notification element/attribute

Value

Order Notification sent on Webform Status

Merchant Email notification sent on Webform Status

Description

Webform ID

<Webform>

   Id

Numeric

N/A

N/A

A system wide unique identifier for the Webform that has been issued.

Note: The Webform ID will show random numbers for any given Merchant Code, but will be incremented by 1 for each new Webform created across the Worldpay system. Therefore the Webform ID may not show in sequential order when viewing them for any particular Merchant Code.

Payment ID

<paymentId>

Numeric

N/A

N/A

A unique identifier created by Worldpay when an order request has a payment status such as SHOPPER_REDIRECTED.

Status

(This is the status that the Webform is currently in)

<Webform Status>

ISSUED

YES

NO

Shows when the Webform is created.

CANCELLED

NO

NO

Shows if the Webform is cancelled.

Note: A Webform can only be cancelled if it is currently in the ISSUED status.

SUBMITTED

NO

YES

Shows when the shopper has successfully submitted their Webform refund request.

Note: Although no notification is sent on a Webform status of SUBMITTED, a notification will be sent (if it is set up) on the payment status of SENT_FOR_REFUND.

Webform URL

<Webform URL>

Query string with encrypted data

N/A

N/A

The URL that the Merchant provides the shopper to submit a refund. This is needed in conjunction with the associated Refund ID. Only sent in a notification on a payment status of REFUND_WEBFORM_ISSUED.

Refund ID

<refundId>

Encrypted Refund ID to give to the the shopper to submit a refund.

N/A

N/A

The Refund ID that the shopper needs in conjunction with its associated <Webform URL> to be able to perform a refund. Only sent in an order notification on a payment status of REFUND_WEBFORM_ISSUED.

Webform and payment actions

How the <Webform Status> and payment status changes based on actions by either merchant or shopper during the Webform Refund process:

Action

Webform status

Payment status

Webform merchant email sent on Webform Status

Order notification sent on Payment status

Click Webform Refund from the payments / order details screen within the MAI.

Webform not created

No change to Payment status

NO

NO

  • Click Submit from the Webform Refund Request page in the MAI
  • Send a Webform order modification request that is processed successfully.

ISSUED

REFUND_WEBFORM_ISSUED

NO

YES

Cancel the ISSUED Webform within the MAI.

Note: Currently this cannot be cancelled via an order modification.

CANCELLED

REFUND_EXPIRED

NO

NO

Shopper successfully submits their Webform refund request.

SUBMITTED

SENT_FOR_REFUND

YES

YES

Worldpay is notified that the refund request has been received by the bank.

Remains on SUBMITTED.

REFUNDED

NO

YES

Worldpay is notified that the refund has failed.

Remains on SUBMITTED.

REFUND_FAILED

NO

YES