Docs

WorldPay (WPG) Integration Guide

This guide walks you through connecting your WorldPay WPG (Worldwide Payment Gateway) account with the Reveal Transactions and Settlements dashboards.

Need Help?
The WorldPay connection involves multiple technical steps. We recommend scheduling a 15-minute call with our integration team to ensure a smooth setup process.

Integration Overview

The integration process consists of three essential steps:

  1. Configuring APIs - Set up API access for data retrieval
  2. Configuring Webhooks - Enable real-time transaction notifications
  3. Configuring Reports - Set up automated report delivery

Configuring APIs

Pre-requisites

  1. XML Direct Feature - Ensure Worldpay's XML Direct feature is enabled for your account
  2. IP Whitelisting - Add Reveal IP addresses to Worldpay's allow list (contact Worldpay support for assistance)

Steps

  1. Gather Required Credentials:

    • Merchant code
    • XML Username
    • XML Password

  2. Add Credentials to Reveal:

    • Enter the credentials in the Reveal integration page for the merchant code you want to connect

Note

Important for XML Password

  • Each merchant code has only one set of XML credentials
  • For security, Worldpay does not display the XML password in their dashboard
  • If you don't have your 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

Configuring Webhooks

Pre-requisites

Enhanced Notification Details - Ensure cardBin and ThreeDSecureResult details are enabled for notifications (contact Worldpay support if needed).

  • These details are crucial for analyzing authorization failure patterns

Steps

  1. Access Webhook Settings:

    • Log in to the Worldpay Merchant Administration Interface
    • Navigate to INTEGRATION → Merchant Channel

  2. Configure Notification Channel:

    • In the Merchant Channels (Production) section:
      • Activate the HTTP channel
      • Select XML under Content
      • Enter Reveal's webhook URL in the Address field for production notifications

  3. Select Notification Events:

    • In the Merchant Channel Events (Production) section, enable the following events:
      • 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

Pre-requisites

  • Scheduled Secure Reports (SSR) - Ensure SSR/SFTP is enabled for your merchant account(s).
    • If not enabled, contact your Worldpay account manager or implementation manager.

Steps

  1. Provide FTP Account Details:

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

  2. Enable Required Reports For detailed information on Worldpay's SSR service and reports, refer to the Worldpay Scheduled Secure Reports Reference Guide.

The following reports need to be enabled:

Report NameDescriptionFrequency
Net Settled Sales by TransactionIncludes all settled and conveyed transactions (deposits and refunds), including Direct Debit transactions. Used primarily for fiscal reconciliation.Daily
Session ReportIncludes all transactions for a particular activity day. Used primarily for transaction reconciliation.Daily
Transaction SummaryContains summarized deposits and refunds submitted by the merchant for both settled and conveyed methods of payment, broken down by purchase currency.Daily
Activity and Settlement ReportsContains summarized financial data for settled transactions. Activity report is based on post date, while Settlement report is based on transfer date.Daily or Monthly
Chargeback FinancialProvides details of chargeback activities for either a designated activity day or settlement date. Includes Direct Debit return and PIN Debit Adjustment information.Daily
Chargeback Win/LossProvides information about chargeback cases won or lost on a given day.Daily
Fee ReportProvides a detailed breakdown of all Worldpay and Passthrough (Interchange) fees associated with transactions.Daily or Monthly
Declined TransactionContains details about deferred, declined, and duplicate transactions.Daily
Declined Plan RequestsContains details about declined requests for Recurring Plan creations and updates.Daily
Declined Subscription RequestsContains details about declined requests for Recurring Subscription creations, updates, and cancellations.Daily
Visa Fixed Acquirer Network FeeContains details of FANF fees assessed by sales volume and charged to merchants. Published on the 8th of each month with previous month's data.Monthly
EMDR ReportProvides measurements of the Effective Merchant Discount Rate for Canadian transactions.Daily
PayFac Fee ReportContains financial data for fees assessed to Sub-merchants enabled for Sub-merchant Funding. Only applies to PayFacs using the Managed Payout solution.Daily

Optional Reports:

Report NameDescriptionFrequency
Fraud AlertDaily listing of issuer-confirmed fraudulent transactions. Helps issue timely refunds to prevent chargebacks.Daily
Customer InsightsProvides transaction details that include Insights data.Daily

Was this article helpful?