vads_payment_config

Description

Defines the type of payment: immediate or installment.

  • For a single payment, the value must be set to SINGLE.
  • For an installment payment with fixed amounts and dates, the value must be set to MULTI: followed by key=value pairs separated by the ";" character.

    The parameters are:

    • "first" indicates the amount of the first installment (populated in the smallest unit of the currency).
    • "count" indicates the total number of installments.
    • "period" indicates the number of days between 2 installments.

      The field order associated with MULTI must be respected.

      Note: the MULTI value is not available for SEPA payment.
  • For an installment payment with a customized installment schedule, the value must be set to MULTI_EXT: followed by the date=amount pairs separated by the ";" character.

    The dates must not be passed.

    Note: the MULTI_EXT value is not available for SEPA payment.

Using the MULTI_EXT value requires a subscription to the Advanced installment payment option.

Note: The value of vads_capture_delay is not taken into account in the case of payment in installments MULTI_EXT.

Input and output field, returned in the response (IPN and Return URL).

Format enum
Error code 07
Possible values
  • SINGLE
  • MULTI:first= initial_amount;count=installments_nb ;period=interval_in_days
    Note: the MULTI value is not available for SEPA payment.
  • MULTI_EXT:date1=amount1;date2=amount2;date3=amount3
    Note: the MULTI_EXT value is not available for SEPA payment.
Example 1

MULTI allows to define an installment payment.

The amount of each installment corresponds to the total amount divided by the number of installments.

The amount of the first installment can be different, it can be specified in first parameter.

In case the remaining amount does not equal zero, it will be added up to the amount of the last installment.

Payment request:
  • vads_capture_delay=2
  • vads_currency=978
  • vads_amount=20000
  • vads_payment_config=MULTI:first=10000;count=4;period=30

Result:

A first payment of EUR 100.00 will be captured by the bank in 2 days (vads_capture_delay).

A second payment of EUR 33.33 will be made in 32 days (vads_capture_delay + period).

A third payment of EUR 33.33 will be made in 62 days.

A fourth payment of EUR 33.34 will be made in 92 days.

The total amount is EUR 200.00 (vads_amount= 20000). The remaining amount has been added to the amount of the last installment.

This instruction allows to immediately create 4 payments with the same transaction number but different sequence numbers (vads_sequence_number).

Example 2

MULTI_EXT allows to define a customized installment schedule. You will be able to define the amount of each installment.

MULTI_EXT : payment request :

  • vads_currency=978
  • vads_amount=19050
  • vads_payment_config= MULTI_EXT:20150601 =10000; 20150701 =4525; 20150808 =4525

Result:

The first payment of EUR 100.00 is scheduled for June 1st 2015.

The second payment of EUR 45.25 is scheduled for July 1st 2015.

The last payment of EUR 45.25 is scheduled for August 8th 2015.

Note:

The total amount must be equal to the value of the vads_amount field. The date of the last installment cannot be later than 12 months after the date of submission of the form. If the last installment is scheduled later than the card expiry date, no installment will be registered and the buyer will be notified about this issue.

Category Transaction details.