Registering a mandate

The registration of a recurring mandate corresponds to creating a token.

Later on, the token can be used for:

  • making a payment,
  • creating a recurring payment,
  • using a file sharing service. Using this form together with a file sharing service allows for each direct debit to have a different amount and due date.
  • etc.

IMPORTANT

If you use the payment gateway only for making the SEPA mandate signature, after 3 years of not using a mandate, you must call the DELETE method of the SEPA REST Web Services so that we can delete it. For more information, please contact the technical support.

Note

Its is also possible to create a token via the Merchant Back Office (see chapter Managing tokens via the Merchant Back Office).

In order to register a recurring mandate:

  1. Use all the fields presented in the table below to create your payment form.
    Field name Description Value
    vads_site_id Shop ID E.g.: 12345678
    vads_ctx_mode Operating mode TEST or PRODUCTION
    vads_trans_date Date and time of the payment form in UTC format E.g.: 20140919130128
    vads_action_mode Acquisition mode for bank data. INTERACTIVE
    vads_page_action Action required to register a mandate and make a payment REGISTER
    vads_version Version of the exchange protocol V2
    vads_cust_email Buyer’s e-mail address.

    Note:

    If the buyer’s e-mail address is pre-filled on the payment page, the buyer can modify it when signing the mandate.

    If the buyer’s e-mail address in unknown, the buyer will be prompted to specify it on the payment page.

    E.g.: mymail@example.com
  2. Populate the vads_page_action field with REGISTER.
  3. Populate the vads_action_mode field with INTERACTIVE.
  4. If you wish to pre-fill the fields with already known information, use all the optional fields from the table below to build your payment form:

    Field name Description Value
    vads_cust_title Allows to specify the buyer’s title. E.g.:
    • Mr
    • Ms
    • Ms
    vads_cust_last_name Allows to specify the buyer’s last name E.g.: Smith
    vads_cust_first_name Allows to specify the buyer’s first name E.g.: John
    vads_cust_cell_phone Buyer’s cell phone number for sending the security code (by SMS).

    Note:

    If the buyer’s cell phone number (the phone number registered during the subscription) is pre-filled on the payment page, the buyer can modify it when signing the mandate. Only GSM-users having recorded this phone number at the moment during their subscription can receive an SMS with this access code for single use.

    If the buyer’s cell phone number in unknown, the buyer will be prompted to specify it on the payment page.

    E.g.: 0612345678
    vads_cust_address Buyer’s address

    Note

    The address is required if the client has a bank account in the following departments, territories or countries: Switzerland, Monaco, San Marino, Mayotte, St. Pierre and Miquelon, Guernsey, Jersey, Isle of Man.

     
    vads_cust_country Allows to specify the buyer’s country code in the ISO 3166 format. E.g.: FR

    IMPORTANT

    If the value of the vads_cust_cell_phone field is provided in international format (+336xxxxxxxx) or if the fields vads_cust_cell_phone and vads_cust_country are both populated, the security code will be systematically sent by SMS regardless of the signature mode configured in the shop.

  5. Populate the optional vads_payment_cards field if you would like to pre-fill the displayed payment method(s).

    Note:

    • If this list contains only one payment method, the detail entry page for this payment method will directly appear.

      In order to offer SEPA direct debit, the expected value is SDD.

    • If not, the payment method selection page will appear.
    • If the parameter is empty, all the eligible payment methods (depending on the currency, the minimum or maximum amount, technical constraints, such as whether the shopping cart data, the account holder's address and the shipping address are present or not, etc.) associated with the shop will be suggested.
  6. Add optional fields according to your requirements (see chapter Using additional features).
  7. Compute the value of the signature field using all the fields of your form that start with vads_ (see chapter Computing the signature).
Example of a form:
<form method="POST" action="https://secure.payzen.eu/vads-payment/">
<input type="hidden" name="vads_action_mode" value="INTERACTIVE" />
<input type="hidden" name="vads_ctx_mode" value="TEST" />
<input type="hidden" name="vads_cust_email" value="surname.name@example.com" />
<input type="hidden" name="vads_page_action" value="REGISTER" />
<input type="hidden" name="vads_site_id" value="70258842" />
<input type="hidden" name="vads_trans_date" value="20160919130128" />
<input type="hidden" name="vads_version" value="V2" />
<input type="hidden" name="signature" value="54b2a17b9a5fcefb6c0120c57b25ec86ad1704ee"/>
<input type="submit" name="pay" value="Pay"/>
</form>