• France
Merchant Back Office
assistance
FAQContact support
Search
Categories
Tags
English
French
English
Homepage
Use cases
Create a payment
Create an installment payment
Create a payment by Alias (Token)
Create a payment link
Create a recurring payment
Manage subscriptions
Manage your transactions (refund, cancel...)
Analyze your reports
API docs
Embedded Form
REST API
Hosted payment
Mobile payment
File exchange
Snippets
Payment methods
Plugins
Guides
Merchant Back Office
Functional guides

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 schedule is then presented to the buyer on the payment pages.

The first installment works the same way as an immediate payment. The result is notified to the merchant website due to the Instant Payment Notification URL at the end of the payment rule.

The following installments are similar to deferred payments. The result is sent to the merchant website via the Instant Payment Notification URL on batch authorization rule.

Clarifications:

The fieldvads_amountcontains the total amount of the order. This is the amount that will be split according to the value of the fieldvads_payment_config.

On the day of the payment, the total amount is not credited to the merchant’s account and the liability shift 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.

The validation mode and the capture delay apply to all the installments.

  1. Use all the fields below to build your payment form.
    Field name Description Format Value
    vads_payment_cards Allows to force the card type to be used.

    It is recommended to provide a different payment button for each payment method on the merchant website.

    enum
    • PRV_BDP to call the HOA PRIVATIVE card payment button.
    • PRV_BDT to call the Tiare card payment button.
    • PRV_OPT to call the MARARA payment button.
    • PRV_SOC to call the Banque SOCREDO payment button.
    • PRV_SMART_CARD to call the BRED Smart Card payment button.
    vads_site_id Shop ID n8 E.g.: 12345678
    vads_ctx_mode Mode of interaction with the payment gateway enum TESTorPRODUCTION
    vads_trans_id Transaction number.

    Must be unique within the same day (from 00:00:00 UTC to 23:59:59 UTC).

    Warning: this field is not case sensitive.

    an6 E.g.: xrT15p
    vads_trans_date Date and time of the payment form in UTC format n14

    Respect the YYYYMMDDHHMMSS format

    E.g.: 20200101130025
    vads_amount Payment amount in the smallest currency unit n..12 E.g.: 4525 for 4525 XPF
    vads_currency Numeric currency code to be used for the payment, in compliance with the ISO 4217 standard (numeric code). n3 E.g.: 953 for CFP Franc (XPF)
    vads_action_mode Acquisition mode for payment method data 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
    vads_validation_mode Specifies the validation mode of the transaction (manually by the merchant, or automatically by the payment gateway). n1 0or 1 or absent or empty
  2. Set the value of the fieldvads_payment_configrespecting the following syntax:
    • Fixed installment 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 thevads_amountfield.
      The dates are presented in the YYYYMMDD format.
  3. Add optional fields according to your requirements (see chapter Using additional features.
  4. Compute the value of thesignaturefield using all the fields of your form beginning withvads_(see chapter Computing the signature).
© 2025 {'|'} All rights reserved to PayZen by OSB
25.22-1.11