Etape 3 : Créer un formToken

Objectif

Générer un formToken.

Le formToken est une clé générée par la plateforme. Il définit le contexte de paiement (montant, devise, numéro de commande, coordonnées de l'acheteur, etc.).

Le formToken est le résultat de la réponse de l'appel Web Service REST Charge/CreatePayment. Il est valide pendant 15 minutes. Cette durée est fixe et non modifiable pour des raisons techniques.

I. Requête pour un paiement simple

Exemple :

montant : 9,90 €.
commande : "myOrderId-999999",
email de l'acheteur : "sample@example.com".

/fr-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",
    "orderId":  "myOrderId-999999",
    "customer": {
        "email": "sample@example.com"
    }
}

{
    "amount":   1500,
    "currency": "PEN",
    "orderId":  "myOrderId-999999",
    "more": "parameters",
    "customer": {
        "email": "sample@example.com"
    }
}

{
    "amount":   20000,
    "currency": "ARS",
    "orderId":  "myOrderId-999999",
    "more": "parameters",
    "customer": {
        "email": "sample@example.com"
    }
}

{
    "amount":   100000,
    "currency": "COP",
    "orderId":  "myOrderId-999999",
    "more": "parameters",
    "customer": {
        "email": "sample@example.com"
    }
}

{
    "amount":   2500,
    "currency": "BRL",
    "orderId":  "myOrderId-999999",
    "more": "parameters",
    "customer": {
        "email": "sample@example.com"
    }
}

II. Réponse pour un paiement simple

{
    "status": "SUCCESS",
    "_type": "V4/WebService/Response",
    "webService": "Charge/CreatePayment",
    "applicationProvider": "PAYZEN",
    "version": "V4",
    "applicationVersion": "4.1.0",
    "answer": {
        "formToken": "DEMO-TOKEN-TO-BE-REPLACED",
        "_type": "V4/Charge/PaymentForm"
    }
}

III. Autres cas d'utilisation

D'autres exemples sont disponibles sur cette page : Cas d'utilisation.

IV. Utilisation du Playground

Utilisez le Playground Charge/CreatePayment pour connaître l'intégralité des champs disponibles.

Cliquez sur le bouton "Testez-moi", créez votre requête puis exécutez l'appel REST pour générer le formToken.

V. Exemple simplifié PHP

Dans le dossier sample, le fichier de cette étape est formToken.php.

Pour plus de détails, Fichier d'exemple : formToken.php

Catégories

Tags