Recurring payment

A recurring payment session is set up like a regular payment. However, you need to include in the payment request a set of additional fields:

Name Type Required Description
recurring Class  (tick)

A container for the type of recurring contract to be used.

recurring contains the following child:

  • contract
contract String (tick)

The type of recurring contract to be used.

If ONECLICK,RECURRING was specified when creating the recurring contract, then this field should be RECURRING.

shopperEmail String (error)

The shopper's email address.

It does not need to match the email address supplied with the initial payment.

shopperReference String (tick)

An ID that uniquely identifies the shopper.

This shopperReference must be the same as the shopperReference used in the initial payment.

shopperInteraction String (tick)

The shopper interaction.

Set to ContAuth.


String (tick)

The recurringDetailReference you want to use for this payment.

The value LATEST can be used to select the most recently stored recurring detail.

selectedBrand String (error)

The targeted payment method that you want to use for the recurring transaction.

Required for non-card recurring transactions, such as recurring payments for iDeal and Sofort, as these require a value of sepadirectdebit in the recurring payment to force their processing as SEPA direct debit transactions.

The following code examples show the request of a recurring payment in JSON, FORM, and SOAP.

    "amount" : {
        "value" : 2000,
        "currency" : "EUR"
    "reference" : "Your Reference Here",
    "merchantAccount" : "TestMerchant",
    "shopperEmail" : "",
    "shopperIP" : "",
    "shopperReference" : "Simon Hopper",
    "selectedRecurringDetailReference" : "LATEST",
	"selectedBrand" : "",
    "recurring": {
        "contract" : "RECURRING"

    "shopperInteraction" : "ContAuth"
<?xml version="1.0"?>
<soap:Envelope xmlns:soap="" xmlns:xsd="" xmlns:xsi=" instance">
    <ns1:authorise xmlns:ns1="">
        <amount xmlns="">
          <currency xmlns="">EUR</currency>
          <value xmlns="">2000</value>
        <merchantAccount xmlns="">TestMerchant</merchantAccount>
        <reference xmlns="">Your Reference Here</reference>
        <shopperEmail xmlns=""></shopperEmail>
        <shopperIP xmlns=""></shopperIP>
        <selectedBrand xmlns="" xsi:nil="true"/>
        <shopperReference xmlns="">Simon Hopper</shopperReference>
        <selectedRecurringDetailReference xmlns="">LATEST</selectedRecurringDetailReference>
        <recurring xmlns="">
          <contract xmlns="">RECURRING</contract>
        <shopperInteraction xmlns="">ContAuth</shopperInteraction>