Création d'un alias avec paiement
Documentation API : Charge/CreatePayment
Requête
- 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".
<div><doc-code-block>
<doc-param name="auth-link">/doc/fr-FR/rest/V4.0/api/kb/authentication.html</doc-param>
<doc-param name="php-link">https://github.com/lyra/rest-php-examples/blob/master/www/minimalEmbeddedForm.php#L9-L44</doc-param>
<doc-param name="url-target">https://api.systempay.fr/api-payment/V4/Charge/CreatePayment</doc-param>
<doc-param name="data-markets"></doc-param>
{ "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).
- 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".
<div><doc-code-block>
/doc/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.systempay.fr/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" }
<p>Dans cet exemple, l'alias (champ <no-translate>paymentMethodToken</no-translate>) a pour valeur : <no-translate>"b6e51ba31f934ac5b25ccad2a52ccd56"</no-translate>.</p>
Pour connaître l'intégralité et la description des champs, consultez le playground : answer/Payment.