• France
status page
Demo shops
assistance
FAQContact support
Search
Categories
Tags
Europe (English)
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

Using the embedded form

  • Affected use cases
  • Payment process
  • Initialization of the payment session
  • Response analysis

Affected use cases

This chapter applies to the following use cases:
  • Immediate payment with card detail entry
  • Payment by token
  • Suggestion to register the card upon payment
  • Card registration upon payment
  • Card registration in buyer’s wallet (with or without payment)

Payment process

Initialization of the payment session

This use case requires the creation of aformTokenvia a call to theCharge/CreatePaymentWeb Service.

POSThttps://api.lyra.com/api-payment/V4/Charge/CreatePayment

No specific fields are necessary in order to benefit from the 3D Secure protection.

Use the fields below to build your request:

NAME DESCRIPTION REQUIRED
amount Amount for which authentication is requested. Yes
currency Alphanumeric code of the currency. Yes
orderId Order reference.

This field is recommended.

No
formAction Type of desired behavior when a transaction is being created. No
customer Object containing buyer’s data. No

 In order to obtain a more detailed description of the fields to use, test theCharge/CreatePaymentWeb Service via our playground.

Depending on the use case (i.e. the value of the fieldformAction), strong authentication may be required. In this case, thestrongAuthenticationfield is ignored.

Use case formAction Strong authentication required?
Single payment PAYMENT

The authentication type depends on the issuer’s decision.

For payments in euro, the merchant can request an exemption from strong authentication if the amount is less than €30 and if the shop has the “Frictionless 3DS2” option.

For payments made in another currency, the merchant can request authentication without interaction with the cardholder if the shop has the “Frictionless 3DS2” option.

Payment by token PAYMENT Strong authentication and CVV entry required.
Card registration upon payment REGISTER_PAY Strong authentication required.
Suggestion to register the card upon payment ASK_REGISTER_PAY Strong authentication required only if the buyer accepts to register their payment method.

Otherwise, the behavior is identical to thePAYMENTvalue.

Payment using the buyer’s wallet CUSTOMERWALLET Strong authentication required only if the buyer accepts to register their payment method or if they are using an already registered card.

In all other cases, the behavior is identical to thePAYMENTvalue.

It is possible to transmit specific fields to:
  • Request an exemption from strong authentication
  • Facilitate authentication without cardholder interaction
  • Disable 3D Secure 1 authentication

Response analysis

At the end of the operation, the gateway returns an objectPaymentto the notification URL of the merchant site and to the JavaScript client.

Here is a list of attributes describing the cardholder authentication result according to the use case:

Use case Returned fields
Transaction with successful strong authentication
  • authenticationResponse.value.status=SUCCESS : Successful authentication.
  • authenticationResponse.value.authenticationType=CHALLENGE(Value returned in 3DS1 and 3DS2).
  • authenticationResponse.value.commerceIndicator=5(Visa or AMEX) or02(MasterCard).
  • authenticationResponse.value.extension.authenticationType=THREEDS_V1orTHREEDS_V2.
  • transactionDetails.liabilityShift=YES : The payment is guaranteed.
  • transactions.effectiveStrongAuthentication=ENABLED : The cardholder has successfully authenticated.
Transaction with frictionless authentication successfully completed, the merchant has the “Frictionless 3DS2” option and has requested authentication without cardholder interaction.
  • authenticationResponse.value.status=SUCCESS : Successful authentication.

  • authenticationResponse.value.authenticationType=FRICTIONLESS.

  • authenticationResponse.value.commerceIndicator=5(Visa or AMEX) or 02 (MasterCard).
  • authenticationResponse.value.extension.authenticationType=THREEDS_V2.
  • transactionDetails.liabilityShift=NO : The payment is not guaranteed.

  • transactions.effectiveStrongAuthentication=ENABLED : The cardholder has successfully authenticated.

Transaction with frictionless authentication successfully completed, the merchant has not requested authentication without cardholder interaction.
  • authenticationResponse.value.status=SUCCESS : Successful authentication.

  • authenticationResponse.value.authenticationType=FRICTIONLESS.

  • authenticationResponse.value.commerceIndicator=5(Visa or AMEX) or 02 (MasterCard).
  • authenticationResponse.value.extension.authenticationType=THREEDS_V2.
  • transactionDetails.liabilityShift=YES : The payment is guaranteed.

  • transactions.effectiveStrongAuthentication=ENABLED : The cardholder has successfully authenticated.
Transaction with failed 3D Secure authentication
  • authenticationResponse.value.status=FAILED : Authentication error.

  • authenticationResponse.value.authenticationType=CHALLENGE.

  • authenticationResponse.value.commerceIndicator= null
  • authenticationResponse.value.extension.authenticationType=THREEDS_V1orTHREEDS_V2.
  • authenticationResponse.value.reason.code=CARD_AUTHENTICATION_FAILED : Refusal of the authentication by the issuer.
  • transactionDetails.liabilityShift= null: The payment is not guaranteed.

  • transactions.effectiveStrongAuthentication=DISABLED : Cardholder authentication failed.

Card not enrolled.
  • authenticationResponse.value.status=NOT_ENROLLED : Cardholder not enrolled.

  • authenticationResponse.value.authenticationType= null

  • authenticationResponse.value.commerceIndicator= null
  • authenticationResponse.value.extension.authenticationType=THREEDS_V1.
  • transactionDetails.liabilityShift=NO : The payment is not guaranteed.

  • transactions.effectiveStrongAuthentication=DISABLED : Cardholder authentication failed.

  • Card registration without payment
  • Merchant preference
  • Fields allowing to improve the chances of frictionless
Jobs
Legal
GDPR
25.19-1.11