Advanced Options

Advanced Options

Here you can find some examples of advanced workflow customisations for PIPE. Each of the examples provided use the wpwlOptions variable, the full reference for which can be found on our PIPE API Reference.

Add custom fields

You can add additional parameters to the payment form using the wpwlOptions variable, prior to loading the PIPE payment widget. In the example above, we add a custom parameter to the payment form for recording the number of installments requested by the customer. The steps are listed below.

  1. Prepare the checkout
  2. Using the wpwlOptions API onLoad event, add the custom field HTML to the payment form
  3. Set the name of the html input field to your API parameter e.g. recurring.numberOfInstallments


Change label

You can change a label in the payment form using the wpwlOptions variable, prior to loading the PIPE payment widget. In the following example, we'll change the credit card brand label in the payment form.

  1. Prepare the order
  2. Using the wpwlOptions API onLoad event, use a JQuery selector to set the desired value of the label


Create custom UI

You can change the behaviour of the payment page when there are multiple types of payment methods using the wpwlOptions variable, prior to loading the PIPE payment widget.

  1. Prepare the checkout
  2. Using the wpwlOptions API onLoad event, iterate through each .wpwl-container adding custom HTML before the container
  3. Create a JQuery click handler to show the container on click.


Create custom UI - Box model

You can change the behaviour of the payment page when there are multiple types of payment methods using the wpwlOptions variable, prior to loading the PIPE payment widget.

  1. Prepare the checkout
  2. Using the wpwlOptions API onReady event and make some adaptions to the containers.
  3. Create a JQuery click handler to show the container on click.


Summary page

It is possible to use PIPE to temporarily store the payment information after submission, rather than executing it straight away. This can be useful if you want to display an order summary page before committing the payment. This can be done using the wpwlOptions variable, prior to loading the PIPE.

To commit the payment after the summary page has been displayed, you can include the following form on the summary page. When the submit button is pressed, the payment will be executed.

<form action="https://test.planetpaymentgateway.com/v1/checkouts/{id}/payment" method="POST"> 

<input type="submit" value="Pay now" /> 


Store payment details

There are two ways to store the payment details used during a checkout:

  1. Set the createRegistration parameter to true during step 1 - prepare the checkout
  2. Add a checkbox to the PIPE form to let the customer decide whether or not to store the card details.

(Option 2 is demonstrated in the example below).