Creation of a token when a creating a recurring payment with payment

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

Field name Description
vads_page_action Action complete.

The returned value is REGISTER_PAY_SUBSCRIBE.

vads_identifier_status Token creation status.

The 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 vads_recurrence_status field to determine whether the subscription has been created.

  • NOT_CREATED: the authorization or information request has been declined.

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

  • ABANDONED: the action has been abandoned by the buyer (debtor).

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

The 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 taken place.

    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.

    An authorization of 1 EUR (or information request about the CB network if the acquirer supports it) 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.

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 (debtor). The recurring payment is not created.
vads_identifier Payment token.
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).

The vads_identifier field 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_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 vads_subscription field 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 subscription has not been created (vads_recurrence_status=NOT_CREATED).
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 payment details, see the parameters below:

Transaction details:

Field name Description
vads_operation_type Transaction type

Its value is DEBIT.

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 The 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 for 1 EUR (or information request about the CB network if the acquirer supports it).

    Value used also 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 for the total amount of the transaction.

    Value used also 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.

See chapter Managing the return codes of the authorization request.

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

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

  • REFUSE: Transaction 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_card_brand Used payment method.

See chapter Compatible payment methods to see the list of possible values.

vads_card_number Truncated/masked card number.
vads_expiry_month Expiry month of the card used for the payment.
vads_expiry_year Expiry year of the card used for the payment.
vads_card_country Country code of the card in compliance with the ISO 3166 standard.
vads_bank_label Name of the issuing bank of the payment card.
vads_bank_product Product code of the card used for the payment.

Details of strong authentication:

Field name Note
vads_threeds_enrolled

Enrollment status of the buyer to the 3D Secure program.

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

See the Data dictionary to know the parameters returned in the response for the following categories:

Recurring payment details Recurring payment details
Order details Order details
Buyer details Buyer details
Shipping details Shipping details