• France
status page
Merchant Back Office
assistance
FAQContact support
Search
Categories
Tags
English
French
English
Homepage
Use cases
Create a payment
Create an installment payment
Create a multi-card (split) 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
Logos
Push mail
Snippets
Payment methods
Plugins
Guides
Merchant Back Office
Functional guides

Creating a token during 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 REGISTER_SUBSCRIBE.

vads_identifier_status Token creation status.

Possible values are:

  • CREATED: the request for authorization or information, if supported by the acquirer is accepted.

    Token has been successfully created.

    See the value of the field vads_recurrence_status to determine whether the subscription has been created.

  • NOT_CREATED: the request for authorization or information has been rejected.

    The token has not been created, and therefore cannot be viewed in the Merchant Back Office. The recurring payment is not created.

  • ABANDONED: action abandoned by the buyer.

    The token has not been created, and therefore cannot be viewed in the Merchant Back Office.

    The recurring payment is not created.

vads_recurrence_status Recurrence creation status.

The possible values are:

  • CREATED: The recurring payment has been successfully created.
  • NOT_CREATED: The recurring payment is not created.
  • ABANDONED: The action has been abandoned by the buyer. The recurring payment is not created.
vads_identifier Token ID.
The returned value is:
  • either the value transmitted in the request, regardless of the result of token creation, even in case of abandoned action,
  • or the value generated by the payment gateway, if the field is not transmitted in the request and the token has been successfully created (vads_identifier_status=CREATED).

Note

If you have activated the token uniqueness check and the payment method is already registered with another token, then this token will be returned.

The field vads_identifier will not be returned:
  • if it has not been transmitted in the request and the buyer abandons the action (vads_identifier_status=ABANDONED),
  • if it has not been transmitted in the request and the token has not been created (vads_identifier_status=NOT_CREATED).
vads_identifier_previously_registered Present only if both conditions are true:
  • You have enabled the token uniqueness check.
  • The used payment method is already registered with another token.
vads_initial_issuer_transaction_identifier Unique transaction identifier generated by the issuer.
 The issuer transaction identifier is stored by the payment gateway at the level of the alias. Depending on how you use the alias (1-click payment, 0-click payment, recurring payment, etc.) the issuer transaction ID will be used as a chaining reference if necessary.
vads_cust_email Buyer’s e-mail address transmitted in the request.
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.

To see the recurring payment details, see the parameters below:
Field name Note
vads_subscription Recurring payment token
The returned value is:
  • either the value transmitted in the request, regardless of the result of subscription creation,
  • or the value generated by the payment gateway, if the field has not been transmitted in the request and the subscription has been successfully created (vads_recurrence_status=CREATED).

The field vads_subscription will not be returned:
  • if it has not been transmitted in the request and the buyer abandons the action (vads_recurrence_status=ABANDONED),
  • if it has not been transmitted in the request and the recurring payment not been created (vads_recurrence_status=NOT_CREATED).
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

A “create a token when subscribing to a recurring payment” request triggers the creation of a VERIFICATION type transaction, visible in the Merchant Back Office.

The purpose of this transaction is to help the merchant, via their Back Office, understand the reasons for refusal of token creation.

Here are its characteristics:

Field name Description
vads_operation_type Transaction type

Its value is VERIFICATION.

vads_trans_status Status of the transaction.

Possible values are:

  • ACCEPTED

    The authorization or information request has been accepted.

    The token has been created and is visible in the Merchant Back Office.

  • REFUSED

    The authorization or information request has been rejected.

    The token is not created.

vads_occurrence_type Transaction occurrence type.

Its value is UNITAIRE.

vads_amount
Possible values:
  • 0 if the acquirer supports the inquiries,
  • 100 otherwise.
vads_trans_id Transaction identifier.

Its value is generated by the payment gateway.

vads_trans_uuid Unique transaction ID.

Its value is generated by the payment gateway.

vads_auth_mode

Type of request made via authorization servers.

Its value is MARK.
vads_auth_number Authorization number returned by the authorization server.

Empty if the authorization has failed.

vads_auth_result Return code of the authorization request returned by the issuing bank.

See chapter Managing the return codes of the authorization request.

Empty in case of an error prior to the authorization.

vads_risk_assessment_result

List of actions made with the transaction, following the activation of the advanced risk assessment rules.

The rules related to the amount, or whose action is “Validate manually”, do not apply in case of a VERIFICATION type transaction.

Possible values are:

  • ENABLE_3DS: 3D Secure enabled.
  • DISABLE_3DS: 3D Secure disabled.
  • CHALLENGE_REQUESTED:
    • 3DS1 card: The risk module has requested 3DS authentication.
    • 3DS2 card: The risk module has requested an authentication with cardholder interaction (challenge).
  • CHALLENGE_MANDATE:
    • 3DS1 card: The risk module has requested 3DS authentication.
    • 3DS2 card: The risk module has requested an authentication with cardholder interaction (challenge for regulatory reasons) for regulatory reasons.
  • REFUSE: The token is declined.
  • RUN_RISK_ANALYSIS: Result of the external risk analyzer.

    See the description of the vads_risk_analysis_result field for more information.

  • INFORM: A warning message appears.

    The merchant is notified that a risk has been identified via one or several notification center rules.

Details of the used payment method:
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_brand_management

Allows to know the brand that was used, the list of available brands as well as whether the buyer has changed the default brand chosen by the merchant.

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.
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.

Authentication details of the cardholder:
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:
  • Y: Authentication available.
  • N: Authentication not available.
  • U: Enrollment status to the 3D Secure program unknown.
  • empty: Incomplete 3DS authentication process (3DS disabled in the request, unregistered merchant or payment method not eligible for 3DS).
vads_threeds_status 3D Secure authentication result.
Possible values are:
  • Y: Cardholder authentication success.
  • N: Cardholder authentication error.
  • U: Authentication impossible.
  • A: Authentication attempted but not completed.
  • empty: Unauthorized 3DS authentication (3DS disabled in the request, unregistered cardholder or payment method not eligible for 3DS).

The optional fields transmitted in the request are returned in the response with unmodified values.

© 2024 {'|'} All rights reserved to Systempaylegal
2.91.0-doc-1.11