support
Retour à la documentation
Rechercher
Catégories
Tags
Paramètres principauxtout montrer
amount
requis
currency
requis
paymentMethodType
requis
orderId
recommandé
options générales
ipnTargetUrl
validityPeriod
size
description
metadata
[1]
:
options relatives à la méthode de paiement
transactionOptions
paymentMethodOptions
paymentSource
deviceSerialNumber
mid
information sur l'acheteur
customer
reference
recommandé
email
recommandé
billingDetails
title
category
firstName
lastName
phoneNumber
streetNumber
address
address2
district
zipCode
city
state
country
language
cellPhoneNumber
identityCode
identityType
legalName
shippingDetails
category
firstName
lastName
phoneNumber
streetNumber
address
address2
district
zipCode
city
state
country
deliveryCompanyName
shippingSpeed
shippingMethod
legalName
identityCode
shoppingCart
insuranceAmount
shippingAmount
taxAmount
cartItemInfo
[1]
productLabel
productType
productRef
productQty
productAmount
productVat
ipAddress
Testez moi
Documentation

Web Service Charge/CreateQRCode

L'appel aux Web Services requiert une authentification HTTP Basic Authentication. Plus d'infos : "Phase d'authentification".

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

L’opération Charge/CreateQRCode est un Web Service de l’API REST.

Il permet de générer un QR code de paiement.

Consultez le guide d'intégration Payer avec un QR Code.

Paramètres d'entrée

amount

