Creating a recurring payment
In order to understand the result, analyze the following fields:
Field name | Description |
---|---|
vads_page_action | Completed action. The returned value is SUBSCRIBE. |
vads_recurrence_status | Recurrence creation status. The possible values are:
|
vads_identifier | Token ID to be debited. The returned value is the same as the one submitted in the form. |
vads_cust_email | E-mail address of the buyer associated with the token. |
vads_site_id | Shop ID The returned value is the same as the one submitted in the form. |
vads_ctx_mode | Operating mode. The returned value (TEST or PRODUCTION) is the same as the one submitted in the form. |
Field name | Note |
---|---|
vads_subscription | Recurring payment token The returned value is:
The field vads_subscription will not be returned:
|
vads_sub_amount | Amount of installments (in the smallest currency unit) |
vads_sub_currency | Code of the currency used for the recurring payment. E.g.: 978 for euro (EUR) |
vads_sub_desc | Rule for recurring payments to apply according to the iCalendar RFC5545 specification. E.g.: RRULE:FREQ=MONTHLY |
vads_sub_effect_date | Subscription start date (or effective date) in the UTC time zone, in YYYYMMDD format. E.g.: 20210601 |
vads_sub_init_amount | Amount of the first installments. The number of the first installments is defined by vads_sub_init_amount_number. E.g.: 1000 |
vads_sub_init_amount_number | Number of installments to which the amount, defined by vads_sub_init_amount, will be applied. E.g.: 3 |
Field name | Note |
---|---|
vads_acquirer_network | Acquirer network code. |
vads_bank_code | Code of the issuing bank. |
vads_bank_label | Name of the issuing bank of the payment card. |
vads_bank_product | Product code of the used card. |
vads_card_brand | Used payment method. See chapter Compatible payment methods to see the list of possible values. |
vads_card_country | Country code of the card used in compliance with the ISO 3166 standard. |
vads_card_number | Truncated/masked card number or IBAN and BIC used for the payment separated by “_” in case of a one-off debit payment. Since the BIC is optional, it may be left out. . |
vads_expiry_month | Expiry month of the used card. It is advisable to use this data to check the expiration date of the token. |
vads_expiry_year | Expiry year of the used card. It is advisable to use this data to check the expiration date of the token. |
Details of strong authentication performed when creating the token:
Field name | Note |
---|---|
vads_threeds_auth_type | Cardholder authentication type. Strong cardholder authentication is mandatory when registering a card. The field will therefore always be populated with CHALLENGE. |
vads_threeds_enrolled | Enrollment status of the buyer to the 3D Secure program. Possible values are:
|
vads_threeds_status | 3D Secure authentication result. Possible values are:
|
The optional fields transmitted in the request are returned in the response with unmodified values.