Worldpay payment gateway

[michael-chaplin-gmcvo]

Not an issue with existing code...just wondering if anyone's written a Worldpay payment gateway for this extension?

[eileenmcnaughton]

There is an omnipay plugin in the extension - I don't know how easy it is to get going but you would need to add an mgd file (which creates an entry in the civicrm_payment_processor table when you install the extension) - here is text from another file

it looks like the class would be omnipay_WorldPay or omnipay_WorldPay_Json

*

• • name - omnipay_{Processor_Name}, Omnipay calls the gateway method create with the processor name as the parameter.
• To get the processor name take a look at the Readme for the gateway you are adding - you will generally see
• The following gateways are provided by this package: Mollie so the name should be ominpay_Mollie (note matching capitalisation)
• A more complex example is omnipay_SecurePay_DirectPayment.
• This breaks down as
• • omnipay_ - our label within CiviCRM to denote Omnipay
• • SecurePay - the namespace as declared within the composer.json within the securepay gateway
• • DirectPost - the prefix on the Gateway file. It is called DirectPostGateway.php - this portion is excluded when the file is simply
• named 'Gateway.php'
• • user_name_label, password_label, signature_label, subject_label - these are generally about telling the plugin what to call these when they pass them to
• Omnipay. They are also shown to users so some reformatting is done to turn it into lower-first-letter camel case. Take a look at the gateway file for your gateway. This is directly under src.
• Some provide more than one and the 'getName' function distinguishes them. The getDefaultParameters will tell you what to pass. eg if you see
• 'apiKey' you should enter 'user_name' => 'Api Key' (you might ? be able to get away with 'API Key' - need to check). You can provide as many or as
• few as you want of these and it's irrelevant which field you put them in but note that the signature field is the longest and that
• in future versions of CiviCRM hashing may be done on password and signature on the screen.
• • 'class_name' => 'Payment_OmnipayMultiProcessor', (always)
• • 'url_site_default' - this is ignored. But, by giving one you make it easier for people adding processors
• • 'billing_mode' - 1 = onsite, 4 = redirect offsite (including transparent redirects).
• • payment_mode - 1 = credit card, 2 = debit card, 3 = transparent redirect. In practice 3 means that billing details are gathered on-site so
• it may also be used with automatic redirects where address fields need to be mandatory for the signature.
• The record will be automatically inserted, updated, or deleted from the
• database as appropriate. For more details, see "hook_civicrm_managed" at:
• http://wiki.civicrm.org/confluence/display/CRMDOC/Hook+Reference

[russ-manta]

For anyone looking in here, the Worldpay mgd file is pretty straightforward and very similar to the Mollie one. Copy the Mollie mgd file file in the Metadata directory and create a new one named _omnipayWorldPay.mgd.php and then modify the parameters as follows

return [
  [
    'name' => 'OmniPay - WorldPay',
    'entity' => 'payment_processor_type',
    'params' => array(
      'version' => 3,
      'title' => 'OmniPay - WorldPay',
      'name' => 'omnipay_WorldPay',
      'description' => 'Omnipay WorldPay Payment Processor',
      'user_name_label' => 'Installation ID',
      'password_label' => 'unused',
      'signature_label' => 'unused',
      'class_name' => 'Payment_OmnipayMultiProcessor',
      'url_site_default' => 'https://secure.worldpay.com/wcc/purchase',
      'url_api_default' => 'https://secure.worldpay.com/wcc/purchase',
      'billing_mode' => 4,
      'payment_type' => 1,
    ),
  ]
];

[eileenmcnaughton]

@russ-manta - do you want to PR it in?

[eileenmcnaughton]

Although this 'url_site_default' looks like a test value....

[russ-manta]

Ah yes my bad, have changed that url now. I've done fairly limited testing so would want to do a bit more before PR ing it in