Skip to main content

Worldpay WPG PCI

This page provides an overview of the payments methods provided by the Worldpay WPG PCI adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating Worldpay WPG PCI within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.

Payment Methods​

Payment MethodTransaction FlowsTransaction Types
CreditcardiFrame Form & payment.js IntegrationRegister, Preauthorize, Debit, Refund, Capture, Void

Parameters​

ParameterRequiredTypesValue
descriptiontrueRegister, Debit, Preauthorize, Payout
extraData.businessAppTypefalseRegister, Debit, Preauthorize, Payoutone of [FUND_TRANSFER, HIGH_RISK_SECURITIES_PURCHASE, WALLET_TRANSFER]

Additional AFT Parameters​

Data of the sender account are taken from the customer object, everything else needs to be provided via extraData. Also see https://docs.worldpay.com/apis/wpg/manage/pull-from-card

ParameterRequiredMaps toDescription
extraData.fundingTransferTypemandatoryfundingTransfer type attributesee Funding Transfer Type table
extraData.paymentPurposeconditional*fundingTransfer.paymentPurposesee Payment Purpose table
extraData.senderAccountReferenceoptional(sender) fundingParty.accountReference0-50 char. [a-z][A-Z][0-9] spaces and special characters
extraData.senderAccountTypeconditional(sender) fundingParty.accountReference accountType attributemandatory if senderAccountReference is sent, see AccountType table
customer.firstNamemandatory(sender) fundingParty.fullName.first0-35 char. [a-z][A-Z]
customer.lastNamemandatory(sender) fundingParty.fullName.last0-35 char. [a-z][A-Z]
customer.billingAddress1conditional(sender) fundingParty.fundingAddress.address10-255 char. [a-z][A-Z][0-9] optional unless city is supplied
customer.billingAddress2optional(sender) fundingParty.fundingAddress.address20-255 char. [a-z][A-Z][0-9]
customer.billingCityconditional(sender) fundingParty.fundingAddress.city0-100 char. [a-z][A-Z][0-9] optional unless address1 is supplied
customer.billingPostcodeconditional(sender) fundingParty.fundingAddress.postalCode0-15 char. [a-z][A-Z][0-9] mandatory for countries with post codes
customer.billingStateconditional(sender) fundingParty.fundingAddress.state0-3 char. [a-z][A-Z][0-9] mandatory for US and CA, 2-3 character ISO code
customer.billingCountrymandatory(sender) fundingParty.fundingAddress.countryCode2 char. [A-Z]
customer.birthDateoptional(recipient) fundingParty.fundingAddress.birthDateYYYY-MM-DD
customer.billingPhoneoptional(recipient) fundingParty.fundingAddress.telephoneNumbermax. 30 char.
extraData.recipientAccountReferencemandatory(recipient) fundingParty.accountReference0-50 char. [a-z][A-Z][0-9] spaces and special characters
extraData.recipientAccountTypemandatory(recipient) fundingParty.accountReference accountType attributesee AccountType table
extraData.recipientFirstNameoptional(recipient) fundingParty.fullName.first0-35 char. [a-z][A-Z]
extraData.recipientLastNameconditional(recipient) fundingParty.fullName.last0-35 char. [a-z][A-Z] mandatory if first name provided
extraData.recipientAddress1conditional(recipient) fundingParty.fundingAddress.address10-255 char. [a-z][A-Z][0-9] optional unless city is supplied
extraData.recipientAddress2optional(recipient) fundingParty.fundingAddress.address20-255 char. [a-z][A-Z][0-9]
extraData.recipientCityconditional(recipient) fundingParty.fundingAddress.city0-100 char. [a-z][A-Z][0-9] optional unless address1 is supplied
extraData.recipientZipconditional(recipient) fundingParty.fundingAddress.postalCode0-15 char. [a-z][A-Z][0-9] mandatory for countries with post codes
extraData.recipientStateconditional(recipient) fundingParty.fundingAddress.state0-3 char. [a-z][A-Z][0-9] mandatory for US and CA, 2-3 character ISO code
extraData.recipientCountrymandatory(recipient) fundingParty.fundingAddress.countryCode2 char. [A-Z]
extraData.recipientBirthdateoptional(recipient) fundingParty.fundingAddress.birthDateYYYY-MM-DD
extraData.recipientPhoneoptional(recipient) fundingParty.fundingAddress.telephoneNumbermax. 30 char.

*Required for transactions in Argentina, Bangladesh, Chile, Columbia, Jordan, Mexico, Thailand, UAE, India cross-border

Funding Transfer Type​

Can be configured on the connector, sending extraData.fundingTransferType overwrites the configuration

TypeDescription
AAccount-to-account
CCash
DFunds disbursement
FFunds transfer
PPerson-to-person
RPayroll disbursement
SBusiness-to-business payment
TTop-up for prepaid loads
OPayment of own Bill
QRapid merchant settlement
WStaged Digital Wallet payment
UTop-up for debit loads

Payment Purpose​

Can be configured on the connector, sending extraData.paymentPurpose overwrites the configuration

TypeDescription
00Family Support
01Regular labour transfers (expatriates)
02Travel and tourism
03Education
04Hospitalisation and medical treatment
05Emergency need
06Savings
07Gifts
08Other
09Salary
10Crowd lending
11Crypto currency

Account Type​

AccountType Value Description
01RTN + Bank account
02IBAN
03Card account
04Email
05Phone number
06Bank Account Number (BAN) and Bank Identification Code (BIC)
07Wallet ID
08Social Network ID

Visa Crypto Ramp Parameters​

For crypto purchases, the following optional parameters can be sent via extraData on Debit and Preauthorize. Values must be strings; leading and trailing whitespace is ignored, and empty or whitespace-only values are treated as not sent. Values that are not valid are rejected with an invalid request error listing every invalid parameter, and are never truncated.

ParameterRequiredValue
extraData.typeOfDigitalCurrencyfalseone of [blockchain, crypto, stablecoin, NFT, cbdc] (case-sensitive)
extraData.rampProviderIdfalsemax. 11 char., overrides the connector setting "Visa Crypto Ramp Provider ID"
extraData.affiliateIdconditionalmax. 15 char., mandatory if any affiliate parameter is sent
extraData.affiliateNamefalsemax. 22 char.
extraData.affiliateCountryCodeconditionalnumeric ISO 3166-1 country code, exactly 3 digits, e.g. 040, mandatory if any affiliate parameter is sent
extraData.affiliateUrlfalsemax. 255 char.
extraData.affiliateTaxIdfalsemax. 20 char.
  • typeOfDigitalCurrency is sent to Worldpay for every card brand.
  • rampData (the ramp provider and affiliate parameters) is only sent for Visa cards, and only if a ramp provider ID is set via extraData or the connector setting. On other cards it is omitted and the transaction continues.

Result Extra Data​

ParameterValue
avs_resultMapped from the field AVSResultCode. For possible values see Worldpay API Reference
cvv_resultMapped from the field CVCResultCode. For possible values see Worldpay API Reference
refundAuthorisationReference
  • only present in merchant postback
  • will be present in case the refund was processed online
  • In order to receive this reference make sure online refunds are activated on your Worldpay account
  • To ensure you're notified even if the refund was marked as successful earlier, activate the following project setting:
    "Postback: Send After Each Notification"