Collect the beneficiary's bank details

The first step in the Push to Account process.

There are three ways to do this:

  1. You collect the details independently of the Worldpay AP systems if you have bank details available

  2. You collect the details using our payment templates, ensuring the correct fields are captured

  3. We collect the details for you, using our OneClick service

Option 1: You collect bank details independently

If you collect bank details independently of Worldpay AP, use this data to construct the paymentTemplate object rather than one of Worldpay AP’s. Use the coverage section to understand the requirements for particular country/currency combinations, then map these details to the corresponding fields in the paymentTemplate object used for the Push to Account.

If you use this option and Worldpay AP need to change data required for specific country/currency combinations, then you also need to make changes.

Option 2: You collect bank details using our payment templates

If you want to use our API to help determine the fields required for each country/currency combination, you can use our payment templates.

Use getPaymentTemplatesV2 to retrieve the latest payment template objects for each country/currency combination, and then render a form on your web page that captures required bank details.

Make the call to retrieve the latest payment template objects regularly - this ensures you have the latest information.

You can use XSLT, applying it to the XML representation of the paymentTemplates element in the response. The important section is the one that outputs HTML controls for display on your web page. Use the attributes returned within the paymentTemplate element to render a friendly interface including tooltips (Tooltip) and basic validation (MinLength, MaxLength).

Populate the data captured from your customer into a paymentTemplate object which can then be used to request the payment.

Option 3: We collect bank details for you

If you don’t store the beneficiary’s bank details or cannot capture them, you can use OneClick to capture bank details on a page hosted on the Worldpay AP domain.

There are two ways for us to redirect the customer back to your web page:

Redirection Option 1

Worldpay AP redirects the customer to your site and the captured bank details are posted to your URL as a populated payment template.

Redirection Option 2

Worldpay AP redirects the customer to your site with a parameter indicating the Id of the payment stored within our system.