Menu

InstaDebit

Note: To learn about the features of InstaDebit, there's an overviewhere

How to integrate InstaDebit payments:

Direct payment request

For InstaDebit payments there is some mandatory data you must supply, explainedbelow:

Copied!
<?xml version="1.0" ?>
<!DOCTYPE paymentService PUBLIC "-//WorldPay//DTD WorldPay PaymentService v1//EN" "dtd/paymentService_v1.dtd">
<paymentService version="1.4" merchantCode="YOUR_MERCHANT CODE">
  <submit>
    <order orderCode="YOUR_ORDER_CODE"><!--Use a unique order code each time-->
      <description>YOUR_DESCRIPTION</description>
      <amount currencyCode="CAD" value="500" exponent="2"/>
      <orderContent>YOUR_ORDER_CONTENT</orderContent>
      <paymentDetails>
        <INSTADEBIT-SSL shopperCountryCode="CA">
          <successURL>http://www.worldpay.com/successURL</successURL>
          <cancelURL>http://www.worldpay.com/cancelURL</cancelURL>
          <pendingURL>http://www.worldpay.com/pendingURL</pendingURL>
        </INSTADEBIT-SSL>
      </paymentDetails>
      <shopper>
        <shopperEmailAddress>shopper@worldpay.com</shopperEmailAddress><!--Mandatory-->
      </shopper>
      <shippingAddress>
        <address>
          <firstName>;Joe</firstName><!--Mandatory-->
          <lastName>;Bloggs</lastName>
          <address1>;1 Riverside Street</address1>
          <postalCode>;T1Y 2C3</postalCode>
          <city>;Calgary</city>
          <countryCode>;CA</countryCode>
        </address>
      </shippingAddress>
    </order>
  </submit>
</paymentService>

Mandatory data

The following table lists the mandatory data that require specific handling.

Parameter nameDescription
shopperEmailAddressThe email address of the shopper.
firstName and
lastname
If you do not include these values in your order:
  • Direct model: The Worldpay Payment service returns an error.
    We recommend you prompt the shopper for the first name and last name that they have registered with their Instadebit account. If the shopper provides a different name, the payment fails and the Worldpay Payment Service returns an error.

  • Hosted model: The shopper is prompted to type this value on the Worldpay payment pages.
  • |

    The <firstName> and <lastName> parameters are sub-elements of a parent. In the Direct model, the additional parameters listed in the following table are therefore mandatory.

    Note: In the Hosted model, you must include these values if the `shippingAddress` element is present.

    Parameter nameDescription
    address1The first line of the shopper's shipping address.
    postalCodeThe postal code of the shopper's shipping address.
    cityThe city of the shopper's shipping address.
    countryCodeThe country code of the shopper's shipping address.

    Response URLs

    If you are using the Direct model, you must specify the successURL, cancelURL, and pendingURL. If you are using the Hosted model, we recommend that you specify these URLs.

    After you submit your order, the Worldpay Payment service returns either of the following response URLs:

    • successURL, if the payment is successful.
    • pendingURL, which is returned in exceptional circumstances, for example, if there is an unexpected delay in the bank authorising the payment.