Creating an installment payment

This payment mode allows the merchant to offer payment facilities to the buyer.

The payment form defines the number of installments and the interval between them.

The first installment works in the same way as an immediate payment.

The next installment(s) is similar to (a) deferred payment(s).

Reminder:

Notification rules have to be activated depending on the installment. See chapter Setting up notifications for more information.

Details:

On the payment day, the total amount is not credited to the merchant’s account and the payment guarantee cannot apply to future installments.

The date of the last installment cannot exceed one year after the date of the form submission. Otherwise, an error message will appear and the form will be rejected.

  1. Use all the fields below to create your payment form.
    Field name Description Format Value
    vads_site_id Shop ID n8 E.g.: 12345678
    vads_ctx_mode Defines the mode of interaction with the payment gateway. enum TEST or PRODUCTION
    vads_trans_id Transaction number n6 E.g.: 123456
    vads_trans_date Date and time of the payment form in UTC format n14

    Respect the YYYYMMDDhhmmss format

    E.g.: 20170701130025
    vads_amount Payment amount in the smallest currency unit (cents for euro). n..12 E.g.: 3000 for 30,00 EUR
    vads_currency Numeric currency code to be used for the payment, in compliance with the ISO 4217 standard (numeric code). n3 E.g.: 978 for euro (EUR)
    vads_action_mode Card data acquisition mode enum INTERACTIVE
    vads_page_action Action to perform enum PAYMENT
    vads_version Version of the exchange protocol with the payment gateway enum V2
    vads_payment_config Payment type enum

    see step 2.

    vads_capture_delay Capture delay n..3 0
    vads_validation_mode Specifies the validation mode of the transaction (manually by the merchant, or automatically by the payment gateway). n1 0 or 1 or absent or empty
  2. Populate the vads_payment_config field using the following syntax:
    • Fixed payment amounts and dates:

      MULTI:first=1000;count=3;period=30 where:

      "first" corresponds to the amount (in the smallest currency unit) of the first installment made on the day of payment,
      "count" represents the total number of installments,
      "period" determines the interval between each installment.
    • Custom installment amounts and dates:

      MULTI_EXT:date1=amount1;date2=amount2;date3=amount3 where:

      date1=amount1 defines the date and the amount of the first transfer.
      The amounts are presented in the smallest currency unit. The total amount must be equal to the value of the vads_amount field.
      The dates are presented in the YYYYMMDD format.
  3. Set the vads_capture_delay field to 0. The first payment will be captured in the bank on the same day.
  4. Set the vads_validation_mode field to 0 for automatic validation (the payment will be automatically captured in the bank) or to 1 for manual validation (manual operation performed via the Expert Back Office).
    The validation mode applies to all the installments.
  5. Populate the vads_currency field with the code of the desired currency using the currency table (E.g.: 978 for euro (EUR)).
  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 installment payment form (fixed amounts and payment dates):
<form method="POST" action="https://secure.lyra.com/vads-payment/">
<input type="hidden" name="vads_action_mode" value="INTERACTIVE" />
<input type="hidden" name="vads_amount" value="3000" />
<input type="hidden" name="vads_ctx_mode" value="TEST" />
<input type="hidden" name="vads_currency" value="978" />
<input type="hidden" name="vads_page_action" value="PAYMENT" />
<input type="hidden" name="vads_payment_config" value="MULTI:first=1000;count=3;period=30"/>
<input type="hidden" name="vads_site_id" value="12345678" />
<input type="hidden" name="vads_trans_date" value="20190629180150" />
<input type="hidden" name="vads_trans_id" value="180150" />
<input type="hidden" name="vads_version" value="V2" />
<input type="hidden" name="signature" value= "zrhUNkAciZSEl6mS4BbhV3qkYUBB9RYJQCdg1kU0ELU="/>
<input type="submit" name="pay" value="Pay" />
</form>

Example of installment payment form (custom amounts and payment dates):
<form method="POST" action="https://secure.lyra.com/vads-payment/">
<input type="hidden" name="vads_action_mode" value="INTERACTIVE" />
<input type="hidden" name="vads_amount" value="3000" />
<input type="hidden" name="vads_capture_delay" value="0" />
<input type="hidden" name="vads_ctx_mode" value="TEST" />
<input type="hidden" name="vads_currency" value="" />
<input type="hidden" name="vads_page_action" value="PAYMENT" />
<input type="hidden" name="vads_payment_config" value=" 
MULTI_EXT:20140201=1000;20140301=1000;20140401=1000" />
<input type="hidden" name="vads_site_id" value="12345678" />
<input type="hidden" name="vads_trans_date" value="20190629130025" />
<input type="hidden" name="vads_trans_id" value="130025" />
<input type="hidden" name="vads_version" value="V2" />
<input type="hidden" name="signature" value="7Sds6Z+R1Q1axRsblpChyQh5OU3oCle5FOirD4V/Bzk="/>
<input type="submit" name="pay" value="Pay"/>
</form>