Cyberplus Paiement : paramètres à fournir à la plateforme Systempay

1. Format et codage des paramètres

- Nom : indique le nom du paramètre, tel qu'ils seront utilisés dans les requêtes HTTP.

- Format : indique le format des données, selon la codification suivante :

 

notation	description
a	Caractères alphabétiques (de 'A' à 'Z' et de 'a' à 'z')
n	Caractères numériques
s	Caractères spéciaux
an	Caractères alphanumériques
ans	Caractères alphanumériques et spéciaux
3	Longueur fixe de 3 caractères
…12	Longueur variable jusqu'à 12 caractères

- Exemple : représente un exemple de codage correct des données.

- Obligatoire : indique si la présence du paramètre est obligatoire. Attention, un paramètre obligatoire peut être vide.

- Signature : indique si ce paramètre est utilisé dans le calcul de la signature.

- Remarques : remarques sur l'utilisation de ce paramètre.

- Code : en cas d'erreur dans l'interfaçage entre le site marchand et la plateforme de paiement, cette dernière indiquera par un code numérique le paramètre fautif.

2. Liste des paramètres

Nom	Format	Exemple	Obligatoire	Signature	Remarques	Code
amount	n..12	1500	oui	oui		09
capture_delay	n..3	3	oui	oui	vide : valeur configurée par défaut, sinon, nombre de jours	06
contrib	ans..255					31
currency	n3	978	oui	oui	norme ISO 4217 978 pour EURO	10
cust_address	an..255					19
cust_country	a2	FR			norme 3166-1	22
cust_email	an.127					15
cust_id	an..63					16
cust_name	an..127					18
cust_phone	an..63					23
cust_title	an..63					17
cust_city	an..63					21
cust_zip	an..63					20
ctx_mode		TEST	oui	oui	TEST ou PRODUCTION	11
language	a2	fr			norme ISO 639-1	12
order_id	an..32				Le tiret est accepté.	13
order_info	an..255					14
order_info2	an..255					14
order_info3	an..255					14
payment_cards	an..127	VISA;MASTERCARD	oui	oui	Valorisation à vide conseillée ";"	08
payment_config			oui	oui	SINGLE ou MULTI (avec des paramètres).	07
payment_src	a..5	MOTO			Vide, BO, MOTO, CC ou OTHER	60
signature	an40	7e4cd3265ce8f47535a52e19c4446d2fe4fc8acb	oui
site_id	n8		oui	oui		02
theme_config	ans..255					32
trans_date	n14	20090323105432	oui	oui		04
trans_id	n6		oui	oui	Compris entre 000000 et 899999	03
validation_mode	n..1		oui	oui	vide : valeur configurée par défaut 0 : validation automatique 1 : validation manuelle	05
version		V1	oui	oui		01
url_success	ans..127					24
url_referral	ans..127					26
url_refused	ans..127					25
url_cancel	ans..127					27
url_error	ans..127					29
url_return	ans..127					28
user_info	ans..255					61
contracts	ans..255					62

 

amount

