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 Method | Transaction Flows | Transaction Types |
|---|---|---|
| Creditcard | iFrame Form & payment.js Integration | Register, Preauthorize, Debit, Refund, Capture, Void |
Parameters
| Parameter | Required | Types | Value |
|---|---|---|---|
| description | true | Register, Debit, Preauthorize, Payout | |
extraData.businessAppType | false | Register, Debit, Preauthorize, Payout | one 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
| Parameter | Required | Maps to | Description |
|---|---|---|---|
| extraData.fundingTransferType | mandatory | fundingTransfer type attribute | see Funding Transfer Type table |
| extraData.paymentPurpose | conditional* | fundingTransfer.paymentPurpose | see Payment Purpose table |
| extraData.senderAccountReference | optional | (sender) fundingParty.accountReference | 0-50 char. [a-z][A-Z][0-9] spaces and special characters |
| extraData.senderAccountType | conditional | (sender) fundingParty.accountReference accountType attribute | mandatory if senderAccountReference is sent, see AccountType table |
| customer.firstName | mandatory | (sender) fundingParty.fullName.first | 0-35 char. [a-z][A-Z] |
| customer.lastName | mandatory | (sender) fundingParty.fullName.last | 0-35 char. [a-z][A-Z] |
| customer.billingAddress1 | conditional | (sender) fundingParty.fundingAddress.address1 | 0-255 char. [a-z][A-Z][0-9] optional unless city is supplied |
| customer.billingAddress2 | optional | (sender) fundingParty.fundingAddress.address2 | 0-255 char. [a-z][A-Z][0-9] |
| customer.billingCity | conditional | (sender) fundingParty.fundingAddress.city | 0-100 char. [a-z][A-Z][0-9] optional unless address1 is supplied |
| customer.billingPostcode | conditional | (sender) fundingParty.fundingAddress.postalCode | 0-15 char. [a-z][A-Z][0-9] mandatory for countries with post codes |
| customer.billingState | conditional | (sender) fundingParty.fundingAddress.state | 0-3 char. [a-z][A-Z][0-9] mandatory for US and CA, 2-3 character ISO code |
| customer.billingCountry | mandatory | (sender) fundingParty.fundingAddress.countryCode | 2 char. [A-Z] |
| customer.birthDate | optional | (recipient) fundingParty.fundingAddress.birthDate | YYYY-MM-DD |
| customer.billingPhone | optional | (recipient) fundingParty.fundingAddress.telephoneNumber | max. 30 char. |
| extraData.recipientAccountReference | mandatory | (recipient) fundingParty.accountReference | 0-50 char. [a-z][A-Z][0-9] spaces and special characters |
| extraData.recipientAccountType | mandatory | (recipient) fundingParty.accountReference accountType attribute | see AccountType table |
| extraData.recipientFirstName | optional | (recipient) fundingParty.fullName.first | 0-35 char. [a-z][A-Z] |
| extraData.recipientLastName | conditional | (recipient) fundingParty.fullName.last | 0-35 char. [a-z][A-Z] mandatory if first name provided |
| extraData.recipientAddress1 | conditional | (recipient) fundingParty.fundingAddress.address1 | 0-255 char. [a-z][A-Z][0-9] optional unless city is supplied |
| extraData.recipientAddress2 | optional | (recipient) fundingParty.fundingAddress.address2 | 0-255 char. [a-z][A-Z][0-9] |
| extraData.recipientCity | conditional | (recipient) fundingParty.fundingAddress.city | 0-100 char. [a-z][A-Z][0-9] optional unless address1 is supplied |
| extraData.recipientZip | conditional | (recipient) fundingParty.fundingAddress.postalCode | 0-15 char. [a-z][A-Z][0-9] mandatory for countries with post codes |
| extraData.recipientState | conditional | (recipient) fundingParty.fundingAddress.state | 0-3 char. [a-z][A-Z][0-9] mandatory for US and CA, 2-3 character ISO code |
| extraData.recipientCountry | mandatory | (recipient) fundingParty.fundingAddress.countryCode | 2 char. [A-Z] |
| extraData.recipientBirthdate | optional | (recipient) fundingParty.fundingAddress.birthDate | YYYY-MM-DD |
| extraData.recipientPhone | optional | (recipient) fundingParty.fundingAddress.telephoneNumber | max. 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
| Type | Description |
|---|---|
| A | Account-to-account |
| C | Cash |
| D | Funds disbursement |
| F | Funds transfer |
| P | Person-to-person |
| R | Payroll disbursement |
| S | Business-to-business payment |
| T | Top-up for prepaid loads |
| O | Payment of own Bill |
| Q | Rapid merchant settlement |
| W | Staged Digital Wallet payment |
| U | Top-up for debit loads |
Payment Purpose
Can be configured on the connector, sending extraData.paymentPurpose overwrites the configuration
| Type | Description |
|---|---|
| 00 | Family Support |
| 01 | Regular labour transfers (expatriates) |
| 02 | Travel and tourism |
| 03 | Education |
| 04 | Hospitalisation and medical treatment |
| 05 | Emergency need |
| 06 | Savings |
| 07 | Gifts |
| 08 | Other |
| 09 | Salary |
| 10 | Crowd lending |
| 11 | Crypto currency |
Account Type
| Account | Type Value Description |
|---|---|
| 01 | RTN + Bank account |
| 02 | IBAN |
| 03 | Card account |
| 04 | |
| 05 | Phone number |
| 06 | Bank Account Number (BAN) and Bank Identification Code (BIC) |
| 07 | Wallet ID |
| 08 | Social 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.
| Parameter | Required | Value |
|---|---|---|
| extraData.typeOfDigitalCurrency | false | one of [blockchain, crypto, stablecoin, NFT, cbdc] (case-sensitive) |
| extraData.rampProviderId | false | max. 11 char., overrides the connector setting "Visa Crypto Ramp Provider ID" |
| extraData.affiliateId | conditional | max. 15 char., mandatory if any affiliate parameter is sent |
| extraData.affiliateName | false | max. 22 char. |
| extraData.affiliateCountryCode | conditional | numeric ISO 3166-1 country code, exactly 3 digits, e.g. 040, mandatory if any affiliate parameter is sent |
| extraData.affiliateUrl | false | max. 255 char. |
| extraData.affiliateTaxId | false | max. 20 char. |
typeOfDigitalCurrencyis 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
| Parameter | Value |
|---|---|
| avs_result | Mapped from the field AVSResultCode. For possible values see Worldpay API Reference |
| cvv_result | Mapped from the field CVCResultCode. For possible values see Worldpay API Reference |
| refundAuthorisationReference |
|