• France
status page
Demo shops
assistance
FAQContact support
Search
Categories
Tags
docs.
France
Spain
Europe (English)
India
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
SDD mandates by REST API
Snippets
Payment methods
Plugins
Marketplace
Guides
Merchant Back Office
Back Office Expert
Functional guides

Creating a token upon the creation of a subscription with payment

In order to understand the result, analyze the following fields:

Field name Description
vads_page_action Completed action.

The returned value is REGISTER_PAY_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 Expert 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 Expert Back Office.

    The recurring payment is not created.

vads_trans_status Status of the transaction.

Possible values are:

  • AUTHORISED

    The authorization or information request has been accepted.

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

  • AUTHORISED_TO_VALIDATE

    The authorization or information request has been accepted.

    The merchant must manually validate the transaction.

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

  • CAPTURED

    The authorization or information request has been accepted.

    The transaction is visible in the “Captured transactions” tab of the Back Office.

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

  • WAITING_AUTHORISATION

    The capture delay in the bank exceeds the authorization validity period. The authorization request for the total amount has not yet been sent.

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

  • WAITING_AUTHORISATION_TO_VALIDATE

    To be validated and authorized

    The capture delay in the bank exceeds the authorization validity period.

    A EUR 1 (or information request about the CB network if the acquirer supports it) authorization has been accepted.

    The merchant must manually validate the transaction in order to trigger the authorization request and capture.

  • REFUSED

    The authorization or information request has been rejected.

    The token is not created.

  • ABANDONED

    Operation abandoned by the buyer.

    The transaction is then not visible via the Expert Back Office.

    The token is not created.

vads_recurrence_status Recurrence creation status.

Possible values are:

  • CREATED: The recurring payment has been successfully created.
  • NOT_CREATED: The recurring payment is not created.
  • ABANDONED: action 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 and the transaction. 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

To view the payment details, see the parameters below:

Transaction details:

Field name Description
vads_operation_type Transaction type

Its value is DEBIT.

vads_occurrence_type Transaction occurrence type.

Its value is UNITAIRE.

vads_amount Transaction amount.

The returned value is the same as the one submitted in the form.

vads_currency Code of the currency used for the payment.
vads_trans_id Transaction identifier.

The returned value is the same as the one submitted in the form.

vads_trans_uuid Unique transaction ID.

Its value is generated by the payment gateway.

vads_contract_used MID associated with the transaction.
vads_auth_mode Type of request made via authorization servers:
  • MARK: corresponds to an authorization of EUR 1 (or information request about the CB network if the acquirer supports it).

    Value also used if the period between the requested capture date and the current date is strictly greater than the authorization validity period.

  • FULL: corresponds to an authorization of the total transaction amount.

    Value also used if the period between the requested capture date and the current date is strictly shorter than the authorization validity period.

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.

Empty in case of an error prior to the authorization.

vads_risk_control Result of the risk assessment.

If at least one verification process returns the ERROR value, the transaction is rejected.

See the description of the vads_risk_analysis_result field for more information.

vads_risk_assessment_result

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

The 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.
  • MANUAL_VALIDATION: The transaction has been created via manual validation.

    The payment capture is temporarily blocked to allow the merchant to perform all the desired verification processes.

  • REFUSE: The transaction is refused.
  • 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_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.

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.

Jobs
Legal
GDPR
2.91.0-doc-1.11