Paramètre obligatoire. Montant de la transaction exprimé en son unité indivisible (exemple : en cents pour l'Euro).

 

capture_delay

Paramètre obligatoire indiquant le délai en nombre de jours avant remise en banque. Si ce paramètre est vide (il doit néanmoins être transmis), alors la valeur par défaut sera utilisée. Cette dernière est paramétrable dans l'outil de gestion de caisse Cyberplus Paiement par toutes les personnes dûment habilitées.

 

contracts

Paramètre facultatif permettant de spécifier pour chaque réseau, le contrat à utiliser.

Le formalisme du paramètre est le suivant : RESEAU1=contratReseau1;RESEAU2=contratReseau2;RESEAU3=contratReseau3

Les différents réseaux étant : American Express, AMEX

 

contrib

Information complémentaire facultative destinée à indiquer le nom de la contribution utilisée lors du paiement (joomla, oscommerce...).

 

currency

Paramètre obligatoire indiquant la monnaie à utiliser, selon la norme ISO 4217 (code numérique).

http://www.iso.org/iso/support/currency_codes_list-1.htm

Pour l'Euro, la valeur est 978.

 

cust_email

Adresse e-mail du client, nécessaire pour lui envoyer un mail récapitulatif de la transaction. Paramètre optionnel.

 

cust_id

Paramètre facultatif correspondant à un identifiant client pour le marchand.

 

cust_name, cust_title, cust_address, cust_zip, cust_city, cust_phone

Paramètres optionnels concernant le client, et correspondant respectivement à :

• cust_name : nom du client
• cust_title : civilité du client
• cust_address : adresse du client
• cust_zip : code postal du client
• cust_city : vile du client
• cust_phone : numéro de téléphone du client

 

cust_country

Code pays du client à la norme ISO 3166. Paramètre optionnel.

http://www.iso.org/iso/english_country_names_and_code_elements

Pour la France, le code est FR.

 

ctx_mode

Paramètre obligatoire indiquant le mode de sollicitation de la plateforme de paiement :

• TEST : utilisation du mode test, nécessite d'employer le certificat de test pour la signature.
• PRODUCTION : utilisation du mode production, nécessite d'employer le certificat de production pour la signature.

 

language

Paramètre optionnel indiquant la langue de la page de paiement (norme ISO 639-1).

 

Les langues possibles sont les suivantes :

• Allemand : de
• Anglais : en
• Chinois : zh
• Espagnol : es
• Français : fr
• Italien : it
• Japonais : jp

Par défaut, le français est sélectionné.

 

order_id

Ce paramètre est optionnel. Il correspond à un numéro de commande qui pourra être rappelé dans l'e-mail adressé au client. Sa taille maximale est de 12 caractères alphanumériques.

 

order_info, order_info2, order_info3

Ces paramètres optionnels sont des champs libres. Ils peuvent par exemple servir à stocker un résumé de la commande.

 

payment_cards

Ce paramètre obligatoire contient la liste des types de cartes disponibles pour ce site, séparés par des " ;". Si la liste ne contient qu'un type de carte, la page de saisie des données du paiement sera directement présentée. Sinon la page de sélection du moyen de paiement sera présentée. Si ce paramètre est vide alors l'ensemble des moyens de paiement défini dans l'outil de gestion de caisse sera présenté en sélection. Par défaut la valeur VIDE est conseillée.

 

Valeurs possibles de 'payment_cards' : AMEX, CB, MASTERCARD (pour Eurocard / MasterCard), VISA, MAESTRO, E-CARTEBLEUE

 

payment_config

Ce paramètre obligatoire indique le type du paiement :

• SINGLE indique un paiement unitaire.
• MULTI indique un paiement en plusieurs fois. Dans ce cas, le paramètre est constitué de la chaîne "MULTI:", suivi par des paires clés/valeurs séparées par des ";".

Les paramètres de MULTI sont les suivants :

• "first" indique le montant du premier paiement.
• "count" indique le nombre de paiements total.
• "period" indique l'intervalle en nombre de jours entre 2 paiements.

Exemple :

currency=978
amount=10000
payment_config=MULTI:first=5000;count=3;period=30

Dans cette configuration :

• Un premier paiement de 50 euros sera effectué à aujourd'hui + "capture_delay" jours.
• Un deuxième paiement de 25 euros sera effectué à aujourd'hui + "capture_delay" + 30 jours.
• Un troisième et dernier paiement de 25 euros sera effectué à aujourd'hui + "capture_delay" + 60 jours.

Remarque : si la date de validité de la carte ne permet pas de réaliser le dernier paiement, la demande sera refusée par la plateforme.

 

payment_src

Paramètre facultatif définissant la source du paiement :

• Paramètre non défini ou valeur vide, indique un paiement de type eCommerce. Dans ce cas, la garantie de paiement est calculée conformément aux options du commerce concerné.
• BO indique un paiement effectué depuis le "Back Office" (saisie manuelle), dans ce cas il n'y a pas de garantie de paiement.
• MOTO indique un paiement effectué par un opérateur suite à une commande par téléphone ou eMail (Mail Or Telephone Order).
• CC indique un paiement effectué via un centre d'appel (Call Center).
• OTHER indique un paiement effectué par toute autre source que celles précédemment définies.

Des informations complémentaires sur l'origine du paiement peuvent être définies dans le paramètre user_info.

 

NB : L'utilisation de ce paramétrage n'est permise que pour les commerçants ayant souscrit une offre adéquate. Merci de contacter votre chargé de clientèle bancaire pour plus d'informations.

 

signature

Paramètre obligatoire permettant à la plateforme de vérifier la validité de la requête transmise. La signature sera constituée des champs suivants, dans l'ordre suivant :

• version
• site_id
• ctx_mode
• trans_id
• trans_date
• validation_mode
• capture_delay
• payment_config
• payment_cards
• amount
• currency
• Valeur du certificat en fonction du mode

Exemple de signature (avant hachage à l'aide de l'algorithme SHA1) : V1+12345678+TEST+654321+20090501193530+1+3+SINGLE+VISA;MASTERCARD+1524+978+1122334455667788
Cette signature doit bien-sûr être adaptée en fonction de vos paramètres.

 

site_id

Paramètre obligatoire attribué lors de l'inscription à la plateforme de paiement.

Sa valeur est consultable sur l'interface de l'outil de gestion de caisse Cyberplus Paiement dans l'onglet "Paramétrages" / "Boutique" par toutes les personnes habilitées.

 

theme_config

Paramètre facultatif permettant de personnaliser certains paramètres de la page de paiement standard, comme les logos, bandeaux et certains messages. Contacter le support technique (supportvad@lyra-network.com) pour plus d'informations.

 

trans_date

Ce paramètre est obligatoire. Correspond à l'horodatage au format AAAAMMJJHHMMSS.

L'horodatage doit nécessairement correspondre à la date et heure courants, dans le fuseau GMT (ou UTC) au format horaire 24h.

 

trans_id

Ce paramètre est obligatoire. Il est constitué de 6 caractères numériques et doit être unique pour chaque transaction sur un site donné sur la journée. En effet l'identifiant unique de transaction au niveau de la plateforme de paiement est constitué du site_id, de trans_date restreint à la valeur de la journée (partie correspondant à AAAAMMJJ) et de trans_id. Il est à la charge du site marchand de garantir cette unicité sur la journée. Il doit être impérativement compris entre 000000 et 899999. La tranche 900000 et 999999 est interdite.

 

validation_mode

Paramètre obligatoire indiquant si cette transaction devra faire l'objet d'une validation manuelle de la part du commerçant. Si ce paramètre est vide alors la configuration par défaut du site sera prise. Cette dernière est paramétrable dans l'outil de gestion de caisse Cyberplus Paiement par toutes les personnes dûment habilitées.

 

version

Paramètre obligatoire. La version actuelle est V1.

 

url_success

URL facultative où sera redirigé le client en cas de succès du paiement, après appui du bouton " retourner à la boutique ".

 

url_referral

URL facultative où sera redirigé le client en cas de refus d'autorisation avec le code 02 "referral", après appui du bouton " retourner à la boutique ".

 

url_refused

URL facultative où sera redirigé le client en cas de refus pour toute autre cause que le " referral ", après appui du bouton " retourner à la boutique ".

 

url_cancel

URL facultative où sera redirigé le client si celui-ci appuie sur " annuler et retourner à la boutique " avant d'avoir procédé au paiement.

 

url_error

URL facultative où sera redirigé le client en cas d'erreur de traitement interne.

 

url_return

URL facultative où sera redirigé par défaut le client après un appui sur le bouton " retourner à la boutique ", si les URL correspondantes aux cas de figure vus précédemment ne sont pas renseignées.

Si cette URL n'est pas présente dans la requête, alors c'est la configuration dans l'outil de gestion de caisse qui sera prise en compte.

En effet il est possible de configurer des URL de retour, en mode TEST et en mode PRODUCTION. Ces paramètres sont nommés "URL de retour de la boutique" et "URL de retour de la boutique en mode test" respectivement, et sont accessibles dans l'onglet "Configuration" lors du paramétrage d'une boutique.

Si toutefois aucune URL n'est présente, que ce soit dans la requête ou dans le paramétrage de la boutique, alors le bouton "retourner à la boutique" redirigera vers l'URL générique de la boutique (paramètre nommé "URL" dans la configuration de la boutique).

 

user_info

Paramètre facultatif spécifiant des informations complémentaires quant au paiement. Dans le cas d'un paiement via une saisie manuelle, ce paramètre contient l'identifiant de l'utilisateur à l'origine de la transaction. Dans les autres cas de paiement (eMail, téléphone…) tels que définis par le paramètre payment_src, ce paramètre doit servir à identifier l'opérateur à l'origine de la transaction.

Ces informations ont été extraites du guide officiel Systempay Cyberpluspaiement : https://systempay.cyberpluspaiement.com/html/