WorldPay

Follow the standard PaymentsOS integration procedure, and then apply the relevant extra specifications in this section to integrate with WorldPay.

API Version

Minimum required API version: 1.1.0

Payment Methods

The following table lists all supported payment methods.

Payment MethodPayment Method Type
AirPlusCards
American ExpressCards
AuroreCards
Carte BancaireCards
Carte BleueCards
DankortCards
DINERSCards
DISCOVERCards
GE CapitalCards
JCBCards
MAESTROCards
MASTERCARDCards
UATPCards
VISACards

Currencies

Worldpay supports many currencies (click the link and see ISO currency codes), but not all currencies are supported by all providers. Contact Worldpay support for provider-specific currency details.

Note that Worldpay cannot process amounts in IDR that include decimal numbers. For payments in IDR, you should therefore not pass any decimal values.

Bear in mind that PaymentsOS requires you to pass amounts in minor units (this means that the last two digits of the amount are decimals). Since Worldpay cannot process amounts in IDR that include decimal numbers, you must make sure that the last two digits of the amount in minor units are always 00. For example, you can pass an amount of 1000; you cannot pass an amount of 1010.

Features

The following table provides an overview of all supported and non-supported features.

FeatureSupported
3DS 2.0 ExternalNo
3DS 2.0 PaymentsOS-handledNo
3DS 2.0 Provider-handledNo
3DS 2.0 Self-handledNo
InstallmentsNo
Level 2 and 3 DataNo
Multi-seller PaymentsNo
Network TokensNo
Payment FacilitatorNo
PayU RiskNo
Pre-authorizationNo
Retrieve Supported Payment MethodsNo
Retrieve Supported PlansNo
Statement Soft DescriptorYes
Stored Credentials FlagYes
Transaction Processing without CVVNo

Requests

The following table lists all supported requests for card-based transactions. Use the bodybuilder to create a sample request body for each request type.

RequestPartial/MultipleMode
AuthorizePartial and multiple are not supportedSynchronous
Capture Partial is supportedAsynchronous
CreditPartial and multiple are not supportedAsynchronous
Refund Both partial and multiple are supportedAsynchronous
Void Not ApplicableAsynchronous

Setup Procedures

The following table lists the setup procedures that are specific to this provider.

ConfigurationRequired/Optional
In the PaymentsOS Control Center, configure the following credentials:
  • merchant_code: The Merchant Code in your Worldpay profile.
  • api_username: The New Username in your Worldpay profile.
  • xml_password: The XML Password in your Worldpay profile.
Create separate configuratons for each provider. To see your Worldpay credentials, view your profile in your Worldpay test or live accounts.
Required
In the PaymentsOS Control Center, create webhooks to be notified when a transaction changes its status.

Note: Capture, Refund and Void are asynchronous requests, which return responses with the pending status. Webhooks are not applicable to authorization requests.
Required
In your WorldPay account, configure which IPN (Instant Payment Notifications) messages will be sent. See Configuring which IPN messages will be Sent below. Contact WorldPay support for assistance.Required

Integration Procedures

The following sections list the integration procedures that are specific to this provider.

Configuring which IPN messages will be Sent

Login to your account in the Worldpay portal, and click Profile > Merchant Channel.

  1. In Merchant Channels (Test), configure the following in the http row:
  1. In Merchant Channel Events (Test), select the following parameters in the http row: REFUND_FAILED, REFUNDED, CAPTURE_FAILED, CAPTURED and CANCELLED.

  2. In Merchant Channels (Production), configure the following in the http row:

  1. In Merchant Channel Events (Production), select the following parameters in the http row: REFUND_FAILED, REFUNDED, CAPTURE_FAILED, CAPTURED and CANCELLED.

Testing

You can use the following testing resources in the Worldpay Useful Tables page:

Last modified March 2, 2022