WorldPay (WPG)

This guide will walk you through the process of connect your WorldPay's WPG Worldwide Payment Gateway account with Reveal.

You can connect your WorldPay payment gateway in three steps:

1. Configuring APIs
2. Configuring Webhooks
3. Configuring Reports

Configuring APIs

Let us see how you can configure APIs:

Pre-requisites

• You need to ensure that Worldpay's XML Direct feature is enabled.
• Worldpay only allows API calls from IP addresses listed in its portal; therefore, it is mandatory to add Reveal IPs to Worldpay's allow list. Otherwise, all API calls from Reveal would be rejected. You may need to contact Worldpay support for this step.

Configuration steps

To integrate with Reveal, select the merchant code that you want to add:

1. Gather the following credentials for the account you want to integrate:
   • Merchant code
   • XML Username
   • XML Password
2. Add these credentials to the Reveal integration page.

[Note] Important note on XML Password:

• You may have multiple merchant codes in Worldpay, but each merchant code has only one set of XML credentials (username and password).
• Worldpay does not display the XML password in the dashboard for security reasons. You should have received this password when it was initially generated.
• If you don't have the XML password:
• You cannot retrieve the current password (neither merchants nor Worldpay staff can view it).
• You'll need to generate a new XML password through your Worldpay Merchant Interface. [/Note]

Configuring Webhooks

Let us see how you can configure webhooks:

Pre-requisites

• cardBin and ThreeDSecureResult details must be enabled for Notifications. If this isnt enabled, you may need to contact Worldpay support for this
• cardBin and ThreeDSecureResult details are key to be able to understand authorisation failure patterns.

Configuration steps

1. Log in to the Merchant Administration Interface.
2. Click INTEGRATION, then select Merchant Channel from the top menu.
3. In the Merchant Channels (Production) areas:
   1. Activate the http channel and select xml under Content.
   2. Enter Reveal webhook URL in Address to receive production notifications.
4. In the Merchant Channel Events (Production) areas, select all events and ensure that the following are selected.
   • SENT_FOR_AUTHORISATION
   • AUTHORISED
   • CANCELLED
   • CAPTURED
   • SETTLED
   • SETTLED_BY_MERCHANT
   • REFUSED
   • ERROR
   • EXPIRED
   • SENT_FOR_REFUND
   • REFUNDED
   • REFUNDED_BY_MERCHANT
   • REFUND_FAILED
   • INFORMATION_REQUESTED
   • INFORMATION_SUPPLIED
   • CHARGED_BACK
   • CHARGEBACK_REVERSED

Configuring Reports

Let us see how you can configure reports:

Pre-requisites

• To transfer payment information from your Worldpay account to Reveal, we'll use Worldpay's Scheduled Secure Reports (SSR). SSR generates reports which are stored in your merchant FTP account.
• Ensure that you have SSR/SFTP enabled for your merchant account(s).
• If its not enabled, you will need to reach out to your WP account manager/implementation manager.

Configuration steps

To set up the data transfer, please provide the following FTP account details:

• FTP account name
• FTP server address (URL/host)
• FTP port number
• FTP username
• FTP password

For more details on Worldpay's SSR service and the reports it generates, refer to Worldpay's documentation. - LINK

• The following reports need to be included:

  • Net Settled Sales by Transaction Report (Daily)
    The Net Settled Sales by Transaction report, used primarily for fiscal reconciliation, includes all settled and conveyed transactions (deposits and refunds), including Direct Debit transactions. You can schedule this report based upon either activity (post) or settlement (funds transfer) day. Worldpay produces this report daily.

  • Session Report (Daily)
    The Session report including all transactions for a particular activity day. Worldpay produces this report daily for use primarily for transaction reconciliation.

  • Transaction Summary Report (Daily)
    The Transaction Summary report contains the summarized deposits and refunds submitted by the merchant for both settled and conveyed methods of payment, broken down by purchase currency. Worldpay produces this report daily.

  • Activity and Settlement Reports
    Both the Activity and Settlement reports contain summarized financial data for settled transactions. The information in the Activity report is based upon activity post date, while the Settlement report information is based upon the settlement transfer date. Worldpay produces this report either daily or for the previous calendar month.

  • Chargeback Financial Report (Daily)
    Chargeback Financial (Activity) report provides details of chargeback activities for either a designated activity (post day) or fund transfer (settlement) date. The report also includes Direct Debit return information, as well as PIN Debit Adjustment information. Worldpay produces this report daily.

  • Chargeback Win/Loss Report (Daily)
    Chargeback Win/Loss report provides information about chargeback cases won or lost on a given day. Worldpay produces this report daily.

  • Fraud Alert Report [Optional]
    The Fraud Alert report is a daily listing of issuer-confirmed, fraudulent transactions. This information allows you to issue refunds for fraudulent transaction in a timely manner to prevent chargebacks.

  • Customer Insights Report [Optional]
    The Customer Insights report provides transaction details for a designated activity (post day) that include Insights data. Worldpay produces this report daily.

  • Fee Report (Daily)
    The Fee report provides a detailed breakdown of all Worldpay and Passthrough (Interchange) fees associated with transactions. The report can be scheduled based upon either activity (post) or settlement (funds transfer) day. Worldpay produces this report either daily or for the previous calendar month.

  • Declined Transaction Report
    The Declined Transaction report contains details about deferred, declined and (Online) duplicate transactions. Worldpay produces this report daily.

  • Declined Plan Requests Report
    The Declined Plan Requests report contains details about declined requests for Recurring Plan creations, and updates. Worldpay produces this report daily.

  • Declined Subscription Requests Report
    The Declined Subscription Requests report contains details about declined requests for Recurring Subscription creations, updates, and cancellations. Worldpay produces this report daily.

  • Visa Fixed Acquirer Network Fee Report
    The Visa Fixed Acquirer Network Fee Report is a merchant (non-Payfac) report containing the details of FANF fees assessed by sales volume and charged to merchants within the organization. Worldpay produces the report on the 8th of each month. Each report contains data for the prior month. For example, a report produced on August 8th would contain data for July 1st through July 31st.

  • EMDR Report
    The EMDR report provides measurements of the Effective Merchant Discount Rate for a particular card type on a specified day. The information in this report applies only to Canadian transactions and is produced to meet the requirements of the Code of Conduct for the Credit and Debit Card Industry in Canada. Worldpay produces this report daily and contains information for transactions processed three days prior to the report.

  • PayFac Fee Report
    The PayFac Fee reports is a Managed Payout report containing financial data for fees assessed to Sub-merchants enabled for Sub-merchant Funding. The information in the report is based upon the settlement transfer date. Worldpay produces the report daily and only applies to PayFacs using the Managed Payout solution.