• France
état des services
démonstrations
assistance
FAQContacter le support
Video tutorials
Rechercher
Catégories
Tags
France
France
Espagne
Europe (Anglais)
Inde
Accueil
Cas d'usage
Créer un paiement
Créer un paiement en plusieurs fois
Proposer un paiement complémentaire
Créer un paiement par alias (token)
Créer un lien de paiement
Créer un abonnement
Gérer vos abonnements
Gérer vos transactions (rembourser,...)
Analyser vos journaux
Docs API
Formulaire embarqué
API REST
Formulaire en redirection
SDK Mobile
Échange de fichiers
Mandats SEPA par API REST
Exemples de code
Moyens de paiement
Modules de paiement
Marketplace
Guides
Back Office Marchand
Back Office Expert
Guides fonctionnels

Création d'un alias avec paiement

Documentation API : Charge/CreatePayment

Seules les cartes de paiement sont supportées. Cette méthode ne permet pas de créer un alias à partir d' un IBAN.

Requête

  1. Création automatique d'un alias.
Exemple de requête

Champs obligatoires :

  • montant : 9,90 €.
  • e-mail de l'acheteur : "sample@example.com".
  • formAction : REGISTER_PAY.

Champs recommandés :

  • Référence de la commande : "myOrderId-1234".
  • Référence de l'acheteur : "myCustomerRef-123456".
/fr/rest/V4.0/api/kb/authentication.html
https://github.com/lyra/rest-php-examples/blob/master/www/minimalEmbeddedForm.php#L9-L44
https://api.lyra.com/api-payment/V4/Charge/CreatePayment
      {
        "amount": 990,
        "currency": "EUR",
        "customer": {
          "email": "sample@example.com",
          "reference": "myCustomerRef-123456"
        },
        "orderId": "myOrderId-1234"
      }

Pour connaître l'intégralité et la description des champs, consultez le playground : Charge/CreatePayment (menu à gauche).

  1. Proposition à l'acheteur de créer un alias
Exemple de requête

Champs obligatoires :

  • montant : 9,90 €.
  • e-mail de l'acheteur : "sample@example.com".
  • formAction : ASK_REGISTER_PAY.

Champs recommandés :

  • Référence de la commande : "myOrderId-1234".
  • Référence de l'acheteur : "myCustomerRef-123456".
/fr/rest/V4.0/api/kb/authentication.html
https://github.com/lyra/rest-php-examples/blob/master/www/minimalEmbeddedForm.php#L9-L44
https://api.lyra.com/api-payment/V4/Charge/CreatePayment
    {
      "amount": 990,
      "currency": "EUR",
      "customer": {
        "email": "sample@example.com",
        "reference": "myCustomerRef-123456"
      },
      "formAction": "ASK_REGISTER_PAY",
      "orderId": "myOrderId-1234"
    }

Pour connaître l'intégralité et la description des champs, consultez le playground : Charge/CreatePayment (menu à gauche).

Réponse

Récupérez le formToken pour afficher le formulaire de paiement (Plus d'infos : Afficher le formulaire).

À la fin du paiement, une transaction de type DEBIT sera créée.

L'alias sera retourné dans transactions[0].paymentMethodToken

(Plus d'infos : Analyser le résultat du paiement)

Exemple de réponse
  {
    "shopId": "123456",
    "orderCycle": "CLOSED",
    "orderStatus": "PAID",
    "serverDate": "2023-10-20T13:53:41+00:00",
    (...)
      "_type": "V4/OrderDetails"
    },
(...)
    "transactions": [
      {
        "shopId": "123456",
        "uuid": "b72e91826ce14bfd802249d16eb30849",
        "amount": 990,
        "currency": "EUR",
        "paymentMethodType": "CARD",
        "paymentMethodToken": "b6e51ba31f934ac5b25ccad2a52ccd56",
        "status": "PAID",
        "detailedStatus": "AUTHORISED",
        "operationType": "DEBIT",
        "effectiveStrongAuthentication": "DISABLED",
       (...)
    "_type": "V4/Payment"
  }

Dans cet exemple, l'alias (champ paymentMethodToken) a pour valeur : "b6e51ba31f934ac5b25ccad2a52ccd56".

Pour connaître l'intégralité et la description des champs, consultez le playground : answer/Payment.

Nous recrutons
Mentions légales
Charte de Protection des Données Personnelles
25.19-1.11