Subscribing to a recurring payment

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

Field name Description
vads_page_action Action complete.

The returned value is SUBSCRIBE.

vads_recurrence_status Subscription creation status.

The possible values are:

  • CREATED: The subscription has been successfully created.
  • NOT_CREATED: The subscription has not been created.
  • ABANDONED: action abandoned by the buyer. The subscription has not been created.
vads_identifier The token identifier to debit.

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

vads_subscription Subscription identifier.
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 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.

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 creating the token.
vads_expiry_year Expiry year of the card used for creating the token.
vads_card_country Country code of the card used for creating the token in compliance with the ISO 3166 standard.
vads_bank_label Name of the issuing bank of the card used for creating the token.
vads_bank_product Product code of the card used for creating the token.

Details of strong authentication performed when creating the token:

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:

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