Montant du paiement dans sa plus petite unité monétaire (le centime pour l'euro).

Exemple: 30050 pour 300,50 EUR.

Format

currency

Devise du paiement. Code alphabétique en majuscule selon la norme ISO 4217 alpha-3.

Exemple: "EUR" pour l'euro.

Format

Valeurs possibles

Les valeurs possibles sont les suivantes:

Devise CODIFICATION ISO 4217 Unité fractionnaire
Dollar australien (036) AUD 2
Dollar canadien (124) CAD 2
Franc suisse (756) CHF 2
Couronne danoise (208) DKK 2
Euro (978) EUR 2
Livre Sterling (826) GBP 2
Yen (392) JPY 0
Couronne norvégienne (578) NOK 2
Couronne suédoise (752) SEK 2
Dollar des États-Unis (840) USD 2

orderId

Référence de la commande définie par le marchand. Ne prend pas en charge les caractères UTF-8.

Format

paymentMethodType

Type de moyen de paiement. Exemple: PAYCONIQ

Format

ipnTargetUrl

Vous pouvez surcharger l’URL de notification instantanée (également appelée IPN) dans le formulaire dans le cas où vous utilisez une seule boutique pour différents canaux de ventes, différentes typologies de paiement, différentes langues etc...

Format

validityPeriod

Durée de validité du QR code en secondes.

Format

size

Taille du QR code généré.

Valeurs possibles

Les valeurs possibles sont les suivantes:

STATUS DESCRIPTION
S Small, QR code de petite taille
M Medium, QR code de taille moyenne
L Large, QR code de grande taille

Format

description

Description.

Format

metadata

Valeurs personnalisées rattachées à la transaction, au format json.

Exemple d'appel

Par exemple, pour passer une valeur personnalisée, ajoutez à votre requête :

{
    "metadata": {
        "MyValueKey": "1234"
    }
}

Cette valeur sera retournée dans l'objet transaction nouvellement créé.

Vous pouvez aussi utiliser les metadatas "orderInfo", "orderInfo2" et "orderInfo3" pour transmettre des informations additionnelles sur la commande.

Ces données seront ensuite visibles dans l'onglet Extra du détail de la transaction depuis votre Back Office Expert.

Format

paymentSource

Chemin: transactionOptions.paymentMethodOptions.paymentSource

Origine du paiement.

Format

Valeurs possibles

Les valeurs possibles sont les suivantes:

valeurs Description
EC E-Commerce
INSTORE En magasin
APP Application

deviceSerialNumber

Chemin: transactionOptions.paymentMethodOptions.deviceSerialNumber

Numéro de série du terminal.

Format

mid

Chemin: transactionOptions.paymentMethodOptions.mid

Numéro de contrat commerçant. Si ce champ est renseigné, veillez à utiliser le bon contrat en fonction du réseau de la carte.

Un contrat CB ne peut être utilisé pour une transaction AMEX.

Format

customer.reference

Identifiant de l’acheteur chez le marchand.

Format

customer.email

Adresse e-mail de l'acheteur.

  • Spécifications sur la structure de l'e-mail : RFC-2822

Format

address

Chemin: customer.billingDetails.address

Adresse de facturation.

Attention : Les caractères > et < ne sont pas autorisés.

Format

address2

Chemin: customer.billingDetails.address2

Informations complémentaires sur l'adresse de facturation.

Attention : Les caractères > et < ne sont pas autorisés.

Format

category

Chemin: customer.billingDetails.category

Type de client.

Format

Valeurs possibles

valeurs Description
PRIVATE Client de type Particulier
COMPANY Client de type Société

cellPhoneNumber

Chemin: customer.billingDetails.cellPhoneNumber

Téléphone portable de l'acheteur.

Accepte tous les formats:

Exemples:

  • 0623456789
  • +33623456789
  • 0033623456789
  • (+34) 824 65 43 21
  • 87 77 12 34

En fonction du moyen de paiement, certaines restrictions peuvent modifier le format. Veuillez vous reporter à la documentation technique spécifique au moyen de paiement pour plus de détails.

  • Pour MB WAY:
    Seul, le format international est accepté.
    Par exemple, +351 est l'indicatif international du Portugal. Le numéro portugais 21 031 27 00 devient +351210312700.
    Si le champ ne respecte pas ce format ou est absent, une nouvelle saisie sera proposée à l'acheteur.

Format

city

Chemin: customer.billingDetails.city

Ville de facturation.

Format

country

Chemin: customer.billingDetails.country

Pays de l'acheteur (en majuscule, suivant la norme ISO 3166-1 alpha-2).

Format

Valeurs possibles

Exemples de valeurs possibles :

Pays Code
AUTRICHE AT
BRESIL BR
CORSE FR
COTE D'IVOIRE CI
FRANCE FR
GUADELOUPE GP
INDE IN
MARTINIQUE MQ
NOUVELLE-CALÉDONIE NC
ST-PIERRE-ET-MIQUELON PM
POLYNESIE FRANCAISE PF

district

Chemin: customer.billingDetails.district

Quartier de l'adresse de facturation.

Format

firstName

Chemin: customer.billingDetails.firstName

Prénom de l'acheteur.

Format

identityCode

Chemin: customer.billingDetails.identityCode

Identifiant national. Permet d'identifier de façon unique chaque citoyen au sein d'un pays.

Format

identityType

Chemin: customer.billingDetails.identityType

Type de pièce d'identité.

Format

language

Chemin: customer.billingDetails.language

Code de la langue de l'acheteur, selon la norme norme ISO 639-1.

Permet de spécifier la langue dans laquelle sont envoyés les e-mails de confirmation de paiement.

Format

Valeurs possibles

Exemples de valeurs possibles:

Langue Code
Allemand (Allemagne) DE
Anglais (Royaume Uni) EN
Anglais (Etats-Unis ) EN
Chinois (Traditionnel) ZH
Espagnol (Espagne) ES
Espagnol (Chili) ES
Français (France) FR
Italien (Italie) IT
Japonais (Japon) JP
Néerlandais (Pays-Bas) NL
Polonais (Pologne) PL
Portugais (Brésil) PT
Portugais (Portugal) PT
Russe (Russie) RU

lastName

Chemin: customer.billingDetails.lastName

Nom de l'acheteur.

Format

legalName

Chemin: customer.billingDetails.legalName

Raison sociale.

Format

phoneNumber

Chemin: customer.billingDetails.phoneNumber

Numéro de téléphone de l'acheteur.

Accepte tous les formats:

Exemples:

  • 0123456789
  • +33123456789
  • 0033123456789
  • (00.571) 638.14.00
  • 40 41 42 42

En fonction du moyen de paiement, certaines restrictions peuvent modifier le format. Veuillez vous reporter à la documentation technique spécifique au moyen de paiement pour plus de détails.

Format

state

Chemin: customer.billingDetails.state

Région (état) de l'adresse de facturation. Il est recommandé mais non obligatoire de passer la valeur en ISO-3166-2.

Format

streetNumber

Chemin: customer.billingDetails.streetNumber

Numéro de rue de l'adresse de facturation.

Caractères acceptés:

  • Caractères alphabétiques (de "A" à "Z" et de "a" à "z")
  • Espace

Format

title

Chemin: customer.billingDetails.title

Civilité de l’acheteur.

Exemples:

  • Mr
  • M.
  • Mme

Format

zipCode

Chemin: customer.billingDetails.zipCode

Code postal de l'adresse de facturation.

Format

address

Chemin: customer.shippingDetails.address

Adresse de livraison.

Attention : Les caractères > et < ne sont pas autorisés.

Format

address2

Chemin: customer.shippingDetails.address2

Deuxième ligne d'adresse de livraison.

Attention : Les caractères > et < ne sont pas autorisés.

Format

category

Chemin: customer.shippingDetails.category

Type de client.

Format

Valeurs possibles

valeurs Description
PRIVATE Client de type Particulier
COMPANY Client de type Société

city

Chemin: customer.shippingDetails.city

Ville de livraison.

Format

country

Chemin: customer.shippingDetails.country

Pays de livraison (en majuscule, suivant la norme ISO 3166-1 alpha-2).

Format

Valeurs possibles

Exemples de valeurs possibles:

Pays Code
AUTRICHE AT
BRESIL BR
CORSE FR
COTE D'IVOIRE CI
FRANCE FR
GUADELOUPE GP
INDE IN
MARTINIQUE MQ
NOUVELLE-CALÉDONIE NC
ST-PIERRE-ET-MIQUELON PM
POLYNESIE FRANCAISE PF

deliveryCompanyName

Chemin: customer.shippingDetails.deliveryCompanyName

Nom de la société qui délivre le produit.

Format

district

Chemin: customer.shippingDetails.district

Quartier de l'adresse de facturation.

Format

firstName

Chemin: customer.shippingDetails.firstName

Prénom du destinataire.

Format

identityCode

Chemin: customer.shippingDetails.identityCode

Identifiant national. Permet d'identifier de façon unique chaque citoyen au sein d'un pays.

Format

lastName

Chemin: customer.shippingDetails.lastName

Nom de l'acheteur.

Format

legalName

Chemin: customer.shippingDetails.legalName

Raison sociale en cas de livraison en entreprise.

Format

phoneNumber

Chemin: customer.shippingDetails.phoneNumber

Numéro de téléphone de l'acheteur.

Accepte tous les formats:

Exemples:

  • 0123456789
  • +33123456789
  • 0033123456789
  • (00.571) 638.14.00
  • 40 41 42 42

Format

shippingMethod

Chemin: customer.shippingDetails.shippingMethod

Mode de livraison.

Format

Valeurs possibles

Valeur Description
RECLAIM_IN_SHOP Retrait de marchandise en magasin.
RELAY_POINT Utilisation d'un réseau de points de retrait tiers (Kiala, Alveol, etc).
RECLAIM_IN_STATION Retrait dans un aéroport, une gare ou une agence de voyage.
PACKAGE_DELIVERY_COMPANY Livraison par transporteur (Colissimo, UPS, etc).
ETICKET Emission d'un billet électronique, téléchargement de produit virtuel.
CARD_HOLDER_ADDRESS Livraison chez l'acheteur. Réservé à un usage futur.
VERIFIED_ADDRESS Livraison à une adresse vérifiée. Réservé à un usage futur.
NOT_VERIFIED_ADDRESS Livraison à une adresse non vérifiée. Réservé à un usage futur.
SHIP_TO_STORE Livraison en magasin. Réservé à un usage futur.
DIGITAL_GOOD Livraison digitale. Réservé à un usage futur.
ETRAVEL_OR_ETICKET Billet électronique. Réservé à un usage futur.
OTHER Autre: Réservé à un usage futur.
PICKUP_POINT Retrait en point relais. Réservé à un usage futur.
AUTOMATED_PICKUP_POINT Retrait en point relais automatique. Réservé à un usage futur.

shippingSpeed

Chemin: customer.shippingDetails.shippingSpeed

Délai de livraison.

Format

Valeurs possibles

Exemples de valeurs possibles:

Valeur Description
STANDARD Livraison standard
EXPRESS Livraison en moins de 24h
PRIORITY Livraison Prioritaire (Click & Collect)

state

Chemin: customer.shippingDetails.state

Région de l'adresse de facturation.

Format

streetNumber

Chemin: customer.shippingDetails.streetNumber

Numéro de rue de l'adresse de livraison.

Caractères acceptés:

  • Caractères alphabétiques (de "A" à "Z" et de "a" à "z")
  • Espace

Format

zipCode

Chemin: customer.shippingDetails.zipCode

Code postal de l'adresse de facturation.

Format

insuranceAmount

Chemin: customer.shoppingCart.insuranceAmount

Montant de l’assurance pour l’ensemble de la commande exprimé dans sa plus petite unité monétaire (le centime pour l'euro).

Exemple: 30050 pour 300,50 EUR.

Format

shippingAmount

Chemin: customer.shoppingCart.shippingAmount

Montant des frais de livraison pour l’ensemble de la commande exprimé dans sa plus petite unité monétaire (le centime pour l'euro).

Exemple: 30050 pour 300,50 EUR.

Format

taxAmount

Chemin: customer.shoppingCart.taxAmount

Montant des taxes pour l’ensemble de la commande exprimé dans sa plus petite unité monétaire (le centime pour l'euro).

Exemple: 30050 pour 300,50 EUR.

Format

cartItemInfo

Chemin: customer.shoppingCart.cartItemInfo

cardItemInfo est une liste qui contient des objets Customer/ShoppingCartItemInfo.

Il permet de décrire chaque article du panier.

Format

productAmount

Chemin: customer.shoppingCart.cartItemInfo.productAmount

Montant du produit exprimé dans sa plus petite unité monétaire (le centime pour l'euro).

Exemple: 30050 pour 300,50 EUR.

Format

productLabel

Chemin: customer.shoppingCart.cartItemInfo.productLabel

Nom du produit.

Format

productQty

Chemin: customer.shoppingCart.cartItemInfo.productQty

Quantité de produit.

Format

productRef

Chemin: customer.shoppingCart.cartItemInfo.productRef

Référence produit.

Format

productType

Chemin: customer.shoppingCart.cartItemInfo.productType

Type du produit.

Valeurs possibles

Valeur Description
FOOD_AND_GROCERY Produits alimentaires et d'épicerie
AUTOMOTIVE Automobile / Moto
ENTERTAINMENT Divertissement / Culture
HOME_AND_GARDEN Maison et jardin
HOME_APPLIANCE Equipement de la maison
AUCTION_AND_GROUP_BUYING Ventes aux enchères et achats groupés
FLOWERS_AND_GIFTS Fleurs et cadeaux
COMPUTER_AND_SOFTWARE Ordinateurs et logiciels
HEALTH_AND_BEAUTY Santé et beauté
SERVICE_FOR_INDIVIDUAL Services à la personne
SERVICE_FOR_BUSINESS Services aux entreprises
SPORTS Sports
CLOTHING_AND_ACCESSORIES Vêtements et accessoires
TRAVEL Voyage
HOME_AUDIO_PHOTO_VIDEO Son, image et vidéo
TELEPHONY Téléphonie

Format

productVat

Chemin: customer.shoppingCart.cartItemInfo.productVat

Type du produit.

Montant de la taxe sur le produit (dans la plus petite unité de la devise).

Valeurs possibles

Valeur Description
Un nombre entier Montant de la transaction. Sa valeur doit être un entier positif (ex: 1234 pour 12,34 EUR).
Un nombre décimal, inférieur à 100 Pourcentage appliqué sur le montant. Exemples : 20.0 ou 19.6532

Pour exprimer un pourcentage appliqué sur le montant du produit concerné, la valeur doit avoir au maximum 4 chiffres après la virgule. La décimale est obligatoire pour exprimer un pourcentage. La décimale est marquée par le caractère ".".

Format

Référence de la réponse

Réponse Contexte
QRCodeTransaction Objet contenant le QR code du paiement.

Voir la référence de chaque réponse pour plus de détails.